RmAddressBook

RmAddressBook — Address book handling functions

Functions

Types and Values

Description

Address book handles plugins and common address book functions.

Functions

rm_addressbook_get ()

RmAddressBook *
rm_addressbook_get (gchar *name);

Find address book as requested by name.

Parameters

name

name of address book to lookup

 

Returns

a RmAddressBook, or NULL on error


rm_addressbook_get_contacts ()

GList *
rm_addressbook_get_contacts (RmAddressBook *book);

Get all contacts within the main internal address book.

Parameters

book

a RmAddressBook

 

Returns

contact list or NULL if no address book is set.


rm_addressbook_remove_contact ()

gboolean
rm_addressbook_remove_contact (RmAddressBook *book,
                               RmContact *contact);

Remove given contact from address book

Parameters

book

a RmAddressBook

 

contact

a RmContact

 

Returns

TRUE when contacts have been successfully removed, FALSE on error


rm_addressbook_save_contact ()

gboolean
rm_addressbook_save_contact (RmAddressBook *book,
                             RmContact *contact);

Try to save contact to address book

Parameters

book

a RmAddressBook

 

contact

a RmContact

 

Returns

TRUE when contacts have been successfully written, FALSE on error


rm_addressbook_can_save ()

gboolean
rm_addressbook_can_save (RmAddressBook *book);

Checks wether current address book can save data

Parameters

book

a RmAddressBook

 

Returns

TRUE if address book can save data, FALSE if not.


rm_addressbook_register ()

void
rm_addressbook_register (RmAddressBook *book);

Register a new address book.

Parameters

book

a RmAddressBook

 

rm_addressbook_unregister ()

void
rm_addressbook_unregister (RmAddressBook *book);

Unregister a new address book.

Parameters

book

a RmAddressBook

 

rm_addressbook_get_name ()

gchar *
rm_addressbook_get_name (RmAddressBook *book);

Retrieve name of current address book.

Parameters

book

a RmAddressBook

 

Returns

current address book name


rm_addressbook_get_sub_name ()

gchar *
rm_addressbook_get_sub_name (RmAddressBook *book);

Retrieve sub name of current address book.

Parameters

book

a RmAddressBook

 

Returns

current sub address book name


rm_addressbook_get_sub_books ()

gchar **
rm_addressbook_get_sub_books (RmAddressBook *book);

Get all sub books provides by given address book plugin

Parameters

book

a RmAddressBook

 

Returns

strv of all sub books or NULL


rm_addressbook_set_sub_book ()

void
rm_addressbook_set_sub_book (RmAddressBook *book,
                             gchar *name);

Sets name as the current sub book.

Parameters

book

a RmAddressBook

 

name

name of the sub book

 

rm_addressbook_get_plugins ()

GList *
rm_addressbook_get_plugins (void);

Get a list of all address book plugins.

Returns

list of address book plugins

Types and Values

RmAddressBook

typedef struct {
} RmAddressBook;

The RmAddressBook contains only private fileds and should not be directly accessed.