goa_provider_get_provider_type ()

const gchar *
goa_provider_get_provider_type (GoaProvider *self);

Gets the type of self .

This is a pure virtual method - a subclass must provide an implementation.

goa_provider_get_provider_name ()

gchar *
goa_provider_get_provider_name (GoaProvider *self,
                                GoaObject *object);

Gets a name for self 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.

goa_provider_get_provider_icon ()

GIcon *
goa_provider_get_provider_icon (GoaProvider *self,
                                GoaObject *object);

Gets an icon for self 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().

goa_provider_get_provider_group ()

GoaProviderGroup
goa_provider_get_provider_group (GoaProvider *self);

Gets the group to which self 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.

Since: 3.8

goa_provider_get_provider_features ()

GoaProviderFeatures
goa_provider_get_provider_features (GoaProvider *self);

Get the features bitmask (eg. GOA_PROVIDER_FEATURE_CHAT|GOA_PROVIDER_FEATURE_CONTACTS) supported by the provider.

Since: 3.10

goa_provider_build_object ()

gboolean
goa_provider_build_object (GoaProvider *self,
                           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.

goa_provider_add_account ()

GoaObject *
goa_provider_add_account (GoaProvider *self,
                          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 self , 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.

goa_provider_set_preseed_data ()

void
goa_provider_set_preseed_data (GoaProvider *self,
                               GVariant *preseed_data);

Sets the “preseed-data” property to feed any information already collected that can be useful when creating a new account.

If the preseed_data GVariant is floating, it is consumed to allow 'inline' use of the g_variant_new() family of functions.

goa_provider_get_preseed_data ()

GVariant *
goa_provider_get_preseed_data (GoaProvider *self);

Gets the GVariant set through the “preseed-data” property.

goa_provider_refresh_account ()

gboolean
goa_provider_refresh_account (GoaProvider *self,
                              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.

goa_provider_show_account ()

void
goa_provider_show_account (GoaProvider *self,
                           GoaClient *client,
                           GoaObject *object,
                           GtkBox *vbox,
                           GtkGrid *dummy1,
                           GtkGrid *dummy2);

Method used to add widgets in the control panel for the account represented by object .

This is a virtual method where the default implementation adds one GtkSwitch per service supported by the provider (as reported by goa_provider_get_provider_features()).

goa_provider_ensure_credentials ()

void
goa_provider_ensure_credentials (GoaProvider *self,
                                 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 thread-default main loop this function was called from. You can then call 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.

goa_provider_ensure_credentials_finish ()

gboolean
goa_provider_ensure_credentials_finish
                               (GoaProvider *self,
                                gint *out_expires_in,
                                GAsyncResult *res,
                                GError **error);

Finishes an operation started with goa_provider_ensure_credentials().

goa_provider_ensure_credentials_sync ()

gboolean
goa_provider_ensure_credentials_sync (GoaProvider *self,
                                      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.

goa_provider_get_credentials_generation ()

guint
goa_provider_get_credentials_generation
                               (GoaProvider *self);

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.

goa_provider_get_all ()

void
goa_provider_get_all (GAsyncReadyCallback callback,
                      gpointer user_data);

Creates a list of all the available GoaProvider instances.

When the result is ready, callback will be called in the the thread-default main loop this function was called from. You can then call goa_provider_get_all_finish() to get the result of the operation.

See goa_provider_get_for_provider_type() for details on how the providers are found.

goa_provider_get_for_provider_type ()

GoaProvider *
goa_provider_get_for_provider_type (const gchar *provider_type);

Returns a GoaProvider for provider_type (if available).

If provider_type doesn't contain any "/", a GOA_PROVIDER_EXTENSION_POINT_NAME extension for provider_type is looked up and the newly created GoaProvider, if any, is returned.

If provider_type contains a "/", a GOA_PROVIDER_FACTORY_EXTENSION_POINT_NAME extension for the first part of provider_type is looked up. If found, the GoaProviderFactory is used to create a dynamic GoaProvider matching the second part of provider_type .

GoaProvider

typedef struct _GoaProvider GoaProvider;

The GoaProvider structure contains only private data and should only be accessed using the provided API.

GoaProviderClass

typedef struct {
  GObjectClass parent_class;

  /* pure virtual */
  GoaObject              *(*add_account)                  (GoaProvider            *self,
                                                           GoaClient              *client,
                                                           GtkDialog              *dialog,
                                                           GtkBox                 *vbox,
                                                           GError                **error);
  GoaProviderFeatures     (*get_provider_features)        (GoaProvider            *self);
  GoaProviderGroup        (*get_provider_group)           (GoaProvider            *self);
  gchar                  *(*get_provider_name)            (GoaProvider            *self,
                                                           GoaObject              *object);
  const gchar            *(*get_provider_type)            (GoaProvider            *self);
  gboolean                (*refresh_account)              (GoaProvider            *self,
                                                           GoaClient              *client,
                                                           GoaObject              *object,
                                                           GtkWindow              *parent,
                                                           GError                **error);

  /* virtual but with default implementation */
  gboolean                (*build_object)                 (GoaProvider            *self,
                                                           GoaObjectSkeleton      *object,
                                                           GKeyFile               *key_file,
                                                           const gchar            *group,
                                                           GDBusConnection        *connection,
                                                           gboolean                just_added,
                                                           GError                **error);
  gboolean                (*ensure_credentials_sync)      (GoaProvider            *self,
                                                           GoaObject              *object,
                                                           gint                   *out_expires_in,
                                                           GCancellable           *cancellable,
                                                           GError                **error);
  guint                   (*get_credentials_generation)   (GoaProvider            *self);
  GIcon                  *(*get_provider_icon)            (GoaProvider            *self,
                                                           GoaObject              *object);
  void                    (*initialize)                   (GoaProvider            *self);
  void                    (*remove_account)               (GoaProvider            *self,
                                                           GoaObject              *object,
                                                           GCancellable           *cancellable,
                                                           GAsyncReadyCallback     callback,
                                                           gpointer                user_data);
  gboolean                (*remove_account_finish)        (GoaProvider            *self,
                                                           GAsyncResult           *res,
                                                           GError                **error);
  void                    (*show_account)                 (GoaProvider            *self,
                                                           GoaClient              *client,
                                                           GoaObject              *object,
                                                           GtkBox                 *vbox,
                                                           GtkGrid                *dummy1,
                                                           GtkGrid                *dummy2);
} GoaProviderClass;

Class structure for GoaProvider.

enum 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.

enum GoaProviderFeatures

These flags specify the features exported by each provider. They can be expecially useful to restrict the list of available providers when requesting the creation of an account for a specific purpose (eg. from a chat program).

Since: 3.10

GOA_PROVIDER_EXTENSION_POINT_NAME

#define GOA_PROVIDER_EXTENSION_POINT_NAME "goa-backend-provider"

Extension point for GoaProvider implementations.

The “preseed-data” property

  “preseed-data”             GVariant *

An GVariant of type a{sv} storing any information already collected that can be useful when creating a new account. For instance, this can be useful to reuse the HTTP cookies from an existing browser session to skip the prompt for username and password in the OAuth2-based providers by passing a GVariant with the following contents:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "cookies": [
    {
      "domain": "example.com",
      "name": "LSID",
      "value": "asdfasdfasdf"
    },
    {
      "domain": "accounts.example.com",
      "name": "SSID",
      "value": "asdfasdfasdf"
    }
  ]
}

Unknown or unsupported keys will be ignored by providers.

Flags: Read / Write

Allowed values: GVariant<a{sv}>

Default value: NULL