Infinity.SessionProxy¶

Implementations:: None

Methods¶

join_user (params, func, *user_data)

Virtual Methods¶

do_join_user (params, func, *user_data)

Properties¶

Name	Type	Flags	Short Description
`session`	`Infinity.Session`	r/w/co	The underlying session object

Signals¶

None

Fields¶

None

Class Details¶

class Infinity.SessionProxy¶

Bases:: GObject.GInterface
Structure:: Infinity.SessionProxyInterface

Infinity.SessionProxy is an opaque data type. You should only access it via the public API functions.

join_user(params, func, *user_data)¶

Parameters:

params ([GObject.Parameter]) – Construction properties for the Infinity.User (or derived) object.
func (Infinity.RequestFunc) – Function to be called on completion of the user join, or None.
user_data (object or None) – Additional data to be passed to func.

Returns:

A Infinity.Request object that may be used to get notified when the request finishes, or None.

Return type:

Infinity.Request

Requests a user join for a user with the given properties (which must not include Infinity.User :id or Infinity.User :flags since these are chosen by the session proxy). The Infinity.User :status property is optional and defaults to Infinity.UserStatus.ACTIVE if not given. It must not be Infinity.UserStatus.UNAVAILABLE.

The request might either finish during the call to this function, in which case func will be called and None being returned. If the request does not finish within the function call, a Infinity.Request object is returned, where func has been installed for the Infinity.Request ::finished signal, so that it is called as soon as the request finishes.

do_join_user(params, func, *user_data) virtual¶