FOLKS_TYPE_ROLE

#define FOLKS_TYPE_ROLE (folks_role_get_type ())

The type for FolksRole.

folks_role_is_empty ()

gboolean            folks_role_is_empty                 (FolksRole *self);

Whether none of the components is set.

Since 0.6.7

folks_role_to_string ()

gchar *             folks_role_to_string                (FolksRole *self);

Formatted version of this role.

Since 0.4.0

folks_role_new ()

FolksRole *         folks_role_new                      (const gchar *title,
                                                         const gchar *organisation_name,
                                                         const gchar *uid);

Default constructor.

Since 0.4.0

folks_role_get_organisation_name ()

const gchar *       folks_role_get_organisation_name    (FolksRole *self);

folks_role_set_organisation_name ()

void                folks_role_set_organisation_name    (FolksRole *self,
                                                         const gchar *value);

folks_role_get_title ()

const gchar *       folks_role_get_title                (FolksRole *self);

folks_role_set_title ()

void                folks_role_set_title                (FolksRole *self,
                                                         const gchar *value);

folks_role_get_role ()

const gchar *       folks_role_get_role                 (FolksRole *self);

folks_role_set_role ()

void                folks_role_set_role                 (FolksRole *self,
                                                         const gchar *value);

folks_role_get_uid ()

const gchar *       folks_role_get_uid                  (FolksRole *self);

folks_role_set_uid ()

void                folks_role_set_uid                  (FolksRole *self,
                                                         const gchar *value);

folks_role_equal ()

gboolean            folks_role_equal                    (FolksRole *a,
                                                         FolksRole *b);

Compare if two roles are equal. Roles are equal if their titles and organisation names are equal.

folks_role_hash ()

guint               folks_role_hash                     (FolksRole *r);

Hash function for the class. Suitable for use as a hash table key.

struct FolksRole

struct FolksRole;

This interface represents the role a FolksPersona and FolksIndividual have in a given Organisation.

Since 0.4.0

FOLKS_TYPE_ROLE_FIELD_DETAILS

#define FOLKS_TYPE_ROLE_FIELD_DETAILS (folks_role_field_details_get_type ())

The type for FolksRoleFieldDetails.

folks_role_field_details_new ()

FolksRoleFieldDetails * folks_role_field_details_new    (FolksRole *value,
                                                         GeeMultiMap *parameters);

Create a new RoleFieldDetails.

Since 0.6.0

struct FolksRoleFieldDetails

struct FolksRoleFieldDetails;

Object representing details of a contact in an organisation which can have some parameters associated with it.

See FolksAbstractFieldDetails.

Since 0.6.0

folks_role_details_change_roles ()

void                folks_role_details_change_roles     (FolksRoleDetails *self,
                                                         GeeSet *roles,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change the contact's roles.

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

See also: folks_role_details_change_roles_finish()

Since 0.6.2

folks_role_details_change_roles_finish ()

void                folks_role_details_change_roles_finish
                                                        (FolksRoleDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change the contact's roles.

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

See also: folks_role_details_change_roles()

Since 0.6.2

folks_role_details_get_roles ()

GeeSet *            folks_role_details_get_roles        (FolksRoleDetails *self);

folks_role_details_set_roles ()

void                folks_role_details_set_roles        (FolksRoleDetails *self,
                                                         GeeSet *value);

FolksRoleDetails

typedef struct _FolksRoleDetails FolksRoleDetails;

This interfaces represents the list of roles a FolksPersona and FolksIndividual might have.

Since 0.4.0

The "organisation-name" property

  "organisation-name"        gchar*                : Read / Write

The name of the organisation in which the role is held.

Default value: NULL

The "role" property

  "role"                     gchar*                : Read / Write

The role of the position.

For example: “Programmer”

Default value: NULL

Since 0.6.0

The "title" property

  "title"                    gchar*                : Read / Write

The title of the position held.

For example: “Director, Ministry of Silly Walks”

Default value: NULL

The "uid" property

  "uid"                      gchar*                : Read / Write

The UID that distinguishes this role.

Default value: NULL

The "id" property

  "id"                       gchar*                : Read / Write

id.

Default value: NULL

The "roles" property

  "roles"                    GeeSet*               : Read / Write

The roles of the contact.

Since 0.6.0