tp_client_factory_new ()

TpClientFactory *
tp_client_factory_new (GDBusConnection *dbus_connection);

Creates a new TpClientFactory instance.

Since 0.99.1

tp_client_factory_dup ()

TpClientFactory *
tp_client_factory_dup (GError **error);

Get a reference to a TpClientFactory singleton. It can fail and block only if the session GDBusConnection singleton doesn't exist yet. It is thus recommended to call g_bus_get() before using a TpClientFactory if the application must not block.

By default it will create a TpAutomaticClientFactory.

Since 0.99.10

tp_client_factory_set_default ()

void
tp_client_factory_set_default (TpClientFactory *self);

Define the TpClientFactory singleton that will be returned by tp_client_factory_dup().

This function may only be called before the first call to tp_client_factory_dup(), and may not be called more than once. Applications which use a custom TpClientFactory and want it to be the default factory should call this.

Only a weak reference is taken on self . It is the caller's responsibility to keep it alive. If self is disposed after calling this function, the next call to tp_client_factory_dup() will return a newly created TpClientFactory.

Since 0.99.10

tp_client_factory_can_set_default ()

gboolean
tp_client_factory_can_set_default (void);

Check if tp_client_factory_set_default() has already successfully been called.

Since 0.99.10

tp_client_factory_get_dbus_connection ()

GDBusConnection *
tp_client_factory_get_dbus_connection (TpClientFactory *self);

Since 0.99.10

tp_client_factory_ensure_account_manager ()

TpAccountManager *
tp_client_factory_ensure_account_manager
                               (TpClientFactory *self);

Since 0.99.10

tp_client_factory_ensure_channel_dispatcher ()

TpChannelDispatcher *
tp_client_factory_ensure_channel_dispatcher
                               (TpClientFactory *self);

Since 0.99.10

tp_client_factory_ensure_logger ()

TpLogger *
tp_client_factory_ensure_logger (TpClientFactory *self);

Since 0.99.10

tp_client_factory_ensure_account ()

TpAccount *
tp_client_factory_ensure_account (TpClientFactory *self,
                                  const gchar *object_path,
                                  GVariant *immutable_properties,
                                  GError **error);

Returns a TpAccount proxy for the account at object_path . The returned TpAccount is cached; the same TpAccount object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpAccount is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features (as given by tp_client_factory_dup_account_features()).

This function is rather low-level. tp_account_manager_dup_usable_accounts() and “usability-changed” are more appropriate for most applications.

immutable_properties is consumed if it is floating.

Since 0.99.1

tp_client_factory_dup_account_features ()

GArray *
tp_client_factory_dup_account_features
                               (TpClientFactory *self,
                                TpAccount *account);

Return a zero-terminated GArray containing the TpAccount features that should be prepared on account .

Since 0.99.1

tp_client_factory_add_account_features ()

void
tp_client_factory_add_account_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpAccount objects. Those features will be added to the features already returned be tp_client_factory_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 TpAccount objects; the user must call tp_proxy_prepare_async() themself.

Since 0.99.1

tp_client_factory_add_account_features_varargs ()

void
tp_client_factory_add_account_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_account_features(), but with a more convenient calling convention from C.

Since 0.99.1

tp_client_factory_ensure_connection ()

TpConnection *
tp_client_factory_ensure_connection (TpClientFactory *self,
                                     const gchar *object_path,
                                     GVariant *immutable_properties,
                                     GError **error);

Returns a TpConnection proxy for the connection at object_path . The returned TpConnection is cached; the same TpConnection object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpConnection is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features (as given by tp_client_factory_dup_connection_features()).

This function is rather low-level. “connection” is more appropriate for most applications.

immutable_properties is consumed if it is floating.

Since 0.99.1

tp_client_factory_dup_connection_features ()

GArray *
tp_client_factory_dup_connection_features
                               (TpClientFactory *self,
                                TpConnection *connection);

Return a zero-terminated GArray containing the TpConnection features that should be prepared on connection .

Since 0.99.1

tp_client_factory_add_connection_features ()

void
tp_client_factory_add_connection_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpConnection objects. Those features will be added to the features already returned be tp_client_factory_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 TpConnection objects; the user must call tp_proxy_prepare_async() themself.

Since 0.99.1

tp_client_factory_add_connection_features_varargs ()

void
tp_client_factory_add_connection_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_connection_features(), but with a more convenient calling convention from C.

Since 0.99.1

tp_client_factory_ensure_channel ()

TpChannel *
tp_client_factory_ensure_channel (TpClientFactory *self,
                                  TpConnection *connection,
                                  const gchar *object_path,
                                  GVariant *immutable_properties,
                                  GError **error);

Returns a TpChannel proxy for the channel at object_path on connection . The returned TpChannel is cached; the same TpChannel object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpChannel is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features (as given by tp_client_factory_dup_channel_features()).

This function is rather low-level. TpAccountChannelRequest and TpBaseClient are more appropriate ways to obtain channels for most applications.

immutable_properties is consumed if it is floating.

Since 0.99.1

tp_client_factory_dup_channel_features ()

GArray *
tp_client_factory_dup_channel_features
                               (TpClientFactory *self,
                                TpChannel *channel);

Return a zero-terminated GArray containing the TpChannel features that should be prepared on channel .

Since 0.99.1

tp_client_factory_add_channel_features ()

void
tp_client_factory_add_channel_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpChannel objects. Those features will be added to the features already returned be tp_client_factory_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 TpChannel objects; the user must call tp_proxy_prepare_async() themself.

Since 0.99.1

tp_client_factory_add_channel_features_varargs ()

void
tp_client_factory_add_channel_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_channel_features(), but with a more convenient calling convention from C.

Since 0.99.1

tp_client_factory_ensure_contact ()

TpContact *
tp_client_factory_ensure_contact (TpClientFactory *self,
                                  TpConnection *connection,
                                  TpHandle handle,
                                  const gchar *identifier);

Returns a TpContact representing identifier (and handle ) on connection . The returned TpContact is cached; the same TpContact object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpContact is not guaranteed to be ready; the caller is responsible for calling tp_connection_upgrade_contacts() with the desired features (as given by tp_client_factory_dup_contact_features()).

Since 0.99.1

tp_client_factory_upgrade_contacts_async ()

void
tp_client_factory_upgrade_contacts_async
                               (TpClientFactory *self,
                                TpConnection *connection,
                                guint n_contacts,
                                TpContact * const *contacts,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Same as tp_connection_upgrade_contacts_async(), but prepare contacts with all features previously passed to tp_client_factory_add_contact_features().

Since 0.19.1

tp_client_factory_upgrade_contacts_finish ()

gboolean
tp_client_factory_upgrade_contacts_finish
                               (TpClientFactory *self,
                                GAsyncResult *result,
                                GPtrArray **contacts,
                                GError **error);

Finishes tp_client_factory_upgrade_contacts_async()

Since 0.19.1

tp_client_factory_ensure_contact_by_id_async ()

void
tp_client_factory_ensure_contact_by_id_async
                               (TpClientFactory *self,
                                TpConnection *connection,
                                const gchar *identifier,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Same as tp_connection_dup_contact_by_id_async(), but prepare the contact with all features previously passed to tp_client_factory_add_contact_features().

Since 0.19.1

tp_client_factory_ensure_contact_by_id_finish ()

TpContact *
tp_client_factory_ensure_contact_by_id_finish
                               (TpClientFactory *self,
                                GAsyncResult *result,
                                GError **error);

Finishes tp_client_factory_ensure_contact_by_id_async()

Since 0.19.1

tp_client_factory_dup_contact_features ()

GArray *
tp_client_factory_dup_contact_features
                               (TpClientFactory *self,
                                TpConnection *connection);

Return a GArray containing the contact feature GQuarks that should be prepared on all contacts of connection .

Since 0.99.1

tp_client_factory_add_contact_features ()

void
tp_client_factory_add_contact_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpContact objects. Those features will be added to the features already returned be tp_client_factory_dup_contact_features().

Note that these features will not be added to existing TpContact objects; the user must call tp_connection_upgrade_contacts() themself.

Since 0.99.1

tp_client_factory_add_contact_features_varargs ()

void
tp_client_factory_add_contact_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_contact_features(), but with a more convenient calling convention from C.

Since 0.99.1

tp_client_factory_ensure_protocol ()

TpProtocol *
tp_client_factory_ensure_protocol (TpClientFactory *self,
                                   const gchar *cm_name,
                                   const gchar *protocol_name,
                                   GVariant *immutable_properties,
                                   GError **error);

Returns a TpProtocol proxy for the protocol protocol_name on connection manager cm_name . The returned TpProtocol is cached; the same TpProtocol object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpProtocol is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features (as given by tp_client_factory_dup_protocol_features()).

immutable_properties is consumed if it is floating.

Since 0.99.8

tp_client_factory_dup_protocol_features ()

GArray *
tp_client_factory_dup_protocol_features
                               (TpClientFactory *self,
                                TpProtocol *protocol);

Return a zero-terminated GArray containing the TpProtocol features that should be prepared on protocol .

Since 0.99.8

tp_client_factory_add_protocol_features ()

void
tp_client_factory_add_protocol_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpProtocol objects. Those features will be added to the features already returned be tp_client_factory_dup_protocol_features().

It is not necessary to add TP_PROTOCOL_FEATURE_CORE as it is already included by default.

Note that these features will not be added to existing TpProtocol objects; the user must call tp_proxy_prepare_async() themself.

Since 0.99.8

tp_client_factory_add_protocol_features_varargs ()

void
tp_client_factory_add_protocol_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_protocol_features(), but with a more convenient calling convention from C.

Since 0.99.8

tp_client_factory_ensure_tls_certificate ()

TpTLSCertificate *
tp_client_factory_ensure_tls_certificate
                               (TpClientFactory *self,
                                TpProxy *conn_or_chan,
                                const gchar *object_path,
                                GError **error);

Returns a TpTLSCertificate proxy for the channel or connection conn_or_chan . The returned TpTLSCertificate is cached; the same TpTLSCertificate object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpTLSCertificate is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features (as given by tp_client_factory_dup_tls_certificate_features()).

Since 0.99.8

tp_client_factory_add_tls_certificate_features ()

void
tp_client_factory_add_tls_certificate_features
                               (TpClientFactory *self,
                                const GQuark *features);

Add features to the desired features to be prepared on TpTLSCertificate objects. Those features will be added to the features already returned be tp_client_factory_dup_tls_certificate_features().

It is not necessary to add TP_TLS_CERTIFICATE_FEATURE_CORE as it is already included by default.

Note that these features will not be added to existing TpTLSCertificate objects; the user must call tp_proxy_prepare_async() themself.

Since 0.99.8

tp_client_factory_add_tls_certificate_features_varargs ()

void
tp_client_factory_add_tls_certificate_features_varargs
                               (TpClientFactory *self,
                                GQuark feature,
                                ...);

The same as tp_client_factory_add_tls_certificate_features(), but with a more convenient calling convention from C.

Since 0.99.8

tp_client_factory_dup_tls_certificate_features ()

GArray *
tp_client_factory_dup_tls_certificate_features
                               (TpClientFactory *self,
                                TpTLSCertificate *certificate);

Return a zero-terminated GArray containing the TpTLSCertificate features that should be prepared on protocol .

Since 0.99.8

tp_client_factory_ensure_debug_client ()

TpDebugClient *
tp_client_factory_ensure_debug_client (TpClientFactory *self,
                                       const gchar *unique_name,
                                       GError **error);

The returned TpDebugClient is cached; the same TpDebugClient object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpDebugClient is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features.

Since 0.99.10

tp_client_factory_ensure_connection_manager ()

TpConnectionManager *
tp_client_factory_ensure_connection_manager
                               (TpClientFactory *self,
                                const gchar *name,
                                const gchar *manager_filename,
                                GError **error);

The returned TpConnectionManager is cached; the same TpConnectionManager object will be returned by this function repeatedly, as long as at least one reference exists.

Note that the returned TpConnectionManager is not guaranteed to be ready; the caller is responsible for calling tp_proxy_prepare_async() with the desired features.

Since 0.99.10

TpClientFactory

typedef struct _TpClientFactory TpClientFactory;

Data structure representing a TpClientFactory

Since 0.99.1

struct TpClientFactoryClass

struct TpClientFactoryClass {
    GObjectClass parent_class;

    /* TpAccount */
    TpAccount * (*create_account) (TpClientFactory *self,
        const gchar *object_path,
        GVariant *immutable_properties,
        GError **error);
    GArray * (*dup_account_features) (TpClientFactory *self,
        TpAccount *account);

    /* TpConnection */
    TpConnection * (*create_connection) (TpClientFactory *self,
        const gchar *object_path,
        GVariant *immutable_properties,
        GError **error);
    GArray * (*dup_connection_features) (TpClientFactory *self,
        TpConnection *connection);

    /* TpChannel */
    TpChannel * (*create_channel) (TpClientFactory *self,
        TpConnection *conn,
        const gchar *object_path,
        GVariant *immutable_properties,
        GError **error);
    GArray * (*dup_channel_features) (TpClientFactory *self,
        TpChannel *channel);

    /* TpContact */
    TpContact * (*create_contact) (TpClientFactory *self,
        TpConnection *connection,
        TpHandle handle,
        const gchar *identifier);
    GArray * (*dup_contact_features) (TpClientFactory *self,
        TpConnection *connection);

    /* TpProcotol */
    TpProtocol * (*create_protocol) (TpClientFactory *self,
        const gchar *cm_name,
        const gchar *protocol_name,
        GVariant *immutable_properties,
        GError **error);
    GArray * (*dup_protocol_features) (TpClientFactory *self,
        TpProtocol *protocol);

    /* TpTLSCertificate */
    TpTLSCertificate * (*create_tls_certificate) (TpClientFactory *self,
        TpProxy *conn_or_chan,
        const gchar *object_path,
        GError **error);
    GArray * (*dup_tls_certificate_features) (TpClientFactory *self,
        TpTLSCertificate *certificate);
};

The class structure for TpClientFactory.

TpClientFactory maintains a cache of previously-constructed proxy objects, so the implementations of create_account , create_connection , create_channel , create_contact and create_protocol may assume that a new object should be created when they are called. The default implementations create unadorned instances of the relevant classes; subclasses of the factory may choose to create more interesting proxy subclasses.

The default implementation of dup_channel_features returns TP_CHANNEL_FEATURE_CORE, plus all features passed to tp_client_factory_add_channel_features() by the application. Subclasses may override this method to prepare more interesting features from subclasses of TpChannel, for instance. The default implementations of the other dup_x_features methods behave similarly.

Since 0.99.1

The “dbus-connection” property

  “dbus-connection”          GDBusConnection *

The D-Bus connection for this object.

Flags: Read / Write / Construct Only