ESourceGoa

ESourceGoa — ESource extension for GNOME Online Accounts

Synopsis

#include <libedataserver/libedataserver.h>

struct              ESourceGoa;
#define             E_SOURCE_EXTENSION_GOA
const gchar *       e_source_goa_get_account_id         (ESourceGoa *extension);
gchar *             e_source_goa_dup_account_id         (ESourceGoa *extension);
void                e_source_goa_set_account_id         (ESourceGoa *extension,
                                                         const gchar *account_id);

Object Hierarchy

  GObject
   +----ESourceExtension
         +----ESourceGoa

Properties

  "account-id"               gchar*                : Read / Write / Construct

Description

The ESourceGoa extension associates an ESource with a GoaAccount. This extension is usually found in a top-level ESource, with various mail, calendar and address book data sources as children.

Access the extension as follows:

1
2
3
4
5
#include <libedataserver/libedataserver.h>

ESourceGoa *extension;

extension = e_source_get_extension (source, E_SOURCE_EXTENSION_GOA);

Details

struct ESourceGoa

struct ESourceGoa;

Contains only private data that should be read and manipulated using the functions below.

Since 3.6


E_SOURCE_EXTENSION_GOA

#define E_SOURCE_EXTENSION_GOA "GNOME Online Accounts"

Pass this extension name to e_source_get_extension() to access ESourceGoa. This is also used as a group name in key files.

Since 3.6


e_source_goa_get_account_id ()

const gchar *       e_source_goa_get_account_id         (ESourceGoa *extension);

Returns the identifier string of the GNOME Online Account associated with the ESource to which extension belongs.

extension :

an ESourceGoa

Returns :

the associated GNOME Online Account ID

Since 3.6


e_source_goa_dup_account_id ()

gchar *             e_source_goa_dup_account_id         (ESourceGoa *extension);

Thread-safe variation of e_source_goa_get_account_id(). Use this function when accessing extension from multiple threads.

The returned string should be freed with g_free() when no longer needed.

extension :

an ESourceGoa

Returns :

a newly-allocated copy of "account-id"

Since 3.6


e_source_goa_set_account_id ()

void                e_source_goa_set_account_id         (ESourceGoa *extension,
                                                         const gchar *account_id);

Sets the identifier string of the GNOME Online Account associated with the ESource to which extension belongs.

The internal copy of account_id is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

extension :

an ESourceGoa

account_id :

the associated GNOME Online Account ID, or NULL. [allow-none]

Since 3.6

Property Details

The "account-id" property

  "account-id"               gchar*                : Read / Write / Construct

GNOME Online Account ID.

Default value: NULL