TpfPersonaStore

TpfPersonaStore — A persona store which is associated with a single Telepathy account. It will create TpfPersonas for each of the contacts in the published, stored or subscribed channels of the account.

Synopsis

#define             TPF_TYPE_PERSONA_STORE
TpfPersonaStore *   tpf_persona_store_new               (TpAccount *account);
TpAccount *         tpf_persona_store_get_account       (TpfPersonaStore *self);
GeeMap *            tpf_persona_store_list_persona_stores
                                                        (void);
TpfPersonaStore *   tpf_persona_store_dup_for_account   (TpAccount *account);
struct              TpfPersonaStore;

Object Hierarchy

  GObject
   +----FolksPersonaStore
         +----TpfPersonaStore

Properties

  "account"                  TpAccount*            : Read / Write / Construct Only
  "always-writeable-properties" GStrv                 : Read
  "can-add-personas"         FolksMaybeBool        : Read
  "can-alias-personas"       FolksMaybeBool        : Read
  "can-group-personas"       FolksMaybeBool        : Read
  "can-remove-personas"      FolksMaybeBool        : Read
  "is-prepared"              gboolean              : Read
  "is-quiescent"             gboolean              : Read
  "personas"                 GeeMap*               : Read
  "supported-fields"         GeeSet*               : Read
  "type-id"                  gchar*                : Read

Signals

  "group-members-changed"                          : Run Last
  "group-removed"                                  : Run Last

Description

Details

TPF_TYPE_PERSONA_STORE

#define TPF_TYPE_PERSONA_STORE (tpf_persona_store_get_type ())

The type for TpfPersonaStore.

tpf_persona_store_new ()

TpfPersonaStore *   tpf_persona_store_new               (TpAccount *account);

Create a new PersonaStore.

Create a new persona store to store the TpfPersonas for the contacts in the Telepathy account provided by `account`.

account :

 the Telepathy account being represented by the persona store. [in]

tpf_persona_store_get_account ()

TpAccount *         tpf_persona_store_get_account       (TpfPersonaStore *self);

self :

 the TpfPersonaStore instance to query

Returns :

 the value of the "account" property

tpf_persona_store_list_persona_stores ()

GeeMap *            tpf_persona_store_list_persona_stores
                                                        (void);

Get a map of all the currently constructed TpfPersonaStores.

If a BackendStore has been prepared, this map will be complete, containing every store known to the Telepathy account manager. If no BackendStore has been prepared, this map will only contain the stores which have been created by calling tpf_persona_store_dup_for_account().

This map is read-only. Use BackendStore or tpf_persona_store_dup_for_account() to add stores.

Returns :

 map from PersonaStore.id to tpf_persona_store_new()

Since 0.6.6

tpf_persona_store_dup_for_account ()

TpfPersonaStore *   tpf_persona_store_dup_for_account   (TpAccount *account);

Look up a TpfPersonaStore by its TpAccount.

If found, a new reference to the persona store will be returned. If not found, a new TpfPersonaStore will be created for the account.

See the documentation for tpf_persona_store_list_persona_stores() for information on the lifecycle of these stores when a BackendStore is and is not present.

account :

 the Telepathy account of the persona store. [in]

Returns :

 the persona store associated with the account

Since 0.6.6

struct TpfPersonaStore

struct TpfPersonaStore;

A persona store which is associated with a single Telepathy account. It will create TpfPersonas for each of the contacts in the published, stored or subscribed channels of the account.

Property Details

The "account" property

  "account"                  TpAccount*            : Read / Write / Construct Only

The Telepathy account this store is based upon.

The "always-writeable-properties" property

  "always-writeable-properties" GStrv                 : Read

always-writeable-properties.

The "can-add-personas" property

  "can-add-personas"         FolksMaybeBool        : Read

can-add-personas.

Default value: FOLKS_MAYBE_BOOL_UNSET

The "can-alias-personas" property

  "can-alias-personas"       FolksMaybeBool        : Read

can-alias-personas.

Default value: FOLKS_MAYBE_BOOL_UNSET

The "can-group-personas" property

  "can-group-personas"       FolksMaybeBool        : Read

can-group-personas.

Default value: FOLKS_MAYBE_BOOL_UNSET

The "can-remove-personas" property

  "can-remove-personas"      FolksMaybeBool        : Read

can-remove-personas.

Default value: FOLKS_MAYBE_BOOL_UNSET

The "is-prepared" property

  "is-prepared"              gboolean              : Read

is-prepared.

Default value: FALSE

The "is-quiescent" property

  "is-quiescent"             gboolean              : Read

is-quiescent.

Default value: FALSE

The "personas" property

  "personas"                 GeeMap*               : Read

personas.

The "supported-fields" property

  "supported-fields"         GeeSet*               : Read

supported-fields.

The "type-id" property

  "type-id"                  gchar*                : Read

type-id.

Default value: NULL

Signal Details

The "group-members-changed" signal

void                user_function                      (TpfPersonaStore *tpfpersonastore,
                                                        gchar           *arg1,
                                                        gpointer         arg2,
                                                        gpointer         arg3,
                                                        gpointer         user_data)            : Run Last

The "group-removed" signal

void                user_function                      (TpfPersonaStore *tpfpersonastore,
                                                        gchar           *arg1,
                                                        gpointer         arg2,
                                                        gpointer         user_data)            : Run Last
Generated by GTK-Doc V1.18.1