FolksFavouriteDetails

FolksFavouriteDetails — Interface exposing a FolksPersona's or FolksIndividual's user-defined status as a favourite.

Synopsis

void                folks_favourite_details_change_is_favourite
                                                        (FolksFavouriteDetails *self,
                                                         gboolean is_favourite,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);
void                folks_favourite_details_change_is_favourite_finish
                                                        (FolksFavouriteDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);
gboolean            folks_favourite_details_get_is_favourite
                                                        (FolksFavouriteDetails *self);
void                folks_favourite_details_set_is_favourite
                                                        (FolksFavouriteDetails *self,
                                                         gboolean value);
                    FolksFavouriteDetails;

Object Hierarchy

  GInterface
   +----FolksFavouriteDetails

Prerequisites

FolksFavouriteDetails requires GObject.

Known Implementations

FolksFavouriteDetails is implemented by FolksIndividual.

Properties

  "is-favourite"             gboolean              : Read / Write

Description

Details

folks_favourite_details_change_is_favourite ()

void                folks_favourite_details_change_is_favourite
                                                        (FolksFavouriteDetails *self,
                                                         gboolean is_favourite,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change whether the contact is a user-defined favourite.

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

See also: folks_favourite_details_change_is_favourite_finish()

self :

the FolksFavouriteDetails instance

is_favourite :

`true` if the contact is a favourite; `false` otherwise. [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_favourite_details_change_is_favourite_finish ()

void                folks_favourite_details_change_is_favourite_finish
                                                        (FolksFavouriteDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change whether the contact is a user-defined favourite.

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

See also: folks_favourite_details_change_is_favourite()

self :

the FolksFavouriteDetails instance

_res_ :

a GAsyncResult

error :

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

Since 0.6.2


folks_favourite_details_get_is_favourite ()

gboolean            folks_favourite_details_get_is_favourite
                                                        (FolksFavouriteDetails *self);

self :

the FolksFavouriteDetails instance to query

Returns :

the value of the "is-favourite" property

folks_favourite_details_set_is_favourite ()

void                folks_favourite_details_set_is_favourite
                                                        (FolksFavouriteDetails *self,
                                                         gboolean value);

self :

the FolksFavouriteDetails instance to modify

value :

the new value of the "is-favourite" property

FolksFavouriteDetails

typedef struct _FolksFavouriteDetails FolksFavouriteDetails;

Interface exposing a FolksPersona's or FolksIndividual's user-defined status as a favourite.

Property Details

The "is-favourite" property

  "is-favourite"             gboolean              : Read / Write

Whether this contact is a user-defined favourite.

Default value: FALSE