struct TpAccountRequest

struct TpAccountRequest;

An object for representing a currently non-existent account which is to be created on a TpAccountManager.

Since 0.19.1

struct TpAccountRequestClass

struct TpAccountRequestClass {
};

The class of a TpAccountRequest.

tp_account_request_new ()

TpAccountRequest *  tp_account_request_new              (TpAccountManager *account_manager,
                                                         const gchar *manager,
                                                         const gchar *protocol,
                                                         const gchar *display_name);

Convenience function to create a new account request object which will assist in the creation of a new account on account_manager, using connection manager manager, and protocol protocol.

Since 0.19.1

tp_account_request_new_from_protocol ()

TpAccountRequest *  tp_account_request_new_from_protocol
                                                        (TpAccountManager *account_manager,
                                                         TpProtocol *protocol,
                                                         const gchar *display_name);

Convenience function to create a new TpAccountRequest object using a TpProtocol instance, instead of specifying connection manager and protocol name specifically. See tp_account_request_new() for more details.

Since 0.19.1

tp_account_request_set_display_name ()

void                tp_account_request_set_display_name (TpAccountRequest *self,
                                                         const gchar *name);

Set the display name for the new account, self, to name. Use the "display-name" property to read the current display name.

Since 0.19.1

tp_account_request_set_icon_name ()

void                tp_account_request_set_icon_name    (TpAccountRequest *self,
                                                         const gchar *icon);

Set the icon name for the new account, self, to icon. Use the "icon-name" property to read the current icon name.

Since 0.19.1

tp_account_request_set_nickname ()

void                tp_account_request_set_nickname     (TpAccountRequest *self,
                                                         const gchar *nickname);

Set the nickname for the new account, self, to nickname. Use the "nickname" property to read the current nickname.

Since 0.19.1

tp_account_request_set_requested_presence ()

void                tp_account_request_set_requested_presence
                                                        (TpAccountRequest *self,
                                                         TpConnectionPresenceType presence,
                                                         const gchar *status,
                                                         const gchar *message);

Set the requested presence for the new account, self, to the type (presence, status), with message message. Use the "requested-presence-type", "requested-status", and "requested-status-message" properties to read the current requested presence.

Since 0.19.1

tp_account_request_set_automatic_presence ()

void                tp_account_request_set_automatic_presence
                                                        (TpAccountRequest *self,
                                                         TpConnectionPresenceType presence,
                                                         const gchar *status,
                                                         const gchar *message);

Set the automatic presence for the new account, self, to the type (presence, status), with message message. Use the "automatic-presence-type", "automatic-status", and "automatic-status-message" properties to read the current automatic presence.

Since 0.19.1

tp_account_request_set_enabled ()

void                tp_account_request_set_enabled      (TpAccountRequest *self,
                                                         gboolean enabled);

Set the enabled property of the account on creation to enabled. Use the "enabled" property to read the current enabled value.

Since 0.19.1

tp_account_request_set_connect_automatically ()

void                tp_account_request_set_connect_automatically
                                                        (TpAccountRequest *self,
                                                         gboolean connect_automatically);

Set the connect automatically property of the account on creation to connect_automatically so that the account is brought online to the automatic presence. Use the "connect-automatically" property to read the current connect automatically value.

Since 0.19.1

tp_account_request_add_supersedes ()

void                tp_account_request_add_supersedes   (TpAccountRequest *self,
                                                         const gchar *superseded_path);

Add an account object path to the list of superseded accounts which this new account will supersede. Use the "supersedes" property to read the current list of superseded accounts.

Since 0.19.1

tp_account_request_set_avatar ()

void                tp_account_request_set_avatar       (TpAccountRequest *self,
                                                         const guchar *avatar,
                                                         gsize len,
                                                         const gchar *mime_type);

Set the avatar of the account self to avatar. Use the "avatar" and "avatar-mime-type" properties to read the current avatar.

Since 0.19.1

tp_account_request_set_service ()

void                tp_account_request_set_service      (TpAccountRequest *self,
                                                         const gchar *service);

Set the service property of the account to service. Use the "service" property to read the current value.

Since 0.19.1

tp_account_request_set_storage_provider ()

void                tp_account_request_set_storage_provider
                                                        (TpAccountRequest *self,
                                                         const gchar *provider);

Set the account storage to use when creating the account. Use the "storage-provider" property to read the current value.

Since 0.19.4

tp_account_request_set_parameter ()

void                tp_account_request_set_parameter    (TpAccountRequest *self,
                                                         const gchar *key,
                                                         GVariant *value);

Set an account parameter, key, to value. Use the "parameters" property to read the current list of set parameters.

Parameters can be unset using tp_account_request_unset_parameter().

Since 0.19.1

tp_account_request_set_parameter_string ()

void                tp_account_request_set_parameter_string
                                                        (TpAccountRequest *self,
                                                         const gchar *key,
                                                         const gchar *value);

Convenience function to set an account parameter string value. See tp_account_request_set_parameter() for more details.

Since 0.19.1

tp_account_request_unset_parameter ()

void                tp_account_request_unset_parameter  (TpAccountRequest *self,
                                                         const gchar *key);

Unset the account parameter key which has previously been set using tp_account_request_set_parameter() or another convenience function.

Since 0.19.1

tp_account_request_create_account_async ()

void                tp_account_request_create_account_async
                                                        (TpAccountRequest *self,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Start an asynchronous operation to create the account self on the account manager.

callback will only be called when the newly created TpAccount has the TP_ACCOUNT_FEATURE_CORE feature ready on it, so when calling tp_account_request_create_account_finish(), one can guarantee this feature.

Since 0.19.1

tp_account_request_create_account_finish ()

TpAccount *         tp_account_request_create_account_finish
                                                        (TpAccountRequest *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes an asynchronous account creation operation and returns a new ref to a TpAccount object. The returned account will have the features listed in tp_simple_client_factory_dup_account_features() (with the proxy factory from "account-manager") prepared on it.

Since 0.19.1

The "account-manager" property

  "account-manager"          TpAccountManager*     : Read / Write / Construct Only

The TpAccountManager to create the account on.

Since 0.19.1

The "automatic-presence-type" property

  "automatic-presence-type"  guint                 : Read

The account's automatic presence type (a TpConnectionPresenceType). To change this property use tp_account_request_set_automatic_presence().

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.

Allowed values: <= 9

Default value: 0

Since 0.19.1

The "automatic-status" property

  "automatic-status"         gchar*                : Read

The string status name to use in conjunction with the "automatic-presence-type". To change this property use tp_account_request_set_automatic_presence().

Default value: NULL

Since 0.19.1

The "automatic-status-message" property

  "automatic-status-message" gchar*                : Read

The user-defined message to use in conjunction with the "automatic-presence-type". To change this property use tp_account_request_set_automatic_presence().

Default value: NULL

Since 0.19.1

The "avatar" property

  "avatar"                   GArray*               : Read

The avatar set on the account. The avatar's mime type can be read in the "avatar-mime-type" property. To change this property, use tp_account_request_set_avatar().

Since 0.19.1

The "avatar-mime-type" property

  "avatar-mime-type"         gchar*                : Read

The mime type of the "avatar" property. To change this property, use tp_account_request_set_avatar().

Default value: NULL

Since 0.19.1

The "connect-automatically" property

  "connect-automatically"    gboolean              : Read

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

Default value: FALSE

Since 0.19.1

The "connection-manager" property

  "connection-manager"       gchar*                : Read / Write / Construct Only

The account's connection manager name.

Default value: NULL

Since 0.19.1

The "display-name" property

  "display-name"             gchar*                : Read / Write / Construct Only

The account's display name. To change this property use tp_account_request_set_display_name().

Default value: NULL

Since 0.19.1

The "enabled" property

  "enabled"                  gboolean              : Read

Whether the account is enabled or not. To change this property use tp_account_request_set_enabled().

Default value: FALSE

Since 0.19.1

The "icon-name" property

  "icon-name"                gchar*                : Read

The account's icon name. To change this propery, use tp_account_request_set_icon_name().

Default value: NULL

Since 0.19.1

The "nickname" property

  "nickname"                 gchar*                : Read

The account's nickname. To change this property use tp_account_request_set_nickname().

Default value: NULL

Since 0.19.1

The "parameters" property

  "parameters"               GVariant*             : Read

The account's connection parameters. To add a parameter, use tp_account_request_set_parameter() or another convience function.

Allowed values: GVariant<a{sv}>

Default value: NULL

Since 0.19.1

The "properties" property

  "properties"               GVariant*             : Read

The account's properties.

Allowed values: GVariant<a{sv}>

Default value: NULL

Since 0.19.1

The "protocol" property

  "protocol"                 gchar*                : Read / Write / Construct Only

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.

Default value: NULL

Since 0.19.1

The "requested-presence-type" property

  "requested-presence-type"  guint                 : Read

The account's requested presence type (a TpConnectionPresenceType). To change this property use tp_account_request_set_requested_presence().

Allowed values: <= 9

Default value: 0

Since 0.19.1

The "requested-status" property

  "requested-status"         gchar*                : Read

The requested Status string of the account. To change this property use tp_account_request_set_requested_presence().

Default value: NULL

Since 0.19.1

The "requested-status-message" property

  "requested-status-message" gchar*                : Read

The requested status message message of the account. To change this property use tp_account_request_set_requested_presence().

Default value: NULL

Since 0.19.1

The "service" property

  "service"                  gchar*                : Read

A string describing the service of the account, which must consist only of ASCII letters, numbers and hyphen/minus signs, and start with a letter (matching the requirements for Protocol). To change this property, use tp_account_request_set_service().

Default value: NULL

Since 0.19.1

The "storage-provider" property

  "storage-provider"         gchar*                : Read

The account's storage provider. To change this property use tp_account_request_set_storage_provider().

Default value: NULL

Since 0.19.4

The "supersedes" property

  "supersedes"               GStrv                 : Read

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.

To add to this property use tp_account_request_add_supersedes().

Since 0.19.1