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);

Get and return the current value of the "organisation-name" property.

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

folks_role_set_organisation_name ()

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

Set the value of the "organisation-name" property to value .

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

folks_role_get_title ()

const gchar *
folks_role_get_title (FolksRole *self);

Get and return the current value of the "title" property.

The title of the position held.

For example: “Director, Ministry of Silly Walks”

folks_role_set_title ()

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

Set the value of the "title" property to value .

The title of the position held.

For example: “Director, Ministry of Silly Walks”

folks_role_get_role ()

const gchar *
folks_role_get_role (FolksRole *self);

Get and return the current value of the "role" property.

The role of the position.

For example: “Programmer”

Since 0.6.0

folks_role_set_role ()

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

Set the value of the "role" property to value .

The role of the position.

For example: “Programmer”

Since 0.6.0

folks_role_get_uid ()

const gchar *
folks_role_get_uid (FolksRole *self);

Get and return the current value of the "uid" property.

The UID that distinguishes this role.

folks_role_set_uid ()

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

Set the value of the "uid" property to value .

The UID that distinguishes this role.

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.

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

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).

FolksPropertyError will be returned in error

if setting the roles 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).

FolksPropertyError will be returned in error

if setting the roles 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);

Get and return the current value of the "roles" property.

The roles of the contact.

Since 0.6.0

folks_role_details_set_roles ()

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

Set the value of the "roles" property to value .

The roles of the contact.

Since 0.6.0

struct FolksRole

struct FolksRole;

Role a contact has in an organisation.

This represents the role a FolksPersona or FolksIndividual has in a single given organisation, such as a company.

Since 0.4.0

struct FolksRoleClass

struct FolksRoleClass {
	GObjectClass parent_class;
};

The class structure for FOLKS_TYPE_ROLE. All the fields in this structure are private and should never be accessed directly.

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

struct FolksRoleFieldDetailsClass

struct FolksRoleFieldDetailsClass {
	FolksAbstractFieldDetailsClass parent_class;
};

The class structure for FOLKS_TYPE_ROLE_FIELD_DETAILS. All the fields in this structure are private and should never be accessed directly.

FolksRoleDetails

typedef struct _FolksRoleDetails FolksRoleDetails;

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

Since 0.4.0

struct FolksRoleDetailsIface

struct FolksRoleDetailsIface {
	GTypeInterface parent_iface;
	void (*change_roles) (FolksRoleDetails* self, GeeSet* roles, GAsyncReadyCallback _callback_, gpointer _user_data_);
	void (*change_roles_finish) (FolksRoleDetails* self, GAsyncResult* _res_, GError** error);
	GeeSet* (*get_roles) (FolksRoleDetails* self);
	void (*set_roles) (FolksRoleDetails* self, GeeSet* value);
};

Interface for creating FolksRoleDetails implementations.

The “organisation-name” property

  “organisation-name”        gchar *

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

Flags: Read / Write

Default value: NULL

The “role” property

  “role”                     gchar *

The role of the position.

For example: “Programmer”

Flags: Read / Write

Default value: NULL

Since 0.6.0

The “title” property

  “title”                    gchar *

The title of the position held.

For example: “Director, Ministry of Silly Walks”

Flags: Read / Write

Default value: NULL

The “uid” property

  “uid”                      gchar *

The UID that distinguishes this role.

Flags: Read / Write

Default value: NULL

The “id” property

  “id”                       gchar *

id.

Flags: Read / Write

Default value: NULL

The “roles” property

  “roles”                    GeeSet *

The roles of the contact.

Flags: Read / Write

Since 0.6.0