FolksAliasDetails

FolksAliasDetails — Interface for classes which represent aliasable contacts, such as FolksPersona and FolksIndividual.

Synopsis

void                folks_alias_details_change_alias    (FolksAliasDetails *self,
                                                         const gchar *alias,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);
void                folks_alias_details_change_alias_finish
                                                        (FolksAliasDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);
const gchar *       folks_alias_details_get_alias       (FolksAliasDetails *self);
void                folks_alias_details_set_alias       (FolksAliasDetails *self,
                                                         const gchar *value);
                    FolksAliasDetails;

Object Hierarchy

  GInterface
   +----FolksAliasDetails

Prerequisites

FolksAliasDetails requires GObject.

Known Implementations

FolksAliasDetails is implemented by FolksIndividual.

Properties

  "alias"                    gchar*                : Read / Write

Description

Details

folks_alias_details_change_alias ()

void                folks_alias_details_change_alias    (FolksAliasDetails *self,
                                                         const gchar *alias,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change the contact's alias.

It's preferred to call this rather than setting "alias" directly, as this method gives error notification and will only return once the alias has been written to the relevant backing store (or the operation's failed).

See also: folks_alias_details_change_alias_finish()

self :

the FolksAliasDetails instance

alias :

the new alias. [in]

_callback_ :

callback to call when the request is satisfied. [scope async]

_user_data_ :

the data to pass to _callback_ function. [closure]

Since 0.6.2


folks_alias_details_change_alias_finish ()

void                folks_alias_details_change_alias_finish
                                                        (FolksAliasDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change the contact's alias.

It's preferred to call this rather than setting "alias" directly, as this method gives error notification and will only return once the alias has been written to the relevant backing store (or the operation's failed).

See also: folks_alias_details_change_alias()

self :

the FolksAliasDetails instance

_res_ :

a GAsyncResult

error :

location to store the error occuring, or NULL to ignore. [error-domains FolksPropertyError]

Since 0.6.2


folks_alias_details_get_alias ()

const gchar *       folks_alias_details_get_alias       (FolksAliasDetails *self);

self :

the FolksAliasDetails instance to query

Returns :

the value of the "alias" property

folks_alias_details_set_alias ()

void                folks_alias_details_set_alias       (FolksAliasDetails *self,
                                                         const gchar *value);

self :

the FolksAliasDetails instance to modify

value :

the new value of the "alias" property

FolksAliasDetails

typedef struct _FolksAliasDetails FolksAliasDetails;

Interface for classes which represent aliasable contacts, such as FolksPersona and FolksIndividual.

Property Details

The "alias" property

  "alias"                    gchar*                : Read / Write

An alias for the contact.

An alias is a user-given name, to be used in UIs as the sole way to represent the contact to the user.

This may not be `null`: an empty string represents an unset alias.

Default value: NULL