Top | ![]() |
![]() |
![]() |
![]() |
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.
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.
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()
.
GoaProviderGroup
goa_provider_get_provider_group (GoaProvider *self
);
goa_provider_get_provider_group
has been deprecated since version 3.10 and should not be used in newly-written code.
Use goa_provider_get_provider_features()
instead.
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
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
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.
self |
A GoaProvider. |
|
client |
A GoaClient. |
|
dialog |
A GtkDialog. |
|
vbox |
A vertically oriented GtkBox to put content in. |
|
error |
Return location for error or |
The GoaObject for the created account (must be relased
with g_object_unref()
) or NULL
if error
is set.
void goa_provider_set_preseed_data (GoaProvider *self
,GVariant *preseed_data
);
goa_provider_set_preseed_data
has been deprecated since version 3.28 and should not be used in newly-written code.
This function does nothing.
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.
GVariant *
goa_provider_get_preseed_data (GoaProvider *self
);
goa_provider_get_preseed_data
has been deprecated since version 3.28 and should not be used in newly-written code.
This function does nothing.
Gets the GVariant set through the “preseed-data” property.
A GVariant that is known to be valid until the property is overridden or the provider freed.
[transfer none]
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.
self |
A GoaProvider. |
|
client |
A GoaClient. |
|
object |
A GoaObject with a GoaAccount interface. |
|
parent |
Transient parent of dialogs or |
[allow-none] |
error |
Return location for error or |
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()
).
self |
A GoaProvider. |
|
client |
A GoaClient. |
|
object |
A GoaObject with a GoaAccount interface. |
|
vbox |
A vertically oriented GtkBox to put content in. |
|
grid |
A GtkGrid to put content in. |
|
dummy |
Unused. |
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.
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 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.
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 GoaProvider (that must be freed
with g_object_unref()
) or NULL
if not found.
[transfer full]
typedef struct _GoaProvider GoaProvider;
The GoaProvider structure contains only private data and should only be accessed using the provided API.
typedef struct _GoaProviderClass GoaProviderClass;
Class structure for GoaProvider.
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. |
||
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. |
||
Providers that offer chat-like messaging capabilities. For example, XMPP, IRC. |
||
Used for error handling. No provider should belong to this group. |
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).
Common providers to be highlighted (ie. Google, OwnCloud). |
||
Mail services (ie. SMTP, IMAP). |
||
Calendaring services (ie. CalDAV). |
||
Addressbook services (ie. CardDAV). |
||
Instant messaging services (ie. XMPP, IRC). |
||
Deprecated; currently unused. |
||
Photos storage services (ie. Flickr). |
||
Files storage services (ie. WebDAV). |
||
Ticketing services (ie. Kerberos). |
||
Deprecated; currently unused. |
||
Network printing services (e.g. Google Cloud Print). |
||
Deprecated; currently unused. |
||
Music related services (e.g. Vkontakte). |
||
Deprecated; currently unused. |
||
Used for error handling. No provider should provide this feature. |
Since: 3.10
“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.
GoaProvider:preseed-data
has been deprecated since version 3.28 and should not be used in newly-written code.
This property does nothing.
Owner: GoaProvider
Flags: Read / Write
Allowed values: GVariant<a{sv}>
Default value: NULL