EdsfPersonaStore: folks-eds Reference Manual

EdsfPersonaStore

EdsfPersonaStore — A persona store representing a single EDS address book.

Functions

#define	EDSF_TYPE_PERSONA_STORE
EdsfPersonaStore *	edsf_persona_store_new ()
EdsfPersonaStore *	edsf_persona_store_new_with_source_registry ()
ESource *	edsf_persona_store_get_source ()
void	edsf_persona_store_create_address_book ()
void	edsf_persona_store_create_address_book_finish ()
void	edsf_persona_store_remove_address_book ()
void	edsf_persona_store_remove_address_book_finish ()

Properties

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
ESource *	source	Read / Write / Construct Only
gchar *	type-id	Read

Types and Values

struct	EdsfPersonaStore
struct	EdsfPersonaStoreClass

Object Hierarchy

    GObject
    ╰── FolksPersonaStore
        ╰── EdsfPersonaStore

Description

The persona store will contain EdsfPersonas for each contact in the address book it represents.

Functions

EDSF_TYPE_PERSONA_STORE

#define EDSF_TYPE_PERSONA_STORE (edsf_persona_store_get_type ())

The type for EdsfPersonaStore.

edsf_persona_store_new ()

EdsfPersonaStore *
edsf_persona_store_new (ESource *s);

edsf_persona_store_new has been deprecated since version 0.7.2 and should not be used in newly-written code.

No replacement specified.

Create a new PersonaStore.

Create a new persona store to store the EdsfPersonas for the contacts

Parameters

the e-d-s source being represented by the persona store

[in]

Since: 0.6.0

edsf_persona_store_new_with_source_registry ()

EdsfPersonaStore *
edsf_persona_store_new_with_source_registry
                               (ESourceRegistry *r,
                                ESource *s);

Create a new PersonaStore.

Create a new persona store to store the EdsfPersonas for the contacts in s. Passing a re-used source registry to the constructor (compared to the old EdsfPersonaStore constructor) saves a lot of time and D-Bus round trips.

Parameters

the EDS source registry giving access to all EDS sources

[in]

the EDS source being represented by the persona store

[in]

Since: 0.7.2

edsf_persona_store_get_source ()

ESource *
edsf_persona_store_get_source (EdsfPersonaStore *self);

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

The EDS ESource associated with this persona store.

Parameters

self

the EdsfPersonaStore instance to query

Returns

the value of the "source" property

Since: 0.6.6

edsf_persona_store_create_address_book ()

void
edsf_persona_store_create_address_book
                               (const gchar *id,
                                GAsyncReadyCallback _callback_,
                                gpointer _user_data_);

Create a new address book with the given ID.

A new Address Book will be created with the given ID and the EDS SourceRegistry will notice the new Address Book source and will emit source_added with the new ESource object which Folks.Backends.Eds.Backend will then create a new EdsfPersonaStore from.

GError will be returned in error

if an error occurred while creating or committing to the ESourceRegistry

Parameters

the name and id for the new address book

[in]

_callback_

callback to call when the request is satisfied.

[scope async]

_user_data_

the data to pass to _callback_ function.

[closure]

Since: 0.9.0

edsf_persona_store_create_address_book_finish ()

void
edsf_persona_store_create_address_book_finish
                               (GAsyncResult *_res_,
                                GError **error);

Create a new address book with the given ID.

GError will be returned in error

if an error occurred while creating or committing to the ESourceRegistry

Parameters

_res_	a GAsyncResult
error	location to store the error occuring, or `NULL` to ignore

Since: 0.9.0

edsf_persona_store_remove_address_book ()

void
edsf_persona_store_remove_address_book
                               (EdsfPersonaStore *store,
                                GAsyncReadyCallback _callback_,
                                gpointer _user_data_);

Remove a persona store's address book permamently.

This is a utility function to remove an EdsfPersonaStore's address book from the disk permanently. This simply wraps the EDS API to do the same.

GError will be returned in error

if an error occurred in e_source_remove()

Parameters

store

the PersonaStore to delete the address book for.

[in]

_callback_

callback to call when the request is satisfied.

[scope async]

_user_data_

the data to pass to _callback_ function.

[closure]

Since: 0.9.0

edsf_persona_store_remove_address_book_finish ()

void
edsf_persona_store_remove_address_book_finish
                               (GAsyncResult *_res_,
                                GError **error);

Remove a persona store's address book permamently.

This is a utility function to remove an EdsfPersonaStore's address book from the disk permanently. This simply wraps the EDS API to do the same.

GError will be returned in error

if an error occurred in e_source_remove()

Parameters

_res_	a GAsyncResult
error	location to store the error occuring, or `NULL` to ignore

Since: 0.9.0

Types and Values

struct EdsfPersonaStore

struct EdsfPersonaStore;

A persona store representing a single EDS address book.

The persona store will contain EdsfPersonas for each contact in the address book it represents.

struct EdsfPersonaStoreClass

struct EdsfPersonaStoreClass {
	FolksPersonaStoreClass parent_class;
};

The class structure for EDSF_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 `“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 `“source”` property

  “source”                   ESource *

The EDS ESource associated with this persona store.

Flags: Read / Write / Construct Only

Since: 0.6.6

The `“type-id”` property

  “type-id”                  gchar *

type-id.

Flags: Read

Default value: NULL