TelepathyGLib.SimpleClientFactory¶
- Subclasses:
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/co |
The D-Bus daemon used by this object |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
Class Details¶
- class TelepathyGLib.SimpleClientFactory(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Data structure representing a
TelepathyGLib.SimpleClientFactoryNew in version 0.15.5.
- classmethod new(dbus)¶
- Parameters:
dbus (
TelepathyGLib.DBusDaemonorNone) – aTelepathyGLib.DBusDaemon, orNone- Returns:
- Return type:
Creates a new
TelepathyGLib.SimpleClientFactoryinstance. If dbus isNone,TelepathyGLib.DBusDaemon.dup() will be used.New in version 0.15.5.
- add_account_features(features)¶
- Parameters:
features ([
int] orNone) – an array of desired features, ending with 0;Noneis equivalent to an array containing only 0
Add features to the desired features to be prepared on
TelepathyGLib.Accountobjects. Those features will be added to the features already returned beTelepathyGLib.SimpleClientFactory.dup_account_features().It is not necessary to add %TP_ACCOUNT_FEATURE_CORE as it is already included by default.
Note that these features will not be added to existing
TelepathyGLib.Accountobjects; the user must callTelepathyGLib.Proxy.prepare_async() themself.New in version 0.15.5.
- add_channel_features(features)¶
- Parameters:
features ([
int] orNone) – an array of desired features, ending with 0;Noneis equivalent to an array containing only 0
Add features to the desired features to be prepared on
TelepathyGLib.Channelobjects. Those features will be added to the features already returned beTelepathyGLib.SimpleClientFactory.dup_channel_features().It is not necessary to add %TP_CHANNEL_FEATURE_CORE as it is already included by default.
Note that these features will not be added to existing
TelepathyGLib.Channelobjects; the user must callTelepathyGLib.Proxy.prepare_async() themself.New in version 0.15.5.
- add_connection_features(features)¶
- Parameters:
features ([
int] orNone) – an array of desired features, ending with 0;Noneis equivalent to an array containing only 0
Add features to the desired features to be prepared on
TelepathyGLib.Connectionobjects. Those features will be added to the features already returned beTelepathyGLib.SimpleClientFactory.dup_connection_features().It is not necessary to add %TP_CONNECTION_FEATURE_CORE as it is already included by default.
Note that these features will not be added to existing
TelepathyGLib.Connectionobjects; the user must callTelepathyGLib.Proxy.prepare_async() themself.New in version 0.15.5.
- add_contact_features(features)¶
- Parameters:
features ([
TelepathyGLib.ContactFeature] orNone) – an array of desired features (may beNoneif n_features is 0)
Add features to the desired features to be prepared on
TelepathyGLib.Contactobjects. Those features will be added to the features already returned beTelepathyGLib.SimpleClientFactory.dup_contact_features().Note that these features will not be added to existing
TelepathyGLib.Contactobjects; the user must callTelepathyGLib.Connection.upgrade_contacts() themself.New in version 0.15.5.
- dup_account_features(account)¶
- Parameters:
account (
TelepathyGLib.Account) – aTelepathyGLib.Account- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Accountfeatures that should be prepared on account.New in version 0.15.5.
- dup_channel_features(channel)¶
- Parameters:
channel (
TelepathyGLib.Channel) – aTelepathyGLib.Channel- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Channelfeatures that should be prepared on channel.New in version 0.15.5.
- dup_connection_features(connection)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.Connection- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Connectionfeatures that should be prepared on connection.New in version 0.15.5.
- dup_contact_features(connection)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.Connection- Returns:
a newly allocated
GLib.Array- Return type:
Return a
GLib.Arraycontaining theTelepathyGLib.ContactFeaturethat should be prepared on all contacts of connection.New in version 0.15.5.
- ensure_account(object_path, immutable_properties)¶
- Parameters:
object_path (
str) – the object path of an accountimmutable_properties ({
str:GObject.Value}) – the immutable properties of the account, orNone.
- Raises:
- Returns:
a reference to a
TelepathyGLib.Account; seeTelepathyGLib.Account.new().- Return type:
Returns a
TelepathyGLib.Accountproxy for the account at object_path. The returnedTelepathyGLib.Accountis cached; the sameTelepathyGLib.Accountobject will be returned by this function repeatedly, as long as at least one reference exists.Note that the returned
TelepathyGLib.Accountis not guaranteed to be ready; the caller is responsible for callingTelepathyGLib.Proxy.prepare_async() with the desired features (as given byTelepathyGLib.SimpleClientFactory.dup_account_features()).This function is rather low-level.
TelepathyGLib.AccountManager.dup_valid_accounts() andTelepathyGLib.AccountManager::validity-changedare more appropriate for most applications.New in version 0.15.5.
- ensure_channel(connection, object_path, immutable_properties)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.ConnectionwhoseTelepathyGLib.Proxy:factoryis this objectobject_path (
str) – the object path of a channel on connectionimmutable_properties ({
str:GObject.Value}) – the immutable properties of the channel
- Raises:
- Returns:
a reference to a
TelepathyGLib.Channel; seeTelepathyGLib.Channel.new_from_properties().- Return type:
Returns a
TelepathyGLib.Channelproxy for the channel at object_path on connection. The returnedTelepathyGLib.Channelis cached; the sameTelepathyGLib.Channelobject will be returned by this function repeatedly, as long as at least one reference exists.Note that the returned
TelepathyGLib.Channelis not guaranteed to be ready; the caller is responsible for callingTelepathyGLib.Proxy.prepare_async() with the desired features (as given byTelepathyGLib.SimpleClientFactory.dup_channel_features()).This function is rather low-level.
TelepathyGLib.AccountChannelRequestandTelepathyGLib.BaseClientare more appropriate ways to obtain channels for most applications.New in version 0.15.5.
- ensure_connection(object_path, immutable_properties)¶
- Parameters:
object_path (
str) – the object path of a connectionimmutable_properties ({
str:GObject.Value}) – the immutable properties of the connection.
- Raises:
- Returns:
a reference to a
TelepathyGLib.Connection; seeTelepathyGLib.Connection.new().- Return type:
Returns a
TelepathyGLib.Connectionproxy for the connection at object_path. The returnedTelepathyGLib.Connectionis cached; the sameTelepathyGLib.Connectionobject will be returned by this function repeatedly, as long as at least one reference exists.Note that the returned
TelepathyGLib.Connectionis not guaranteed to be ready; the caller is responsible for callingTelepathyGLib.Proxy.prepare_async() with the desired features (as given byTelepathyGLib.SimpleClientFactory.dup_connection_features()).This function is rather low-level.
TelepathyGLib.Account:connectionis more appropriate for most applications.New in version 0.15.5.
- ensure_contact(connection, handle, identifier)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.ConnectionwhoseTelepathyGLib.Proxy:factoryis this objecthandle (
int) – a #TpHandleidentifier (
str) – a string representing the contact’s identifier
- Returns:
a reference to a
TelepathyGLib.Contact.- Return type:
Returns a
TelepathyGLib.Contactrepresenting identifier (and handle) on connection. The returnedTelepathyGLib.Contactis cached; the sameTelepathyGLib.Contactobject will be returned by this function repeatedly, as long as at least one reference exists.Note that the returned
TelepathyGLib.Contactis not guaranteed to be ready; the caller is responsible for callingTelepathyGLib.Connection.upgrade_contacts() with the desired features (as given byTelepathyGLib.SimpleClientFactory.dup_contact_features()).For this function to work properly,
TelepathyGLib.Connection.has_immortal_handles() must returnTruefor connection.New in version 0.15.5.
- ensure_contact_by_id_async(connection, identifier, callback, *user_data)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.Connectionidentifier (
str) – a string representing the contact’s identifiercallback (
Gio.AsyncReadyCallbackorNone) – a callback to call when the operation finishes
Same as
TelepathyGLib.Connection.dup_contact_by_id_async(), but prepare the contact with all features previously passed toTelepathyGLib.SimpleClientFactory.add_contact_features().New in version 0.19.1.
- ensure_contact_by_id_finish(result)¶
- Parameters:
result (
Gio.AsyncResult) – aGio.AsyncResult- Raises:
- Returns:
a
TelepathyGLib.ContactorNoneon error.- Return type:
Finishes
TelepathyGLib.SimpleClientFactory.ensure_contact_by_id_async()New in version 0.19.1.
- get_dbus_daemon()¶
- Returns:
the value of the
TelepathyGLib.SimpleClientFactory:dbus-daemonproperty- Return type:
New in version 0.15.5.
- upgrade_contacts_async(connection, contacts, callback, *user_data)¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.ConnectionwhoseTelepathyGLib.Proxy:factoryis this objectcontacts ([
TelepathyGLib.Contact]) – An array ofTelepathyGLib.Contactobjects associated with selfcallback (
Gio.AsyncReadyCallbackorNone) – a callback to call when the operation finishes
Same as
TelepathyGLib.Connection.upgrade_contacts_async(), but prepare contacts with all features previously passed toTelepathyGLib.SimpleClientFactory.add_contact_features().New in version 0.19.1.
- upgrade_contacts_finish(result)¶
- Parameters:
result (
Gio.AsyncResult) – aGio.AsyncResult- Raises:
- Returns:
Trueon success,Falseotherwise.- contacts:
a location to set a
GLib.PtrArrayof upgradedTelepathyGLib.Contact, orNone.
- Return type:
(
bool, contacts: [TelepathyGLib.Contact])
Finishes
TelepathyGLib.SimpleClientFactory.upgrade_contacts_async()New in version 0.19.1.
- do_dup_account_features(account) virtual¶
- Parameters:
account (
TelepathyGLib.Account) – aTelepathyGLib.Account- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Accountfeatures that should be prepared on account.New in version 0.15.5.
- do_dup_channel_features(channel) virtual¶
- Parameters:
channel (
TelepathyGLib.Channel) – aTelepathyGLib.Channel- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Channelfeatures that should be prepared on channel.New in version 0.15.5.
- do_dup_connection_features(connection) virtual¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.Connection- Returns:
a newly allocated
GLib.Array- Return type:
[
int]
Return a zero-terminated
GLib.Arraycontaining theTelepathyGLib.Connectionfeatures that should be prepared on connection.New in version 0.15.5.
- do_dup_contact_features(connection) virtual¶
- Parameters:
connection (
TelepathyGLib.Connection) – aTelepathyGLib.Connection- Returns:
a newly allocated
GLib.Array- Return type:
Return a
GLib.Arraycontaining theTelepathyGLib.ContactFeaturethat should be prepared on all contacts of connection.New in version 0.15.5.
Property Details¶
- TelepathyGLib.SimpleClientFactory.props.dbus_daemon¶
- Name:
dbus-daemon- Type:
- Default Value:
- Flags:
The D-Bus daemon for this object.