TelepathyGLib.Account¶

Subclasses:: None

Methods¶

Inherited:: TelepathyGLib.Proxy (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_feature_quark_addressing` ()
class	`get_feature_quark_connection` ()
class	`get_feature_quark_core` ()
class	`get_feature_quark_storage` ()
class	`init_known_interfaces` ()
class	`new` (bus_daemon, object_path)
class	`parse_object_path` (object_path)
	`associated_with_uri_scheme` (scheme)
	`bind_connection_status_to_property` (target, target_property, invert)
	`dup_detailed_error_vardict` ()
	`dup_parameters_vardict` ()
	`dup_storage_identifier_variant` ()
	`dup_storage_specific_information_vardict_async` (callback, *user_data)
	`dup_storage_specific_information_vardict_finish` (result)
	`ensure_connection` (path)
	`get_automatic_presence` ()
	`get_avatar_async` (callback, *user_data)
	`get_avatar_finish` (result)
	`get_changing_presence` ()
	`get_cm_name` ()
	`get_connect_automatically` ()
	`get_connection` ()
	`get_connection_manager` ()
	`get_connection_status` ()
	`get_current_presence` ()
	`get_display_name` ()
	`get_has_been_online` ()
	`get_icon_name` ()
	`get_nickname` ()
	`get_normalized_name` ()
	`get_parameters` ()
	`get_path_suffix` ()
	`get_protocol` ()
	`get_protocol_name` ()
	`get_requested_presence` ()
	`get_service` ()
	`get_storage_identifier` ()
	`get_storage_provider` ()
	`get_storage_restrictions` ()
	`get_storage_specific_information_async` (callback, *user_data)
	`get_storage_specific_information_finish` (result)
	`get_supersedes` ()
	`get_uri_schemes` ()
	`is_enabled` ()
	`is_valid` ()
	`reconnect_async` (callback, *user_data)
	`reconnect_finish` (result)
	`remove_async` (callback, *user_data)
	`remove_finish` (result)
	`request_presence_async` (type, status, message, callback, *user_data)
	`request_presence_finish` (result)
	`set_automatic_presence_async` (type, status, message, callback, *user_data)
	`set_automatic_presence_finish` (result)
	`set_avatar_async` (avatar, mime_type, callback, *user_data)
	`set_avatar_finish` (result)
	`set_connect_automatically_async` (connect_automatically, callback, *user_data)
	`set_connect_automatically_finish` (result)
	`set_display_name_async` (display_name, callback, *user_data)
	`set_display_name_finish` (result)
	`set_enabled_async` (enabled, callback, *user_data)
	`set_enabled_finish` (result)
	`set_icon_name_async` (icon_name, callback, *user_data)
	`set_icon_name_finish` (result)
	`set_nickname_async` (nickname, callback, *user_data)
	`set_nickname_finish` (result)
	`set_service_async` (service, callback, *user_data)
	`set_service_finish` (result)
	`set_uri_scheme_association_async` (scheme, associate, callback, *user_data)
	`set_uri_scheme_association_finish` (result)
	`update_parameters_async` (parameters, unset_parameters, callback, *user_data)
	`update_parameters_finish` (result)
	`update_parameters_vardict_async` (parameters, unset_parameters, callback, *user_data)
	`update_parameters_vardict_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: TelepathyGLib.Proxy (5)

Name	Type	Flags	Short Description
`automatic-presence-type`	`int`	r	Presence type used to put the account online automatically
`automatic-status`	`str`	r	Presence status used to put the account online automatically
`automatic-status-message`	`str`	r	User-defined message used to put the account online automatically
`changing-presence`	`bool`	r	`True` if presence is changing
`cm-name`	`str`	r	The account’s connection manager name
`connect-automatically`	`bool`	r	Whether this account should connect automatically or not
`connection`	`TelepathyGLib.Connection`	r	The account’s connection
`connection-error`	`str`	r	The account’s last connection error
`connection-error-details`	`GLib.HashTable`	r	Extensible details of the account’s last connection error
`connection-manager`	`str`	r	The account’s connection manager name `deprecated`
`connection-status`	`int`	r	The account’s connection status type
`connection-status-reason`	`int`	r	The account’s connection status reason
`current-presence-type`	`int`	r	The account connection’s current presence type
`current-status`	`str`	r	The Status string of the account
`current-status-message`	`str`	r	The Status message string of the account
`display-name`	`str`	r	The account’s display name
`enabled`	`bool`	r	Whether this account is enabled or not
`has-been-online`	`bool`	r	Whether this account has been online or not
`icon-name`	`str`	r	The account’s icon name
`nickname`	`str`	r	The account’s nickname
`normalized-name`	`str`	r	The normalized identifier of the user
`protocol`	`str`	r	The account’s protocol name `deprecated`
`protocol-name`	`str`	r	The account’s protocol name
`requested-presence-type`	`int`	r	The account’s requested presence type
`requested-status`	`str`	r	The account’s requested status string
`requested-status-message`	`str`	r	The requested Status message string of the account
`service`	`str`	r	The account’s service name
`storage-identifier`	`GObject.Value`	r	The storage identifier for this account
`storage-identifier-variant`	`GLib.Variant`	r	The storage identifier for this account
`storage-provider`	`str`	r	The storage provider for this account
`storage-restrictions`	`int`	r	The storage restrictions for this account
`supersedes`	[`str`]	r	Accounts superseded by this one
`uri-schemes`	[`str`]	r	URISchemes
`valid`	`bool`	r	Whether this account is valid

Signals¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Short Description
`avatar-changed`	Emitted when the avatar changes.
`presence-changed`	Emitted when the presence of the account changes.
`status-changed`	Emitted when the connection status on the account changes.

Fields¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Type	Access	Description
parent	`TelepathyGLib.Proxy`	r

Class Details¶

class TelepathyGLib.Account(**kwargs)¶

Bases:: TelepathyGLib.Proxy
Abstract:: No
Structure:: TelepathyGLib.AccountClass

The Telepathy Account Manager stores the user’s configured real-time communication accounts. This object represents a stored account.

If this account is deleted from the account manager, the TelepathyGLib.Proxy ::invalidated signal will be emitted with the domain %TP_DBUS_ERRORS and the error code TelepathyGLib.DBusError.OBJECT_REMOVED.

One can connect to the GObject.Object ::notify signal to get change notifications for many of the properties on this object. Refer to each property’s documentation for whether it can be used in this way.

TelepathyGLib.Account objects should normally be obtained from the TelepathyGLib.AccountManager.

Since 0.16, TelepathyGLib.Account always has a non-None TelepathyGLib.Proxy :factory, and its TelepathyGLib.Proxy :factory will be propagated to its TelepathyGLib.Connection (if any). If a TelepathyGLib.Account is created without going via the TelepathyGLib.AccountManager or specifying a TelepathyGLib.Proxy :factory, the default is to use a new TelepathyGLib.AutomaticClientFactory.

New in version 0.7.32.

classmethod get_feature_quark_addressing()¶

Return type:: int

classmethod get_feature_quark_connection()¶

Returns:: the quark used for representing the connection feature of a TelepathyGLib.Account
Return type:: int

New in version 0.15.5.

classmethod get_feature_quark_core()¶

Returns:: the quark used for representing the core feature of a TelepathyGLib.Account
Return type:: int

New in version 0.9.0.

classmethod get_feature_quark_storage()¶

Returns:: the quark used for representing the storage interface of a TelepathyGLib.Account
Return type:: int

New in version 0.13.2.

classmethod init_known_interfaces()¶: Ensure that the known interfaces for TelepathyGLib.Account have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument %TP_TYPE_ACCOUNT.

New in version 0.7.32.

classmethod new(bus_daemon, object_path)¶

Parameters:

bus_daemon (TelepathyGLib.DBusDaemon) – Proxy for the D-Bus daemon
object_path (str) – The non-None object path of this account

Raises:

GLib.Error

Returns:

a new reference to an account proxy, or None if object_path is not valid

Return type:

TelepathyGLib.Account

Convenience function to create a new account proxy. The returned TelepathyGLib.Account is not guaranteed to be ready at the point of return.

Deprecated since version ???: Use TelepathyGLib.SimpleClientFactory.ensure_account() instead.

classmethod parse_object_path(object_path)¶

Parameters:

object_path (str) – a Telepathy Account’s object path

Raises:

GLib.Error

Returns:

True if object_path was successfully parsed; False and sets error otherwise.

cm:: location at which to store the account’s connection manager’s name
protocol:: location at which to store the account’s protocol
account_id:: location at which to store the account’s unique identifier

Return type:

(bool, cm: str, protocol: str, account_id: str)

Validates and parses a Telepathy Account’s object path, extracting the connection manager’s name, the protocol, and the account’s unique identifier from the path. This includes replacing underscores with hyphens in the protocol name, as defined in the Account specification.

Any of the out parameters may be None if not needed. If True is returned, the caller is responsible for freeing the strings stored in any non-None out parameters, using GLib.free().

New in version 0.9.0.

Deprecated since version ???: Use TelepathyGLib.Account.get_protocol() and TelepathyGLib.Account.get_connection_manager() instead.

associated_with_uri_scheme(scheme)¶

Parameters:: scheme (str) – a URI scheme such as “tel”, “sip” or “xmpp”
Returns:: True if the result of TelepathyGLib.Account.get_uri_schemes() would include scheme
Return type:: bool

New in version 0.13.8.

bind_connection_status_to_property(target, target_property, invert)¶

Parameters:

target (object or None) – the target GObject.Object
target_property (str) – the property on target to bind (must be GObject.TYPE_BOOLEAN)
invert (bool) – True if you wish to invert the value of target_property (i.e. False if connected)

Returns:

the GObject.Binding instance representing the binding between the self and the target. The binding is released whenever the GObject.Binding reference count reaches zero.

Return type:

GObject.Binding

Binds the :connection-status of self to the boolean property of another object using a GObject.Binding such that the target_property will be set to True when self is connected (and invert is False).

target_property will be synchronised immediately (GObject.BindingFlags.SYNC_CREATE). invert can be interpreted as analogous to GObject.BindingFlags.INVERT_BOOLEAN.

For instance, this function can be used to bind the GtkWidget:sensitive property to only make a widget sensitive when the account is connected.

See GObject.Object.bind_property() for more information.

New in version 0.13.16.

dup_detailed_error_vardict()¶

Returns:

a D-Bus error name, or None.

details:: optionally used to return a variant of type %G_VARIANT_TYPE_VARDICT, which must be unreffed by the caller with GLib.Variant.unref()

Return type:

(str or None, details: GLib.Variant)

If the account’s connection is not connected, return the D-Bus error name with which it last disconnected or failed to connect (in particular, this is %TP_ERROR_STR_CANCELLED if it was disconnected by a user request). This is the same as TelepathyGLib.Account :connection-error.

If details is not None, it will be used to return additional details about the error (the same as TelepathyGLib.Account :connection-error-details).

Otherwise, return None, without altering details.

The returned string and details may become invalid when the main loop is re-entered or the account is destroyed.

New in version 0.17.6.

dup_parameters_vardict()¶

Returns:: the dictionary of parameters on self, of type %G_VARIANT_TYPE_VARDICT
Return type:: GLib.Variant

Returns the parameters of the account, in a variant of type %G_VARIANT_TYPE_VARDICT where the keys are parameter names (account, password, require-encryption etc.). Use g_variant_lookup() or GLib.Variant.lookup_value() for convenient access to the values.

The allowed parameters depend on the connection manager, and can be found via TelepathyGLib.ConnectionManager.get_protocol() and TelepathyGLib.ConnectionManagerProtocol.get_param(). Well-known parameters are listed

in the Telepathy D-Bus Interface Specification.

New in version 0.17.6.

dup_storage_identifier_variant()¶

Returns:: the same as the TelepathyGLib.Account :storage-identifier-variant property
Return type:: GLib.Variant

Return provider-specific information used to identify this account. Use GLib.Variant.get_type() to check that the type is what you expect; for instance, if the TelepathyGLib.Account :storage-provider has string-based user identifiers, this variant should have type %G_VARIANT_TYPE_STRING.

New in version 0.13.2.

dup_storage_specific_information_vardict_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Makes an asynchronous request of self's StorageSpecificInformation property (part of the Account.Interface.Storage interface).

When the operation is finished, callback will be called. You must then call TelepathyGLib.Account.dup_storage_specific_information_vardict_finish() to get the result of the request.

New in version 0.17.6.

dup_storage_specific_information_vardict_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: a map from strings to variants, of type %G_VARIANT_TYPE_VARDICT
Return type:: GLib.Variant

Retrieve the value of the request begun with TelepathyGLib.Account.dup_storage_specific_information_vardict_async().

New in version 0.17.6.

ensure_connection(path)¶

Parameters:: path (str) – the path to connection object for TelepathyGLib.Account
Returns:: the connection of the account, or None if either the object path path is invalid or it is the null-value “/”
Return type:: TelepathyGLib.Connection

Set the connection of the account by specifying the connection object path. This function does not return a new ref and it is not guaranteed that the returned TelepathyGLib.Connection object is ready.

The use-case for this function is in a HandleChannels callback and you already know the object path for the connection, so you can let self create its TelepathyGLib.Connection and return it for use.

New in version 0.9.0.

Deprecated since version ???: New code should use TelepathyGLib.SimpleClientFactory.ensure_connection() instead.

get_automatic_presence()¶

Returns:

the same as the TelepathyGLib.Account :automatic-presence-type property

status:: return location for the presence status
status_message:: return location for the user-defined message

Return type:

(TelepathyGLib.ConnectionPresenceType, status: str, status_message: str)

Gets the automatic presence, status and status message of account. These values are the same as the TelepathyGLib.Account :automatic-presence-type, TelepathyGLib.Account :automatic-status and TelepathyGLib.Account :automatic-status-message properties, and are the values that will be used if the account should be put online automatically.

New in version 0.13.8.

get_avatar_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous get of self's avatar. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.get_avatar_finish() to get the result of the operation.

New in version 0.9.0.

get_avatar_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: a GLib.Array of #guchar containing the bytes of the account’s avatar, or None on failure
Return type:: bytes

Finishes an async get operation of self's avatar.

Beware that the returned value is only valid until result is freed. Copy it with g_array_ref() if you need to keep it for longer.

New in version 0.9.0.

get_changing_presence()¶

Returns:: the same as the TelepathyGLib.Account :changing-presence property
Return type:: bool

New in version 0.11.6.

get_cm_name()¶

Returns:: the same as the TelepathyGLib.Account :cm-name property
Return type:: str

New in version 0.19.3.

get_connect_automatically()¶

Returns:: the same as the TelepathyGLib.Account :connect-automatically property
Return type:: bool

New in version 0.9.0.

get_connection()¶

Returns:: the same as the TelepathyGLib.Account :connection property
Return type:: TelepathyGLib.Connection

New in version 0.9.0.

get_connection_manager()¶

Returns:: the same as the TelepathyGLib.Account :connection-manager property
Return type:: str

New in version 0.9.0.

Deprecated since version ???: Use TelepathyGLib.Account.get_cm_name() instead.

get_connection_status()¶

Returns:

the same as the TelepathyGLib.Account :connection-status property

reason:: a TelepathyGLib.ConnectionStatusReason to fill, or None

Return type:

(TelepathyGLib.ConnectionStatus, reason: TelepathyGLib.ConnectionStatusReason)

Gets the connection status and reason from self. The two values are the same as the TelepathyGLib.Account :connection-status and TelepathyGLib.Account :connection-status-reason properties.

New in version 0.9.0.

get_current_presence()¶

Returns:

the same as the TelepathyGLib.Account :current-presence-type property

status:: return location for the current status
status_message:: return location for the current status message

Return type:

(TelepathyGLib.ConnectionPresenceType, status: str, status_message: str)

Gets the current presence, status and status message of self. These values are the same as the TelepathyGLib.Account :current-presence-type, TelepathyGLib.Account :current-status and TelepathyGLib.Account :current-status-message properties.

New in version 0.9.0.

get_display_name()¶

Returns:: the same as the TelepathyGLib.Account :display-name property
Return type:: str

New in version 0.9.0.

get_has_been_online()¶

Returns:: the same as the TelepathyGLib.Account :has-been-online property
Return type:: bool

New in version 0.9.0.

get_icon_name()¶

Returns:: the same as the TelepathyGLib.Account :icon-name property
Return type:: str

New in version 0.9.0.

get_nickname()¶

Returns:: the same as the TelepathyGLib.Account :nickname property
Return type:: str

New in version 0.9.0.

get_normalized_name()¶

Returns:: the same as the TelepathyGLib.Account :normalized-name property
Return type:: str

New in version 0.13.8.

get_parameters()¶

Returns:: the hash table of parameters on self
Return type:: {str: GObject.Value}

Returns the parameters of the account, in a hash table where each string is the parameter name (account, password, require-encryption etc.), and each value is a GObject.Value. Using the tp_asv_get family of functions (TelepathyGLib.asv_get_uint32(), TelepathyGLib.asv_get_string() etc.) to access the parameters is recommended.

The allowed parameters depend on the connection manager, and can be found via TelepathyGLib.ConnectionManager.get_protocol() and TelepathyGLib.ConnectionManagerProtocol.get_param(). Well-known parameters are listed

in the Telepathy D-Bus Interface Specification.

New in version 0.9.0.

get_path_suffix()¶

Returns:: a suffix of self's object path, for debugging purposes.
Return type:: str

Returns the portion of self's object path after the standard TelepathyGLib.ACCOUNT_OBJECT_PATH_BASE prefix, of the form “cm/protocol/acct”. This string uniquely identifies the account.

This function is only intended to be used when printing debug messages or in tools for developer. For a string suitable for displaying to the user, see TelepathyGLib.Account.get_display_name(). To retrieve the connection manager and protocol name parts of the object path, see TelepathyGLib.Account.get_connection_manager() and TelepathyGLib.Account.get_protocol(). For persistent identification of the account, use TelepathyGLib.Proxy.get_object_path().

New in version 0.13.9.

get_protocol()¶

Returns:: the same as the TelepathyGLib.Account :protocol property
Return type:: str

New in version 0.9.0.

Deprecated since version ???: Use TelepathyGLib.Account.get_cm_name() instead.

get_protocol_name()¶

Returns:: the same as the TelepathyGLib.Account :protocol-name property
Return type:: str

New in version 0.19.3.

get_requested_presence()¶

Returns:

the same as the TelepathyGLib.Account :requested-presence-type property

status:: return location for the requested status
status_message:: return location for the requested status message

Return type:

(TelepathyGLib.ConnectionPresenceType, status: str, status_message: str)

Gets the requested presence, status and status message of self. These values are the same as the TelepathyGLib.Account :requested-presence-type, TelepathyGLib.Account :requested-status and TelepathyGLib.Account :requested-status-message properties.

New in version 0.9.0.

get_service()¶

Returns:: the same as the TelepathyGLib.Account :service property
Return type:: str

New in version 0.11.9.

get_storage_identifier()¶

Returns:: the same as the TelepathyGLib.Account :storage-identifier property
Return type:: GObject.Value

New in version 0.13.2.

get_storage_provider()¶

Returns:: the same as the TelepathyGLib.Account :storage-provider property
Return type:: str

New in version 0.13.2.

get_storage_restrictions()¶

Returns:: the same as the TelepathyGLib.Account :storage-restrictions property
Return type:: TelepathyGLib.StorageRestrictionFlags

New in version 0.13.2.

get_storage_specific_information_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Makes an asynchronous request of self's StorageSpecificInformation property (part of the Account.Interface.Storage interface).

When the operation is finished, callback will be called. You must then call TelepathyGLib.Account.get_storage_specific_information_finish() to get the result of the request.

New in version 0.13.2.

get_storage_specific_information_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: a GLib.HashTable of strings to GValues representing the D-Bus type a{sv}.
Return type:: {str: GObject.Value}

Retrieve the value of the request begun with TelepathyGLib.Account.get_storage_specific_information_async().

Beware that the returned value is only valid until result is freed. Copy it with g_hash_table_ref() if you need to keep it for longer.

New in version 0.13.2.

get_supersedes()¶

Returns:: the same as the TelepathyGLib.Account :supersedes property
Return type:: [str]

Return the same thing as the TelepathyGLib.Account :supersedes property, in a way that may be more convenient for C code.

The returned pointers are not guaranteed to remain valid after the main loop has been re-entered.

New in version 0.17.5.

get_uri_schemes()¶

Returns:: the value of #TpAccount:uri_schemes property
Return type:: [str]

Return the TelepathyGLib.Account :uri-schemes property

New in version 0.13.8.

is_enabled()¶

Returns:: the same as the TelepathyGLib.Account :enabled property
Return type:: bool

New in version 0.9.0.

is_valid()¶

Returns:: the same as the TelepathyGLib.Account :valid property
Return type:: bool

New in version 0.9.0.

reconnect_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous reconnect of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.reconnect_finish() to get the result of the operation.

New in version 0.9.0.

reconnect_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the reconnect call was successful, otherwise False
Return type:: bool

Finishes an async reconnect of self.

New in version 0.9.0.

remove_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous removal of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.remove_finish() to get the result of the operation.

New in version 0.9.0.

remove_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async removal of self.

New in version 0.9.0.

request_presence_async(type, status, message, callback, *user_data)¶

Parameters:

type (TelepathyGLib.ConnectionPresenceType) – the requested presence
status (str) – a status message to set, or None
message (str) – a message for the change, or None
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous change of presence on self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.request_presence_finish() to get the result of the operation.

New in version 0.9.0.

request_presence_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async presence change request on self.

New in version 0.9.0.

set_automatic_presence_async(type, status, message, callback, *user_data)¶

Parameters:

type (TelepathyGLib.ConnectionPresenceType) – the requested presence
status (str) – a status message to set, or None
message (str) – a message for the change, or None
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous change of self's automatic presence. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_automatic_presence_finish() to get the result of the operation.

New in version 0.13.8.

set_automatic_presence_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an asynchronous request to change the automatic presence of self.

New in version 0.13.8.

set_avatar_async(avatar, mime_type, callback, *user_data)¶

Parameters:

avatar (bytes or None) – a new avatar to set; can be None only if len equals 0
mime_type (str or None) – the MIME type of the new avatar; can be None only if len equals 0
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous change of the Avatar parameter on self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_avatar_finish() to get the result of the operation.

If len equals 0, the avatar is cleared.

New in version 0.11.1.

set_avatar_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async avatar change request on account.

New in version 0.11.1.

set_connect_automatically_async(connect_automatically, callback, *user_data)¶

Parameters:

connect_automatically (bool) – new value for the parameter
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous set of the ConnectAutomatically property of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_display_name_finish() to get the result of the operation.

New in version 0.9.0.

set_connect_automatically_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the call was successful, otherwise False
Return type:: bool

Finishes an async set of the ConnectAutomatically property.

New in version 0.9.0.

set_display_name_async(display_name, callback, *user_data)¶

Parameters:

display_name (str) – a new display name, or None to unset the display name
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous set of the DisplayName property of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_display_name_finish() to get the result of the operation.

New in version 0.9.0.

set_display_name_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the call was successful, otherwise False
Return type:: bool

Finishes an async set of the DisplayName property.

New in version 0.9.0.

set_enabled_async(enabled, callback, *user_data)¶

Parameters:

enabled (bool) – the new enabled value of self
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous set of the Enabled property of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_enabled_finish() to get the result of the operation.

New in version 0.9.0.

set_enabled_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the set was successful, otherwise False
Return type:: bool

Finishes an async set of the Enabled property.

New in version 0.9.0.

set_icon_name_async(icon_name, callback, *user_data)¶

Parameters:

icon_name (str) – a new icon name, or None to unset the icon name
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous set of the Icon property of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_icon_name_finish() to get the result of the operation.

New in version 0.9.0.

set_icon_name_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async set of the Icon parameter.

New in version 0.9.0.

set_nickname_async(nickname, callback, *user_data)¶

Parameters:

nickname (str) – a new nickname to set
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous change of the Nickname parameter on self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_nickname_finish() to get the result of the operation.

New in version 0.9.0.

set_nickname_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async nickname change request on self.

New in version 0.9.0.

set_service_async(service, callback, *user_data)¶

Parameters:

service (str) – a new service name, or None or the empty string to unset the service name (which will result in the TelepathyGLib.Account :service property becoming the same as TelepathyGLib.Account :protocol)
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous set of the Service property on self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.set_service_finish() to get the result of the operation.

New in version 0.11.9.

set_service_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the operation was successful, otherwise False
Return type:: bool

Finishes an async set of the Service parameter.

New in version 0.11.9.

set_uri_scheme_association_async(scheme, associate, callback, *user_data)¶

Parameters:

scheme (str) – a non-None URI scheme such as “tel”
associate (bool) – True to use this account for scheme, or False to not use it
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Add scheme to the list of additional URI schemes that would be returned by TelepathyGLib.Account.get_uri_schemes(), or remove it from that list.

scheme should not be the primary URI scheme for the account’s protocol (for instance, “xmpp” for XMPP, or “sip” or “sips” for SIP), since the account should be assumed to be useful for those schemes regardless of the contents of the list.

Calling this method does not require the %TP_ACCOUNT_FEATURE_ADDRESSING feature to be enabled, but the change will not be reflected in the result of TelepathyGLib.Account.get_uri_schemes() or TelepathyGLib.Account.associated_with_uri_scheme() unless that feature has been enabled.

New in version 0.13.8.

set_uri_scheme_association_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if the call was successful, otherwise False
Return type:: bool

Interpret the result of TelepathyGLib.Account.set_uri_scheme_association_async().

New in version 0.13.8.

update_parameters_async(parameters, unset_parameters, callback, *user_data)¶

Parameters:

parameters ({str: GObject.Value}) – new parameters to set on self
unset_parameters (str) – list of parameters to unset on self
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous update of parameters of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.update_parameters_finish() to get the result of the operation.

New in version 0.9.0.

update_parameters_finish(result)¶

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

True if the request succeeded, otherwise False

reconnect_required:: a #GStrv to fill with properties that need a reconnect to take effect

Return type:

(bool, reconnect_required: [str])

Finishes an async update of the parameters on self.

New in version 0.9.0.

update_parameters_vardict_async(parameters, unset_parameters, callback, *user_data)¶

Parameters:

parameters (GLib.Variant) – a variant of type %G_VARIANT_TYPE_VARDICT containing new parameters to set on self
unset_parameters ([str]) – list of parameters to unset on self
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Requests an asynchronous update of parameters of self. When the operation is finished, callback will be called. You can then call TelepathyGLib.Account.update_parameters_finish() to get the result of the operation.

If parameters is a floating reference (see GLib.Variant.ref_sink()), ownership of parameters is taken by this function. This means you can pass the result of g_variant_new() or g_variant_new_parsed() directly to this function without additional reference-count management.

New in version 0.17.6.

update_parameters_vardict_finish(result)¶

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

True if the request succeeded, otherwise False

reconnect_required:: a #GStrv to fill with properties that need a reconnect to take effect

Return type:

(bool, reconnect_required: [str])

Finishes an async update of the parameters on self.

New in version 0.17.6.

Signal Details¶

TelepathyGLib.Account.signals.avatar_changed(account)¶

Signal Name:: avatar-changed
Flags:: RUN_LAST
Parameters:: account (TelepathyGLib.Account) – The object which received the signal

Emitted when the avatar changes. Call TelepathyGLib.Account.get_avatar_async() to get the new avatar data.

New in version 0.23.0.

TelepathyGLib.Account.signals.presence_changed(account, presence, status, status_message)¶

Signal Name:

presence-changed

Flags:

RUN_LAST

Parameters:

account (TelepathyGLib.Account) – The object which received the signal
presence (int) – the new presence
status (str) – the new presence status
status_message (str) – the new presence status message

Emitted when the presence of the account changes.

New in version 0.9.0.

TelepathyGLib.Account.signals.status_changed(account, old_status, new_status, reason, dbus_error_name, details)¶

Signal Name:

status-changed

Flags:

RUN_LAST

Parameters:

account (TelepathyGLib.Account) – The object which received the signal
old_status (int) – old TelepathyGLib.Account :connection-status
new_status (int) – new TelepathyGLib.Account :connection-status
reason (int) – the TelepathyGLib.Account :connection-status-reason
dbus_error_name (str or None) – the TelepathyGLib.Account :connection-error
details ({str: GObject.Value}) – the TelepathyGLib.Account :connection-error-details

Emitted when the connection status on the account changes.

The dbus_error_name and details parameters were present, but non-functional (always None), in older versions. They have been available with their current behaviour since version 0.11.7.

New in version 0.9.0.

Property Details¶

TelepathyGLib.Account.props.automatic_presence_type¶

Name:: automatic-presence-type
Type:: int
Default Value:: 0
Flags:: READABLE

The account’s automatic presence type (a TelepathyGLib.ConnectionPresenceType).

When the account is put online automatically, for instance to make a channel request or because network connectivity becomes available, the automatic presence type, status and message will be copied to their “requested” counterparts.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for automatic-presence-type, automatic-status and automatic-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is TelepathyGLib.ConnectionPresenceType.UNSET.

New in version 0.13.8.

TelepathyGLib.Account.props.automatic_status¶

Name:: automatic-status
Type:: str
Default Value:: None
Flags:: READABLE

The string status name to use in conjunction with the TelepathyGLib.Account :automatic-presence-type.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for automatic-presence-type, automatic-status and automatic-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.13.8.

TelepathyGLib.Account.props.automatic_status_message¶

Name:: automatic-status-message
Type:: str
Default Value:: None
Flags:: READABLE

The user-defined message to use in conjunction with the TelepathyGLib.Account :automatic-presence-type.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for automatic-presence-type, automatic-status and automatic-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.13.8.

TelepathyGLib.Account.props.changing_presence¶

Name:: changing-presence
Type:: bool
Default Value:: False
Flags:: READABLE

True if an attempt is currently being made to change the account’s presence (TelepathyGLib.Account :current-presence-type, TelepathyGLib.Account :current-status and TelepathyGLib.Account :current-status-message) to match its requested presence (TelepathyGLib.Account :requested-presence-type, TelepathyGLib.Account :requested-status and TelepathyGLib.Account :requested-status-message).

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is False.

New in version 0.11.6.

TelepathyGLib.Account.props.cm_name¶

Name:: cm-name
Type:: str
Default Value:: None
Flags:: READABLE

The account’s connection manager name.

New in version 0.19.3.

TelepathyGLib.Account.props.connect_automatically¶

Name:: connect-automatically
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the account should connect automatically or not. To change this property, use TelepathyGLib.Account.set_connect_automatically_async().

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is False.

New in version 0.9.0.

TelepathyGLib.Account.props.connection¶

Name:: connection
Type:: TelepathyGLib.Connection
Default Value:: None
Flags:: READABLE

The connection of the account, or None if account is offline. Note that the returned TelepathyGLib.Connection is not guaranteed to have any features pre-prepared (not even %TP_CONNECTION_FEATURE_CORE) unless %TP_ACCOUNT_FEATURE_CONNECTION has been prepared on the account

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. If %TP_ACCOUNT_FEATURE_CONNECTION has been prepared, this signal will be delayed until the connection is ready.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.connection_error¶

Name:: connection-error
Type:: str
Default Value:: None
Flags:: READABLE

The D-Bus error name for the last disconnection or connection failure, (in particular, %TP_ERROR_STR_CANCELLED if it was disconnected by user request), or None if the account is connected.

One can receive change notifications on this property by connecting to the TelepathyGLib.Account ::status-changed signal, or by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.11.7.

TelepathyGLib.Account.props.connection_error_details¶

Name:: connection-error-details
Type:: GLib.HashTable
Default Value:: None
Flags:: READABLE

A map from string to GObject.Value containing extensible error details related to TelepathyGLib.Account :connection-error. Functions like TelepathyGLib.asv_get_string() can be used to read from this map.

The keys for this map are defined by

the Telepathy D-Bus Interface Specification. They will typically include debug-message, which is a debugging message in the C locale, analogous to GLib.Error .message.

One can receive change notifications on this property by connecting to the TelepathyGLib.Account ::status-changed signal, or by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is an empty map.

New in version 0.11.7.

TelepathyGLib.Account.props.connection_manager¶

Name:: connection-manager
Type:: str
Default Value:: None
Flags:: READABLE

The account’s connection manager name.

New in version 0.9.0.

Deprecated since version ???: Use TelepathyGLib.Account :cm-name instead.

TelepathyGLib.Account.props.connection_status¶

Name:: connection-status
Type:: int
Default Value:: 2
Flags:: READABLE

The account’s connection status type (a TelepathyGLib.ConnectionStatus).

One can receive change notifications on this property by connecting to the TelepathyGLib.Account ::status-changed signal, or by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is TelepathyGLib.ConnectionStatus.DISCONNECTED.

New in version 0.9.0.

TelepathyGLib.Account.props.connection_status_reason¶

Name:: connection-status-reason
Type:: int
Default Value:: 0
Flags:: READABLE

The account’s connection status reason (a TelepathyGLib.ConnectionStatusReason).

One can receive change notifications on this property by connecting to the TelepathyGLib.Account ::status-changed signal, or by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is TelepathyGLib.ConnectionStatusReason.NONE_SPECIFIED.

New in version 0.9.0.

TelepathyGLib.Account.props.current_presence_type¶

Name:: current-presence-type
Type:: int
Default Value:: 0
Flags:: READABLE

The account connection’s current presence type (a TelepathyGLib.ConnectionPresenceType).

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for current-presence-type, current-status and current-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is TelepathyGLib.ConnectionPresenceType.UNSET.

New in version 0.9.0.

TelepathyGLib.Account.props.current_status¶

Name:: current-status
Type:: str
Default Value:: None
Flags:: READABLE

The current Status string of the account.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for current-presence-type, current-status and current-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.current_status_message¶

Name:: current-status-message
Type:: str
Default Value:: None
Flags:: READABLE

The current status message message of the account.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for current-presence-type, current-status and current-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.display_name¶

Name:: display-name
Type:: str
Default Value:: None
Flags:: READABLE

The account’s display name, from the DisplayName property.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.enabled¶

Name:: enabled
Type:: bool
Default Value:: False
Flags:: READABLE

Whether this account is enabled or not.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is False.

New in version 0.9.0.

TelepathyGLib.Account.props.has_been_online¶

Name:: has-been-online
Type:: bool
Default Value:: False
Flags:: READABLE

Whether this account has been online or not.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is False.

New in version 0.9.0.

TelepathyGLib.Account.props.icon_name¶

Name:: icon-name
Type:: str
Default Value:: None
Flags:: READABLE

The account’s icon name. To change this propery, use TelepathyGLib.Account.set_icon_name_async().

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.nickname¶

Name:: nickname
Type:: str
Default Value:: None
Flags:: READABLE

The nickname that should be set for the user on this account.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.normalized_name¶

Name:: normalized-name
Type:: str
Default Value:: None
Flags:: READABLE

The normalized form of the user’s own unique identifier on this protocol. For example, on XMPP accounts this is the user’s JID; on ICQ this is the user’s UIN; and so on.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.13.8.

TelepathyGLib.Account.props.protocol¶

Name:: protocol
Type:: str
Default Value:: None
Flags:: READABLE

The account’s machine-readable protocol name, such as “jabber”, “msn” or “local-xmpp”. Recommended names for most protocols can be found in the Telepathy D-Bus Interface Specification.

New in version 0.9.0.

Deprecated since version ???: Use TelepathyGLib.Account :protocol-name instead.

TelepathyGLib.Account.props.protocol_name¶

Name:: protocol-name
Type:: str
Default Value:: None
Flags:: READABLE

The account’s machine-readable protocol name, such as “jabber”, “msn” or “local-xmpp”. Recommended names for most protocols can be found in the Telepathy D-Bus Interface Specification.

New in version 0.19.3.

TelepathyGLib.Account.props.requested_presence_type¶

Name:: requested-presence-type
Type:: int
Default Value:: 0
Flags:: READABLE

The account’s requested presence type (a TelepathyGLib.ConnectionPresenceType).

Since 0.13.8, one can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for requested-presence-type, requested-status and requested-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.requested_status¶

Name:: requested-status
Type:: str
Default Value:: None
Flags:: READABLE

The requested Status string of the account.

Since 0.13.8, one can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for requested-presence-type, requested-status and requested-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.requested_status_message¶

Name:: requested-status-message
Type:: str
Default Value:: None
Flags:: READABLE

The requested status message message of the account.

Since 0.13.8, one can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail. Change notifications for requested-presence-type, requested-status and requested-status-message are always emitted together, so it is sufficient to connect to one of the notification signals.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is None.

New in version 0.9.0.

TelepathyGLib.Account.props.service¶

Name:: service
Type:: str
Default Value:: None
Flags:: READABLE

A machine-readable name identifying a specific service to which this account connects, or a copy of TelepathyGLib.Account :protocol if there is no more specific service.

Well-known names for various services can be found in the Telepathy D-Bus Interface Specification.

For instance, accounts for the “jabber” protocol should have the service names “google-talk”, “ovi-chat”, “facebook” and “lj-talk” for accounts that connect to Google Talk, Ovi Chat, Facebook and Livejournal, respectively, and this property will be “jabber” for accounts that connect to a generic Jabber server.

To change this property, use TelepathyGLib.Account.set_service_async().

New in version 0.11.9.

TelepathyGLib.Account.props.storage_identifier¶

Name:: storage-identifier
Type:: GObject.Value
Default Value:: None
Flags:: READABLE

The storage identifier for this account.

A provider-specific variant type used to identify this account with the provider. This value will be None if TelepathyGLib.Account :storage-provider is an empty string.

This property cannot change once an Account has been created.

This is not guaranteed to have been retrieved until the %TP_ACCOUNT_FEATURE_STORAGE feature has been prepared; until then, the value is None.

New in version 0.13.2.

TelepathyGLib.Account.props.storage_identifier_variant¶

Name:: storage-identifier-variant
Type:: GLib.Variant
Default Value:: None
Flags:: READABLE

Provider-specific information used to identify this account. Use GLib.Variant.get_type() to check that the type is what you expect. For instance, if you use a TelepathyGLib.Account :storage-provider with numeric identifiers for accounts, this variant might have type %G_VARIANT_TYPE_UINT32; if the storage provider has string-based identifiers, it should have type %G_VARIANT_TYPE_STRING.

This property cannot change once an Account has been created.

This is not guaranteed to have been retrieved until the %TP_ACCOUNT_FEATURE_STORAGE feature has been prepared; until then, the value is None.

New in version 0.13.2.

TelepathyGLib.Account.props.storage_provider¶

Name:: storage-provider
Type:: str
Default Value:: None
Flags:: READABLE

The storage provider for this account.

The name of the account storage implementation. When this is the empty string the account is internally stored.

This property cannot change once an Account has been created.

This is not guaranteed to have been retrieved until the %TP_ACCOUNT_FEATURE_STORAGE feature has been prepared; until then, the value is None.

New in version 0.13.2.

TelepathyGLib.Account.props.storage_restrictions¶

Name:: storage-restrictions
Type:: int
Default Value:: 0
Flags:: READABLE

The storage restrictions for this account.

A bitfield of TelepathyGLib.StorageRestrictionFlags that give the limitations of this account imposed by the storage provider. This value will be 0 if TelepathyGLib.Account :storage-provider is an empty string.

This property cannot change once an Account has been created.

This is not guaranteed to have been retrieved until the %TP_ACCOUNT_FEATURE_STORAGE feature has been prepared; until then, the value is 0.

New in version 0.13.2.

TelepathyGLib.Account.props.supersedes¶

Name:: supersedes
Type:: [str]
Default Value:: []
Flags:: READABLE

The object paths of previously-active accounts superseded by this one. For instance, this can be used in a logger to read old logs for an account that has been migrated from one connection manager to another.

This is not guaranteed to have been retrieved until the %TP_ACCOUNT_FEATURE_CORE feature has been prepared; until then, the value is None.

New in version 0.17.5.

TelepathyGLib.Account.props.uri_schemes¶

Name:: uri-schemes
Type:: [str]
Default Value:: []
Flags:: READABLE

If the %TP_ACCOUNT_FEATURE_ADDRESSING feature has been prepared successfully, a list of additional URI schemes for which this account should be used if possible. Otherwise None.

For instance, a SIP or Skype account might have “tel” in this list if the user would like to use that account to call phone numbers.

This list should not contain the primary URI scheme(s) for the account’s protocol (for instance, “xmpp” for XMPP, or “sip” or “sips” for SIP), since it should be assumed to be useful for those schemes in any case.

The notify::uri-schemes signal cannot be relied on if the Account Manager is Mission Control version 5.14.0 or older.

New in version 0.21.0.

TelepathyGLib.Account.props.valid¶

Name:: valid
Type:: bool
Default Value:: False
Flags:: READABLE

Whether this account is valid.

One can receive change notifications on this property by connecting to the GObject.Object ::notify signal and using this property as the signal detail.

This is not guaranteed to have been retrieved until TelepathyGLib.Proxy.prepare_async() has finished; until then, the value is False.

New in version 0.9.0.