TpfPersonaStore

TpfPersonaStore — A persona store which is associated with a single Telepathy account. It will create TpfPersonas for each of the contacts in the account's contact list.

Functions

#define TPF_TYPE_PERSONA_STORE
TpfPersonaStore * tpf_persona_store_new ()
TpAccount * tpf_persona_store_get_account ()
GeeMap * tpf_persona_store_list_persona_stores ()
TpfPersonaStore * tpf_persona_store_dup_for_account ()

Properties

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

Types and Values

struct TpfPersonaStore
struct TpfPersonaStoreClass

Object Hierarchy

    GObject
    ╰── FolksPersonaStore
        ╰── TpfPersonaStore

Description

User must define contact features it wants on the TpSimpleClientFactory of the default TpAccountManager returned by tp_account_manager_dup() *before* preparing telepathy stores. Note that this is a behaviour change since 0.7.0, folks won't force preparing any feature anymore.

Functions

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.

Parameters

account

 .

the Telepathy account being represented by the persona store

.

[in]

tpf_persona_store_get_account ()

TpAccount *
tpf_persona_store_get_account (TpfPersonaStore *self);

Get and return the current value of the "basis account" property.

The Telepathy account this store is based upon.

Parameters

self

the TpfPersonaStore instance to query

  

Returns

the value of the "basis 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 FolksBackendStore has been prepared, this map will be complete, containing every store known to the Telepathy account manager. If no FolksBackendStore 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 FolksBackendStore or tpf_persona_store_dup_for_account() to add stores.

Returns

map from "id" to TpfPersonaStore

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 FolksBackendStore is and is not present.

Parameters

account

 .

the Telepathy account of the persona store

.

[in]

Returns

the persona store associated with the account

Since: 0.6.6

Types and Values

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 account's contact list.

User must define contact features it wants on the TpSimpleClientFactory of the default TpAccountManager returned by tp_account_manager_dup() *before* preparing telepathy stores. Note that this is a behaviour change since 0.7.0, folks won't force preparing any feature anymore.

struct TpfPersonaStoreClass

struct TpfPersonaStoreClass {
	FolksPersonaStoreClass parent_class;
};

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

Members

FolksPersonaStoreClass parent_class;

the parent class structure

  

Property Details

The “account” property

  “account”                  TpAccount *

Telepathy account this store is based upon.

Flags: Read / Write / Construct Only

The “always-writeable-properties” property

  “always-writeable-properties” GStrv

always-writeable-properties.

Flags: Read

The “can-add-personas” property

  “can-add-personas”         FolksMaybeBool

can-add-personas.

Flags: Read

Default value: FOLKS_MAYBE_BOOL_UNSET

The “can-alias-personas” property

  “can-alias-personas”       FolksMaybeBool

can-alias-personas.

Flags: Read

Default value: FOLKS_MAYBE_BOOL_UNSET

The “can-group-personas” property

  “can-group-personas”       FolksMaybeBool

can-group-personas.

Flags: Read

Default value: FOLKS_MAYBE_BOOL_UNSET

The “can-remove-personas” property

  “can-remove-personas”      FolksMaybeBool

can-remove-personas.

Flags: Read

Default value: FOLKS_MAYBE_BOOL_UNSET

The “is-prepared” property

  “is-prepared”              gboolean

is-prepared.

Flags: Read

Default value: FALSE

The “is-quiescent” property

  “is-quiescent”             gboolean

is-quiescent.

Flags: Read

Default value: FALSE

The “personas” property

  “personas”                 GeeMap *

personas.

Flags: Read

The “supported-fields” property

  “supported-fields”         GeeSet *

supported-fields.

Flags: Read

The “type-id” property

  “type-id”                  gchar *

type-id.

Flags: Read

Default value: NULL

Generated by GTK-Doc V1.23.1