TelepathyGLib.Account¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
Presence type used to put the account online automatically |
||
r |
Presence status used to put the account online automatically |
||
r |
User-defined message used to put the account online automatically |
||
r |
|
||
r |
The account’s connection manager name |
||
r |
Whether this account should connect automatically or not |
||
r |
The account’s connection |
||
r |
The account’s last connection error |
||
r |
Extensible details of the account’s last connection error |
||
r |
The account’s connection manager name |
||
r |
The account’s connection status type |
||
r |
The account’s connection status reason |
||
r |
The account connection’s current presence type |
||
r |
The Status string of the account |
||
r |
The Status message string of the account |
||
r |
The account’s display name |
||
r |
Whether this account is enabled or not |
||
r |
Whether this account has been online or not |
||
r |
The account’s icon name |
||
r |
The account’s nickname |
||
r |
The normalized identifier of the user |
||
r |
The account’s protocol name |
||
r |
The account’s protocol name |
||
r |
The account’s requested presence type |
||
r |
The account’s requested status string |
||
r |
The requested Status message string of the account |
||
r |
The account’s service name |
||
r |
The storage identifier for this account |
||
r |
The storage identifier for this account |
||
r |
The storage provider for this account |
||
r |
The storage restrictions for this account |
||
[ |
r |
Accounts superseded by this one |
|
[ |
r |
URISchemes |
|
r |
Whether this account is valid |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
Emitted when the avatar changes. |
|
Emitted when the presence of the account changes. |
|
Emitted when the connection status on the account changes. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class TelepathyGLib.Account(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
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 codeTelepathyGLib.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 theTelepathyGLib.AccountManager
.Since 0.16,
TelepathyGLib.Account
always has a non-None
TelepathyGLib.Proxy
:factory
, and itsTelepathyGLib.Proxy
:factory
will be propagated to itsTelepathyGLib.Connection
(if any). If aTelepathyGLib.Account
is created without going via theTelepathyGLib.AccountManager
or specifying aTelepathyGLib.Proxy
:factory
, the default is to use a newTelepathyGLib.AutomaticClientFactory
.New in version 0.7.32.
- classmethod get_feature_quark_connection()¶
- Returns:
the quark used for representing the connection feature of a
TelepathyGLib.Account
- Return type:
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:
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:
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 daemonobject_path (
str
) – The non-None
object path of this account
- Raises:
- Returns:
a new reference to an account proxy, or
None
if object_path is not valid- Return type:
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:
- 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:
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. IfTrue
is returned, the caller is responsible for freeing the strings stored in any non-None
out parameters, usingGLib.free
().New in version 0.9.0.
Deprecated since version ???: Use
TelepathyGLib.Account.get_protocol
() andTelepathyGLib.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 ofTelepathyGLib.Account.get_uri_schemes
() would include scheme- Return type:
New in version 0.13.8.
- bind_connection_status_to_property(target, target_property, invert)¶
- Parameters:
target (
object
orNone
) – the targetGObject.Object
target_property (
str
) – the property on target to bind (must beGObject.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 theGObject.Binding
reference count reaches zero.- Return type:
Binds the
:connection-status
of self to the boolean property of another object using aGObject.Binding
such that the target_property will be set toTrue
when self is connected (and invert isFalse
).target_property will be synchronised immediately (
GObject.BindingFlags.SYNC_CREATE
). invert can be interpreted as analogous toGObject.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
orNone
, 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 asTelepathyGLib.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:
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
() andTelepathyGLib.ConnectionManagerProtocol.get_param
(). Well-known parameters are listedin 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:
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 theTelepathyGLib.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
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
a map from strings to variants, of type %G_VARIANT_TYPE_VARDICT
- Return type:
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 forTelepathyGLib.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:
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
andTelepathyGLib.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
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
a
GLib.Array
of #guchar containing the bytes of the account’s avatar, orNone
on failure- Return type:
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:
New in version 0.11.6.
- get_cm_name()¶
- Returns:
the same as the
TelepathyGLib.Account
:cm-name
property- Return type:
New in version 0.19.3.
- get_connect_automatically()¶
- Returns:
the same as the
TelepathyGLib.Account
:connect-automatically
property- Return type:
New in version 0.9.0.
- get_connection()¶
- Returns:
the same as the
TelepathyGLib.Account
:connection
property- Return type:
New in version 0.9.0.
- get_connection_manager()¶
- Returns:
the same as the
TelepathyGLib.Account
:connection-manager
property- Return type:
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, orNone
- 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
andTelepathyGLib.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
andTelepathyGLib.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:
New in version 0.9.0.
- get_has_been_online()¶
- Returns:
the same as the
TelepathyGLib.Account
:has-been-online
property- Return type:
New in version 0.9.0.
- get_icon_name()¶
- Returns:
the same as the
TelepathyGLib.Account
:icon-name
property- Return type:
New in version 0.9.0.
- get_nickname()¶
- Returns:
the same as the
TelepathyGLib.Account
:nickname
property- Return type:
New in version 0.9.0.
- get_normalized_name()¶
- Returns:
the same as the
TelepathyGLib.Account
:normalized-name
property- Return type:
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
() andTelepathyGLib.ConnectionManagerProtocol.get_param
(). Well-known parameters are listedin 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:
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, seeTelepathyGLib.Account.get_connection_manager
() andTelepathyGLib.Account.get_protocol
(). For persistent identification of the account, useTelepathyGLib.Proxy.get_object_path
().New in version 0.13.9.
- get_protocol()¶
- Returns:
the same as the
TelepathyGLib.Account
:protocol
property- Return type:
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:
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
andTelepathyGLib.Account
:requested-status-message
properties.New in version 0.9.0.
- get_service()¶
- Returns:
the same as the
TelepathyGLib.Account
:service
property- Return type:
New in version 0.11.9.
- get_storage_identifier()¶
- Returns:
the same as the
TelepathyGLib.Account
:storage-identifier
property- Return type:
New in version 0.13.2.
- get_storage_provider()¶
- Returns:
the same as the
TelepathyGLib.Account
:storage-provider
property- Return type:
New in version 0.13.2.
- get_storage_restrictions()¶
- Returns:
the same as the
TelepathyGLib.Account
:storage-restrictions
property- Return type:
New in version 0.13.2.
- get_storage_specific_information_async(callback, *user_data)¶
- Parameters:
callback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- 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
GLib.HashTable.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
propertyNew in version 0.13.8.
- is_enabled()¶
- Returns:
the same as the
TelepathyGLib.Account
:enabled
property- Return type:
New in version 0.9.0.
- is_valid()¶
- Returns:
the same as the
TelepathyGLib.Account
:valid
property- Return type:
New in version 0.9.0.
- reconnect_async(callback, *user_data)¶
- Parameters:
callback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
Finishes an async reconnect of self.
New in version 0.9.0.
- remove_async(callback, *user_data)¶
- Parameters:
callback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 presencecallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 presencecallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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:
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 parametercallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
Finishes an async set of the ConnectAutomatically property.
New in version 0.9.0.
- set_display_name_async(display_name, callback, *user_data)¶
- Parameters:
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 selfcallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
Finishes an async set of the Enabled property.
New in version 0.9.0.
- set_icon_name_async(icon_name, callback, *user_data)¶
- Parameters:
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 setcallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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, orNone
or the empty string to unset the service name (which will result in theTelepathyGLib.Account
:service
property becoming the same asTelepathyGLib.Account
:protocol
)callback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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:
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
() orTelepathyGLib.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
) – aGio.AsyncResult
- Raises:
- Returns:
- Return type:
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 selfunset_parameters (
str
) – list of parameters to unset on selfcallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
True
if the request succeeded, otherwiseFalse
- reconnect_required:
a #GStrv to fill with properties that need a reconnect to take effect
- Return type:
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 selfunset_parameters ([
str
]) – list of parameters to unset on selfcallback (
Gio.AsyncReadyCallback
orNone
) – a callback to call when the request is satisfied
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
) – aGio.AsyncResult
- Raises:
- Returns:
True
if the request succeeded, otherwiseFalse
- reconnect_required:
a #GStrv to fill with properties that need a reconnect to take effect
- Return type:
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:
- 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:
- Parameters:
account (
TelepathyGLib.Account
) – The object which received the signalpresence (
int
) – the new presencestatus (
str
) – the new presence statusstatus_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:
- Parameters:
account (
TelepathyGLib.Account
) – The object which received the signalold_status (
int
) – oldTelepathyGLib.Account
:connection-status
new_status (
int
) – newTelepathyGLib.Account
:connection-status
reason (
int
) – theTelepathyGLib.Account
:connection-status-reason
dbus_error_name (
str
orNone
) – theTelepathyGLib.Account
:connection-error
details ({
str
:GObject.Value
}) – theTelepathyGLib.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¶
-
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 isTelepathyGLib.ConnectionPresenceType.UNSET
.New in version 0.13.8.
- TelepathyGLib.Account.props.automatic_status¶
-
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 isNone
.New in version 0.13.8.
- TelepathyGLib.Account.props.automatic_status_message¶
-
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 isNone
.New in version 0.13.8.
- TelepathyGLib.Account.props.changing_presence¶
-
True
if an attempt is currently being made to change the account’s presence (TelepathyGLib.Account
:current-presence-type
,TelepathyGLib.Account
:current-status
andTelepathyGLib.Account
:current-status-message
) to match its requested presence (TelepathyGLib.Account
:requested-presence-type
,TelepathyGLib.Account
:requested-status
andTelepathyGLib.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 isFalse
.New in version 0.11.6.
- TelepathyGLib.Account.props.cm_name¶
-
The account’s connection manager name.
New in version 0.19.3.
- TelepathyGLib.Account.props.connect_automatically¶
-
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 isFalse
.New in version 0.9.0.
- TelepathyGLib.Account.props.connection¶
- Name:
connection
- Type:
- Default Value:
- Flags:
The connection of the account, or
None
if account is offline. Note that the returnedTelepathyGLib.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 accountOne 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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.connection_error¶
-
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 theGObject.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 isNone
.New in version 0.11.7.
- TelepathyGLib.Account.props.connection_error_details¶
- Name:
connection-error-details
- Type:
- Default Value:
- Flags:
A map from string to
GObject.Value
containing extensible error details related toTelepathyGLib.Account
:connection-error
. Functions likeTelepathyGLib.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 toGLib.Error
.message.One can receive change notifications on this property by connecting to the
TelepathyGLib.Account
::status-changed
signal, or by connecting to theGObject.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¶
-
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¶
-
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 theGObject.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 isTelepathyGLib.ConnectionStatus.DISCONNECTED
.New in version 0.9.0.
- TelepathyGLib.Account.props.connection_status_reason¶
-
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 theGObject.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 isTelepathyGLib.ConnectionStatusReason.NONE_SPECIFIED
.New in version 0.9.0.
- TelepathyGLib.Account.props.current_presence_type¶
-
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 isTelepathyGLib.ConnectionPresenceType.UNSET
.New in version 0.9.0.
- TelepathyGLib.Account.props.current_status¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.current_status_message¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.display_name¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.enabled¶
-
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 isFalse
.New in version 0.9.0.
- TelepathyGLib.Account.props.has_been_online¶
-
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 isFalse
.New in version 0.9.0.
- TelepathyGLib.Account.props.icon_name¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.nickname¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.normalized_name¶
-
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 isNone
.New in version 0.13.8.
- TelepathyGLib.Account.props.protocol¶
-
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¶
-
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¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.requested_status¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.requested_status_message¶
-
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 isNone
.New in version 0.9.0.
- TelepathyGLib.Account.props.service¶
-
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:
- Default Value:
- Flags:
The storage identifier for this account.
A provider-specific variant type used to identify this account with the provider. This value will be
None
ifTelepathyGLib.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:
- Default Value:
- Flags:
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 aTelepathyGLib.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¶
-
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¶
-
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 ifTelepathyGLib.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¶
-
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¶
-
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¶
-
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 isFalse
.New in version 0.9.0.