![]() |
![]() |
![]() |
GNOME Online Accounts Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
GoaProvider; struct GoaProviderClass; enum GoaProviderGroup; const gchar * goa_provider_get_provider_type (GoaProvider *provider
); gchar * goa_provider_get_provider_name (GoaProvider *provider
,GoaObject *object
); GIcon * goa_provider_get_provider_icon (GoaProvider *provider
,GoaObject *object
); GoaProviderGroup goa_provider_get_provider_group (GoaProvider *provider
); gboolean goa_provider_build_object (GoaProvider *provider
,GoaObjectSkeleton *object
,GKeyFile *key_file
,const gchar *group
,GDBusConnection *connection
,gboolean just_added
,GError **error
); GoaObject * goa_provider_add_account (GoaProvider *provider
,GoaClient *client
,GtkDialog *dialog
,GtkBox *vbox
,GError **error
); gboolean goa_provider_refresh_account (GoaProvider *provider
,GoaClient *client
,GoaObject *object
,GtkWindow *parent
,GError **error
); void goa_provider_show_account (GoaProvider *provider
,GoaClient *client
,GoaObject *object
,GtkBox *vbox
,GtkGrid *left
,GtkGrid *right
); void goa_provider_ensure_credentials (GoaProvider *provider
,GoaObject *object
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean goa_provider_ensure_credentials_finish (GoaProvider *provider
,gint *out_expires_in
,GAsyncResult *res
,GError **error
); gboolean goa_provider_ensure_credentials_sync (GoaProvider *provider
,GoaObject *object
,gint *out_expires_in
,GCancellable *cancellable
,GError **error
); guint goa_provider_get_credentials_generation (GoaProvider *provider
); #define GOA_PROVIDER_EXTENSION_POINT_NAME GList * goa_provider_get_all (void
); GoaProvider * goa_provider_get_for_provider_type (const gchar *provider_type
);
typedef struct _GoaProvider GoaProvider;
The GoaProvider structure contains only private data and should only be accessed using the provided API.
struct GoaProviderClass { GObjectClass parent_class; /* pure virtual */ const gchar *(*get_provider_type) (GoaProvider *provider); gchar *(*get_provider_name) (GoaProvider *provider, GoaObject *object); GIcon *(*get_provider_icon) (GoaProvider *provider, GoaObject *object); GoaObject *(*add_account) (GoaProvider *provider, GoaClient *client, GtkDialog *dialog, GtkBox *vbox, GError **error); gboolean (*refresh_account) (GoaProvider *provider, GoaClient *client, GoaObject *object, GtkWindow *parent, GError **error); gboolean (*build_object) (GoaProvider *provider, GoaObjectSkeleton *object, GKeyFile *key_file, const gchar *group, GDBusConnection *connection, gboolean just_added, GError **error); /* virtual but with default implementation */ gboolean (*ensure_credentials_sync) (GoaProvider *provider, GoaObject *object, gint *out_expires_in, GCancellable *cancellable, GError **error); void (*show_account) (GoaProvider *provider, GoaClient *client, GoaObject *object, GtkBox *vbox, GtkGrid *left, GtkGrid *right); guint (*get_credentials_generation) (GoaProvider *provider); /* pure virtual */ GoaProviderGroup (*get_provider_group) (GoaProvider *provider); };
Class structure for GoaProvider.
The parent class. | |
Virtual function for goa_provider_get_provider_type() . |
|
Virtual function for goa_provider_get_provider_name() . |
|
Virtual function for goa_provider_get_provider_icon() . |
|
Virtual function for goa_provider_add_account() . |
|
Virtual function for goa_provider_refresh_account() . |
|
Virtual function for goa_provider_build_object() . |
|
Virtual function for goa_provider_ensure_credentials_sync() . |
|
Virtual function for goa_provider_show_account() . |
|
Virtual function for goa_provider_get_credentials_generation() . |
|
Virtual function for goa_provider_get_provider_group() . |
typedef enum { GOA_PROVIDER_GROUP_BRANDED, GOA_PROVIDER_GROUP_CONTACTS, GOA_PROVIDER_GROUP_MAIL, GOA_PROVIDER_GROUP_TICKETING, GOA_PROVIDER_GROUP_INVALID } GoaProviderGroup;
An enum for specifying which group a provider belongs to. This is can be used to organize the providers while displaying them in an user interface.
Providers with a well-known brand. For example, Google and Facebook. | |
Providers that offer address book services. For example, CardDAV. | |
Providers that offer email-like messaging services. For example, IMAP and SMTP. | |
Providers with ticketing capabilities. For example, Kerberos. | |
Used for error handling. No provider should belong to this group. |
const gchar * goa_provider_get_provider_type (GoaProvider *provider
);
Gets the type of provider
.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
Returns : |
A string owned by provider , do not free. [transfer none]
|
gchar * goa_provider_get_provider_name (GoaProvider *provider
,GoaObject *object
);
Gets a name for provider
and object
that is suitable for display
in an user interface. The returned value may depend on object
(if
it's not NULL
) - for example, hosted accounts might return a
different name.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
|
A GoaObject for an account. [allow-none] |
Returns : |
A string that should be freed with g_free() . [transfer full]
|
GIcon * goa_provider_get_provider_icon (GoaProvider *provider
,GoaObject *object
);
Gets an icon for provider
and object
that is suitable for display
in an user interface. The returned value may depend on object
-
for example, hosted accounts might return a different icon.
This is a virtual method with a default implementation that returns
a GThemedIcon with fallbacks constructed from the name
goa-account-TYPE
where TYPE
is the return value of goa_provider_get_provider_type()
.
|
A GoaProvider. |
|
A GoaObject for an account. |
Returns : |
An icon that should be freed with g_object_unref() . [transfer full]
|
GoaProviderGroup goa_provider_get_provider_group (GoaProvider *provider
);
Gets the group to which provider
belongs that is suitable for
organizing the providers while displaying them in an user
interface.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
Returns : |
A GoaProviderGroup. |
Since 3.8
gboolean goa_provider_build_object (GoaProvider *provider
,GoaObjectSkeleton *object
,GKeyFile *key_file
,const gchar *group
,GDBusConnection *connection
,gboolean just_added
,GError **error
);
This method is called when construction account GoaObject from configuration data - it basically provides a way to add provider-specific information.
The passed in object
will have a GoaAccount interface
set. Implementations should validate and use data from key_file
to
add more interfaces to object
.
Note that this may be called on already exported objects - for example on configuration files reload.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
|
The GoaObjectSkeleton that is being built. |
|
The GKeyFile with configuation data. |
|
The group in key_file to get data from. |
|
The GDBusConnection used by the daemon to connect to the message bus. |
|
Whether the account was newly created or being updated. |
|
Return location for error or NULL . |
Returns : |
TRUE if data was valid, FALSE if error is set. |
GoaObject * goa_provider_add_account (GoaProvider *provider
,GoaClient *client
,GtkDialog *dialog
,GtkBox *vbox
,GError **error
);
This method brings up the user interface necessary to create a new
account on client
of the type for provider
, interacts with the
user to get all information needed and creates the account.
The passed in dialog
widget is guaranteed to be visible with vbox
being empty and the only visible widget in dialog
's content
area. The dialog has exactly one action widget, a cancel button
with response id GTK_RESPONSE_CANCEL. Implementations are free to
add additional action widgets, as needed.
If an account was successfully created, a GoaObject for the
created account is returned. If dialog
is dismissed, NULL
is
returned and error
is set to GOA_ERROR_DIALOG_DISMISSED
. If an
account couldn't be created then error
is set. In some cases,
for example, when the credentials could not be stored in the
keyring, a GoaObject can be returned even if error
is set.
The caller will always show an error dialog if error
is set unless
the error is GOA_ERROR_DIALOG_DISMISSED
.
Implementations should run the default main loop while
interacting with the user and may do so using e.g. gtk_dialog_run()
on dialog
.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
|
A GoaClient. |
|
A GtkDialog. |
|
A vertically oriented GtkBox to put content in. |
|
Return location for error or NULL . |
Returns : |
The GoaObject for the created account (must be relased
with g_object_unref() ) or NULL if error is set. |
gboolean goa_provider_refresh_account (GoaProvider *provider
,GoaClient *client
,GoaObject *object
,GtkWindow *parent
,GError **error
);
This method brings up the user interface necessary for refreshing
the credentials for the account specified by object
. This
typically involves having the user log in to the account again.
Implementations should use parent
(unless NULL
) as the transient
parent of any created windows/dialogs.
Implementations should run the default main loop while interacting with the user.
This is a pure virtual method - a subclass must provide an implementation.
|
A GoaProvider. |
|
A GoaClient. |
|
A GoaObject with a GoaAccount interface. |
|
Transient parent of dialogs or NULL . [allow-none]
|
|
Return location for error or NULL . |
Returns : |
TRUE if the account has been refreshed, FALSE if error
is set. |
void goa_provider_show_account (GoaProvider *provider
,GoaClient *client
,GoaObject *object
,GtkBox *vbox
,GtkGrid *left
,GtkGrid *right
);
Method used to add widgets in the control panel for the account
represented by object
.
This is a virtual method with an implementation that (currently)
does nothing. A subclass should chain up (before adding their own
widgets to vbox
, left
and right
) if they want to expose such
functionality.
|
A GoaProvider. |
|
A GoaClient. |
|
A GoaObject with a GoaAccount interface. |
|
A vertically oriented GtkBox to put content in. |
|
A vertically oriented GtkGrid to put left-aligned content in. |
|
A vertically oriented GtkGrid to put right-aligned content in. |
void goa_provider_ensure_credentials (GoaProvider *provider
,GoaObject *object
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Ensures that credentials for object
are still valid.
When the result is ready, callback
will be called in the the goa_provider_ensure_credentials_finish()
to get the result
of the operation.
This is a virtual method where the default implementation simply
throws the GOA_ERROR_NOT_SUPPORTED
error. A subclass may provide
another implementation.
|
A GoaProvider. |
|
A GoaObject with a GoaAccount interface. |
|
A GCancellable or NULL . [allow-none]
|
|
The function to call when the request is satisfied. |
|
Pointer to pass to callback . |
gboolean goa_provider_ensure_credentials_finish (GoaProvider *provider
,gint *out_expires_in
,GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_provider_ensure_credentials()
.
|
A GoaProvider. |
|
Return location for how long the expired credentials are good for (0 if unknown) or NULL . [out]
|
|
A GAsyncResult obtained from the GAsyncReadyCallback passed to goa_provider_ensure_credentials() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the credentials for the passed GoaObject are valid, FALSE if error is set. |
gboolean goa_provider_ensure_credentials_sync (GoaProvider *provider
,GoaObject *object
,gint *out_expires_in
,GCancellable *cancellable
,GError **error
);
Like goa_provider_ensure_credentials()
but blocks the
calling thread until an answer is received.
|
A GoaProvider. |
|
A GoaObject with a GoaAccount interface. |
|
Return location for how long the expired credentials are good for (0 if unknown) or NULL . [out]
|
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL . |
Returns : |
TRUE if the credentials for the passed GoaObject are valid, FALSE if error is set. |
guint goa_provider_get_credentials_generation
(GoaProvider *provider
);
Gets the generation of credentials being used for the provider.
Implementations should bump this number when changes are introduced that may render existing credentials unusable.
For example, if an additional scope is requested (e.g. access to contacts data) while obtaining credentials, then this number needs to be bumped since existing credentials are not good for the added scope.
This is a virtual method where the default implementation returns 0.
|
A GoaProvider. |
Returns : |
The current generation of credentials. |
#define GOA_PROVIDER_EXTENSION_POINT_NAME "goa-backend-provider"
Extension point for GoaProvider implementations.
GList * goa_provider_get_all (void
);
Looks up the GOA_PROVIDER_EXTENSION_POINT_NAME
extension
point and returns a newly created GoaProvider for each
provider type encountered.
Returns : |
A list
of element providers that should be freed with g_list_free()
after each element has been freed with g_object_unref() . [transfer full][element-type GoaProvider]
|
GoaProvider * goa_provider_get_for_provider_type (const gchar *provider_type
);
Looks up the GOA_PROVIDER_EXTENSION_POINT_NAME
extension
point and returns a newly created GoaProvider for
provider_type
, if any.
|
A provider type. |
Returns : |
A GoaProvider (that must be freed
with g_object_unref() ) or NULL if not found. [transfer full]
|