Blame doc/html/GoaProvider.html

Packit Service c6b9b0
Packit Service c6b9b0
<html>
Packit Service c6b9b0
<head>
Packit Service c6b9b0
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service c6b9b0
<title>GoaProvider: GNOME Online Accounts Reference Manual</title>
Packit Service c6b9b0
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit Service c6b9b0
<link rel="home" href="index.html" title="GNOME Online Accounts Reference Manual">
Packit Service c6b9b0
<link rel="up" href="ch07.html" title="Core">
Packit Service c6b9b0
<link rel="prev" href="goa-goautil.html" title="goautil">
Packit Service c6b9b0
<link rel="next" href="GoaOAuthProvider.html" title="GoaOAuthProvider">
Packit Service c6b9b0
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit Service c6b9b0
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service c6b9b0
</head>
Packit Service c6b9b0
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Top  | 
Packit Service c6b9b0
                  Description  | 
Packit Service c6b9b0
                  Object Hierarchy  | 
Packit Service c6b9b0
                  Properties
Packit Service c6b9b0
Packit Service c6b9b0
Home
Packit Service c6b9b0
Up
Packit Service c6b9b0
Prev
Packit Service c6b9b0
Next
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GoaProvider

Packit Service c6b9b0

GoaProvider — Abstract base class for providers

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Functions

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
const gchar *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_provider_type ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
gchar *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_provider_name ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GIcon *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_provider_icon ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GoaProviderGroup
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_provider_group ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GoaProviderFeatures
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_provider_features ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
gboolean
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_build_object ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GoaObject *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_add_account ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
void
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_set_preseed_data ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GVariant *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_preseed_data ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
gboolean
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_refresh_account ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
void
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_show_account ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
void
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_ensure_credentials ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
gboolean
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_ensure_credentials_finish ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
gboolean
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_ensure_credentials_sync ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
guint
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_credentials_generation ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
void
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_all ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GoaProvider *
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
goa_provider_get_for_provider_type ()
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Properties

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
GVariant *
Packit Service c6b9b0
preseed-data
Packit Service c6b9b0
Read / Write
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Types and Values

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
GoaProvider
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
GoaProviderClass
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
enum
Packit Service c6b9b0
GoaProviderGroup
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
enum
Packit Service c6b9b0
GoaProviderFeatures
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
#define
Packit Service c6b9b0
GOA_PROVIDER_EXTENSION_POINT_NAME
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Object Hierarchy

Packit Service c6b9b0
    GObject
Packit Service c6b9b0
    ╰── GoaProvider
Packit Service c6b9b0
        ├── GoaOAuthProvider
Packit Service c6b9b0
        ╰── GoaOAuth2Provider
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Description

Packit Service c6b9b0

GoaProvider is the base type for all providers.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Functions

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_type ()

Packit Service c6b9b0
const gchar *
Packit Service c6b9b0
goa_provider_get_provider_type (GoaProvider *self);
Packit Service c6b9b0

Gets the type of self

Packit Service c6b9b0
.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

A string owned by self

Packit Service c6b9b0
, do not free. 

Packit Service c6b9b0

[transfer none]

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_name ()

Packit Service c6b9b0
gchar *
Packit Service c6b9b0
goa_provider_get_provider_name (GoaProvider *self,
Packit Service c6b9b0
                                GoaObject *object);
Packit Service c6b9b0

Gets a name for self

Packit Service c6b9b0
 and object
Packit Service c6b9b0
 that is suitable for display
Packit Service c6b9b0
in an user interface. The returned value may depend on object
Packit Service c6b9b0
 (if
Packit Service c6b9b0
it's not NULL) - for example, hosted accounts might return a
Packit Service c6b9b0
different name.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject for an account.

Packit Service c6b9b0
[allow-none]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

A string that should be freed with g_free().

Packit Service c6b9b0

[transfer full]

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_icon ()

Packit Service c6b9b0
GIcon *
Packit Service c6b9b0
goa_provider_get_provider_icon (GoaProvider *self,
Packit Service c6b9b0
                                GoaObject *object);
Packit Service c6b9b0

Gets an icon for self

Packit Service c6b9b0
 and object
Packit Service c6b9b0
 that is suitable for display
Packit Service c6b9b0
in an user interface. The returned value may depend on object
Packit Service c6b9b0
 -
Packit Service c6b9b0
for example, hosted accounts might return a different icon.

Packit Service c6b9b0

This is a virtual method with a default implementation that returns

Packit Service c6b9b0
a GThemedIcon with fallbacks constructed from the name
Packit Service c6b9b0
goa-account-TYPE where TYPE
Packit Service c6b9b0
is the return value of goa_provider_get_provider_type().

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject for an account.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

An icon that should be freed with g_object_unref().

Packit Service c6b9b0

[transfer full]

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_group ()

Packit Service c6b9b0
GoaProviderGroup
Packit Service c6b9b0
goa_provider_get_provider_group (GoaProvider *self);
Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_group has been deprecated since version 3.10 and should not be used in newly-written code.

Packit Service c6b9b0

Use goa_provider_get_provider_features() instead.

Packit Service c6b9b0
Packit Service c6b9b0

Gets the group to which self

Packit Service c6b9b0
 belongs that is suitable for
Packit Service c6b9b0
organizing the providers while displaying them in an user
Packit Service c6b9b0
interface.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

A GoaProviderGroup.

Packit Service c6b9b0
Packit Service c6b9b0

Since: 3.8

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_provider_features ()

Packit Service c6b9b0
GoaProviderFeatures
Packit Service c6b9b0
goa_provider_get_provider_features (GoaProvider *self);
Packit Service c6b9b0

Get the features bitmask (eg. GOA_PROVIDER_FEATURE_CHAT|GOA_PROVIDER_FEATURE_CONTACTS)

Packit Service c6b9b0
supported by the provider.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

The GoaProviderFeatures bitmask with the provided features.

Packit Service c6b9b0
Packit Service c6b9b0

Since: 3.10

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_build_object ()

Packit Service c6b9b0
gboolean
Packit Service c6b9b0
goa_provider_build_object (GoaProvider *self,
Packit Service c6b9b0
                           GoaObjectSkeleton *object,
Packit Service c6b9b0
                           GKeyFile *key_file,
Packit Service c6b9b0
                           const gchar *group,
Packit Service c6b9b0
                           GDBusConnection *connection,
Packit Service c6b9b0
                           gboolean just_added,
Packit Service c6b9b0
                           GError **error);
Packit Service c6b9b0

This method is called when construction account GoaObject

Packit Service c6b9b0
from configuration data - it basically provides a way to add
Packit Service c6b9b0
provider-specific information.

Packit Service c6b9b0

The passed in object

Packit Service c6b9b0
 will have a GoaAccount interface
Packit Service c6b9b0
set. Implementations should validate and use data from key_file
Packit Service c6b9b0
 to
Packit Service c6b9b0
add more interfaces to object
Packit Service c6b9b0
.

Packit Service c6b9b0

Note that this may be called on already exported objects - for

Packit Service c6b9b0
example on configuration files reload.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

The GoaObjectSkeleton that is being built.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

key_file

Packit Service c6b9b0

The GKeyFile with configuation data.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

group

Packit Service c6b9b0

The group in key_file

Packit Service c6b9b0
to get data from.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

connection

Packit Service c6b9b0

The GDBusConnection used by the daemon to connect to the message bus.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

just_added

Packit Service c6b9b0

Whether the account was newly created or being updated.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

error

Packit Service c6b9b0

Return location for error or NULL.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

TRUE if data was valid, FALSE if error

Packit Service c6b9b0
is set.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_add_account ()

Packit Service c6b9b0
GoaObject *
Packit Service c6b9b0
goa_provider_add_account (GoaProvider *self,
Packit Service c6b9b0
                          GoaClient *client,
Packit Service c6b9b0
                          GtkDialog *dialog,
Packit Service c6b9b0
                          GtkBox *vbox,
Packit Service c6b9b0
                          GError **error);
Packit Service c6b9b0

This method brings up the user interface necessary to create a new

Packit Service c6b9b0
account on client
Packit Service c6b9b0
 of the type for self
Packit Service c6b9b0
, interacts with the
Packit Service c6b9b0
user to get all information needed and creates the account.

Packit Service c6b9b0

The passed in dialog

Packit Service c6b9b0
 widget is guaranteed to be visible with vbox
Packit Service c6b9b0
Packit Service c6b9b0
being empty and the only visible widget in dialog
Packit Service c6b9b0
's content
Packit Service c6b9b0
area. The dialog has exactly one action widget, a cancel button
Packit Service c6b9b0
with response id GTK_RESPONSE_CANCEL. Implementations are free to
Packit Service c6b9b0
add additional action widgets, as needed.

Packit Service c6b9b0

If an account was successfully created, a GoaObject for the

Packit Service c6b9b0
created account is returned. If dialog
Packit Service c6b9b0
 is dismissed, NULL is
Packit Service c6b9b0
returned and error
Packit Service c6b9b0
 is set to GOA_ERROR_DIALOG_DISMISSED. If an
Packit Service c6b9b0
account couldn't be created then error
Packit Service c6b9b0
 is set. In some cases,
Packit Service c6b9b0
for example, when the credentials could not be stored in the
Packit Service c6b9b0
keyring, a GoaObject can be returned even if error
Packit Service c6b9b0
 is set.

Packit Service c6b9b0

The caller will always show an error dialog if error

Packit Service c6b9b0
 is set unless
Packit Service c6b9b0
the error is GOA_ERROR_DIALOG_DISMISSED.

Packit Service c6b9b0

Implementations should run the default main loop while

Packit Service c6b9b0
interacting with the user and may do so using e.g. gtk_dialog_run()
Packit Service c6b9b0
on dialog
Packit Service c6b9b0
.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

client

Packit Service c6b9b0

A GoaClient.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

dialog

Packit Service c6b9b0

A GtkDialog.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

vbox

Packit Service c6b9b0

A vertically oriented GtkBox to put content in.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

error

Packit Service c6b9b0

Return location for error or NULL.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

The GoaObject for the created account (must be relased

Packit Service c6b9b0
with g_object_unref()) or NULL if error
Packit Service c6b9b0
is set.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_set_preseed_data ()

Packit Service c6b9b0
void
Packit Service c6b9b0
goa_provider_set_preseed_data (GoaProvider *self,
Packit Service c6b9b0
                               GVariant *preseed_data);
Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_set_preseed_data has been deprecated since version 3.28 and should not be used in newly-written code.

Packit Service c6b9b0

This function does nothing.

Packit Service c6b9b0
Packit Service c6b9b0

Sets the “preseed-data” property to feed any information already

Packit Service c6b9b0
collected that can be useful when creating a new account.

Packit Service c6b9b0

If the preseed_data

Packit Service c6b9b0
 GVariant is floating, it is consumed to allow
Packit Service c6b9b0
'inline' use of the g_variant_new() family of functions.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

The GoaProvider

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

preseed_data

Packit Service c6b9b0

A GVariant of type a{sv}

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_preseed_data ()

Packit Service c6b9b0
GVariant *
Packit Service c6b9b0
goa_provider_get_preseed_data (GoaProvider *self);
Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_preseed_data has been deprecated since version 3.28 and should not be used in newly-written code.

Packit Service c6b9b0

This function does nothing.

Packit Service c6b9b0
Packit Service c6b9b0

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

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

The GoaProvider

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

A GVariant that is known to be valid until

Packit Service c6b9b0
the property is overridden or the provider freed. 

Packit Service c6b9b0

[transfer none]

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_refresh_account ()

Packit Service c6b9b0
gboolean
Packit Service c6b9b0
goa_provider_refresh_account (GoaProvider *self,
Packit Service c6b9b0
                              GoaClient *client,
Packit Service c6b9b0
                              GoaObject *object,
Packit Service c6b9b0
                              GtkWindow *parent,
Packit Service c6b9b0
                              GError **error);
Packit Service c6b9b0

This method brings up the user interface necessary for refreshing

Packit Service c6b9b0
the credentials for the account specified by object
Packit Service c6b9b0
. This
Packit Service c6b9b0
typically involves having the user log in to the account again.

Packit Service c6b9b0

Implementations should use parent

Packit Service c6b9b0
 (unless NULL) as the transient
Packit Service c6b9b0
parent of any created windows/dialogs.

Packit Service c6b9b0

Implementations should run the default main loop while

Packit Service c6b9b0
interacting with the user.

Packit Service c6b9b0

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

Packit Service c6b9b0
implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

client

Packit Service c6b9b0

A GoaClient.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject with a GoaAccount interface.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

parent

Packit Service c6b9b0

Transient parent of dialogs or NULL.

Packit Service c6b9b0
[allow-none]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

error

Packit Service c6b9b0

Return location for error or NULL.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

TRUE if the account has been refreshed, FALSE if error

Packit Service c6b9b0
is set.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_show_account ()

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

Method used to add widgets in the control panel for the account

Packit Service c6b9b0
represented by object
Packit Service c6b9b0
.

Packit Service c6b9b0

This is a virtual method where the default implementation adds

Packit Service c6b9b0
one GtkSwitch per service supported by the provider (as reported
Packit Service c6b9b0
by goa_provider_get_provider_features()).

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

client

Packit Service c6b9b0

A GoaClient.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject with a GoaAccount interface.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

vbox

Packit Service c6b9b0

A vertically oriented GtkBox to put content in.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

grid

Packit Service c6b9b0

A GtkGrid to put content in.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

dummy

Packit Service c6b9b0

Unused.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_ensure_credentials ()

Packit Service c6b9b0
void
Packit Service c6b9b0
goa_provider_ensure_credentials (GoaProvider *self,
Packit Service c6b9b0
                                 GoaObject *object,
Packit Service c6b9b0
                                 GCancellable *cancellable,
Packit Service c6b9b0
                                 GAsyncReadyCallback callback,
Packit Service c6b9b0
                                 gpointer user_data);
Packit Service c6b9b0

Ensures that credentials for object

Packit Service c6b9b0
 are still valid.

Packit Service c6b9b0

When the result is ready, callback

Packit Service c6b9b0
 will be called in the the <GTKDOCLINK HREF="g-main-context-push-thread-default">thread-default main
Packit Service c6b9b0
loop</GTKDOCLINK> this function was called from. You can then call
Packit Service c6b9b0
goa_provider_ensure_credentials_finish() to get the result
Packit Service c6b9b0
of the operation.

Packit Service c6b9b0

This is a virtual method where the default implementation simply

Packit Service c6b9b0
throws the GOA_ERROR_NOT_SUPPORTED error. A subclass may provide
Packit Service c6b9b0
another implementation.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject with a GoaAccount interface.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

cancellable

Packit Service c6b9b0

A GCancellable or NULL.

Packit Service c6b9b0
[allow-none]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

callback

Packit Service c6b9b0

The function to call when the request is satisfied.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

user_data

Packit Service c6b9b0

Pointer to pass to callback

Packit Service c6b9b0
.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_ensure_credentials_finish ()

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

Finishes an operation started with goa_provider_ensure_credentials().

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

out_expires_in

Packit Service c6b9b0

Return location for how long the expired credentials are good for (0 if unknown) or NULL.

Packit Service c6b9b0
[out]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

res

Packit Service c6b9b0

A GAsyncResult obtained from the GAsyncReadyCallback passed to goa_provider_ensure_credentials().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

error

Packit Service c6b9b0

Return location for error or NULL.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

TRUE if the credentials for the passed GoaObject are valid, FALSE if error

Packit Service c6b9b0
is set.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_ensure_credentials_sync ()

Packit Service c6b9b0
gboolean
Packit Service c6b9b0
goa_provider_ensure_credentials_sync (GoaProvider *self,
Packit Service c6b9b0
                                      GoaObject *object,
Packit Service c6b9b0
                                      gint *out_expires_in,
Packit Service c6b9b0
                                      GCancellable *cancellable,
Packit Service c6b9b0
                                      GError **error);
Packit Service c6b9b0

Like goa_provider_ensure_credentials() but blocks the

Packit Service c6b9b0
calling thread until an answer is received.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

object

Packit Service c6b9b0

A GoaObject with a GoaAccount interface.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

out_expires_in

Packit Service c6b9b0

Return location for how long the expired credentials are good for (0 if unknown) or NULL.

Packit Service c6b9b0
[out]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

cancellable

Packit Service c6b9b0

A GCancellable or NULL.

Packit Service c6b9b0
[allow-none]
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

error

Packit Service c6b9b0

Return location for error or NULL.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

TRUE if the credentials for the passed GoaObject are valid, FALSE if error

Packit Service c6b9b0
is set.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_credentials_generation ()

Packit Service c6b9b0
guint
Packit Service c6b9b0
goa_provider_get_credentials_generation
Packit Service c6b9b0
                               (GoaProvider *self);
Packit Service c6b9b0

Gets the generation of credentials being used for the provider.

Packit Service c6b9b0

Implementations should bump this number when changes are introduced

Packit Service c6b9b0
that may render existing credentials unusable.

Packit Service c6b9b0

For example, if an additional scope is requested (e.g. access to

Packit Service c6b9b0
contacts data) while obtaining credentials, then this number needs
Packit Service c6b9b0
to be bumped since existing credentials are not good for the added
Packit Service c6b9b0
scope.

Packit Service c6b9b0

This is a virtual method where the default implementation returns

Packit Service c6b9b0
0.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

self

Packit Service c6b9b0

A GoaProvider.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

The current generation of credentials.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_all ()

Packit Service c6b9b0
void
Packit Service c6b9b0
goa_provider_get_all (GAsyncReadyCallback callback,
Packit Service c6b9b0
                      gpointer user_data);
Packit Service c6b9b0

Creates a list of all the available GoaProvider instances.

Packit Service c6b9b0

When the result is ready, callback

Packit Service c6b9b0
 will be called in the the <GTKDOCLINK HREF="g-main-context-push-thread-default">thread-default main
Packit Service c6b9b0
loop</GTKDOCLINK> this function was called from. You can then call
Packit Service c6b9b0
goa_provider_get_all_finish() to get the result of the operation.

Packit Service c6b9b0

See goa_provider_get_for_provider_type() for details on how the providers

Packit Service c6b9b0
are found.

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

callback

Packit Service c6b9b0

The function to call when the request is satisfied.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

user_data

Packit Service c6b9b0

Pointer to pass to callback

Packit Service c6b9b0
.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

goa_provider_get_for_provider_type ()

Packit Service c6b9b0
GoaProvider *
Packit Service c6b9b0
goa_provider_get_for_provider_type (const gchar *provider_type);
Packit Service c6b9b0

Returns a GoaProvider for provider_type

Packit Service c6b9b0
 (if available).

Packit Service c6b9b0

If provider_type

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

Packit Service c6b9b0

If provider_type

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

Packit Service c6b9b0
Packit Service c6b9b0

Parameters

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

provider_type

Packit Service c6b9b0

A provider type.

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Returns

Packit Service c6b9b0

A GoaProvider (that must be freed

Packit Service c6b9b0
with g_object_unref()) or NULL if not found. 

Packit Service c6b9b0

[transfer full]

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Types and Values

Packit Service c6b9b0
Packit Service c6b9b0

GoaProvider

Packit Service c6b9b0
typedef struct _GoaProvider GoaProvider;
Packit Service c6b9b0

The GoaProvider structure contains only private data and should

Packit Service c6b9b0
only be accessed using the provided API.

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

GoaProviderClass

Packit Service c6b9b0
typedef struct {
Packit Service c6b9b0
  GObjectClass parent_class;
Packit Service c6b9b0
Packit Service c6b9b0
  /* pure virtual */
Packit Service c6b9b0
  GoaObject              *(*add_account)                  (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaClient              *client,
Packit Service c6b9b0
                                                           GtkDialog              *dialog,
Packit Service c6b9b0
                                                           GtkBox                 *vbox,
Packit Service c6b9b0
                                                           GError                **error);
Packit Service c6b9b0
  GoaProviderFeatures     (*get_provider_features)        (GoaProvider            *self);
Packit Service c6b9b0
  GoaProviderGroup        (*get_provider_group)           (GoaProvider            *self);
Packit Service c6b9b0
  gchar                  *(*get_provider_name)            (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaObject              *object);
Packit Service c6b9b0
  const gchar            *(*get_provider_type)            (GoaProvider            *self);
Packit Service c6b9b0
  gboolean                (*refresh_account)              (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaClient              *client,
Packit Service c6b9b0
                                                           GoaObject              *object,
Packit Service c6b9b0
                                                           GtkWindow              *parent,
Packit Service c6b9b0
                                                           GError                **error);
Packit Service c6b9b0
Packit Service c6b9b0
  /* virtual but with default implementation */
Packit Service c6b9b0
  gboolean                (*build_object)                 (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaObjectSkeleton      *object,
Packit Service c6b9b0
                                                           GKeyFile               *key_file,
Packit Service c6b9b0
                                                           const gchar            *group,
Packit Service c6b9b0
                                                           GDBusConnection        *connection,
Packit Service c6b9b0
                                                           gboolean                just_added,
Packit Service c6b9b0
                                                           GError                **error);
Packit Service c6b9b0
  gboolean                (*ensure_credentials_sync)      (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaObject              *object,
Packit Service c6b9b0
                                                           gint                   *out_expires_in,
Packit Service c6b9b0
                                                           GCancellable           *cancellable,
Packit Service c6b9b0
                                                           GError                **error);
Packit Service c6b9b0
  guint                   (*get_credentials_generation)   (GoaProvider            *self);
Packit Service c6b9b0
  GIcon                  *(*get_provider_icon)            (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaObject              *object);
Packit Service c6b9b0
  void                    (*initialize)                   (GoaProvider            *self);
Packit Service c6b9b0
  void                    (*remove_account)               (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaObject              *object,
Packit Service c6b9b0
                                                           GCancellable           *cancellable,
Packit Service c6b9b0
                                                           GAsyncReadyCallback     callback,
Packit Service c6b9b0
                                                           gpointer                user_data);
Packit Service c6b9b0
  gboolean                (*remove_account_finish)        (GoaProvider            *self,
Packit Service c6b9b0
                                                           GAsyncResult           *res,
Packit Service c6b9b0
                                                           GError                **error);
Packit Service c6b9b0
  void                    (*show_account)                 (GoaProvider            *self,
Packit Service c6b9b0
                                                           GoaClient              *client,
Packit Service c6b9b0
                                                           GoaObject              *object,
Packit Service c6b9b0
                                                           GtkBox                 *vbox,
Packit Service c6b9b0
                                                           GtkGrid                *dummy1,
Packit Service c6b9b0
                                                           GtkGrid                *dummy2);
Packit Service c6b9b0
} GoaProviderClass;
Packit Service c6b9b0
Packit Service c6b9b0

Class structure for GoaProvider.

Packit Service c6b9b0
Packit Service c6b9b0

Members

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

add_account ()

Packit Service c6b9b0

Virtual function for goa_provider_add_account().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_provider_features ()

Packit Service c6b9b0

Virtual function for goa_provider_get_provider_features().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_provider_group ()

Packit Service c6b9b0

Virtual function for goa_provider_get_provider_group().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_provider_name ()

Packit Service c6b9b0

Virtual function for goa_provider_get_provider_name().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_provider_type ()

Packit Service c6b9b0

Virtual function for goa_provider_get_provider_type().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

refresh_account ()

Packit Service c6b9b0

Virtual function for goa_provider_refresh_account().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

build_object ()

Packit Service c6b9b0

Virtual function for goa_provider_build_object().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

ensure_credentials_sync ()

Packit Service c6b9b0

Virtual function for goa_provider_ensure_credentials_sync().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_credentials_generation ()

Packit Service c6b9b0

Virtual function for goa_provider_get_credentials_generation().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

get_provider_icon ()

Packit Service c6b9b0

Virtual function for goa_provider_get_provider_icon().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

initialize ()

Packit Service c6b9b0

Virtual function for goa_provider_initialize().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

remove_account ()

Packit Service c6b9b0
 
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

remove_account_finish ()

Packit Service c6b9b0
 
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

show_account ()

Packit Service c6b9b0

Virtual function for goa_provider_show_account().

Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

enum GoaProviderGroup

Packit Service c6b9b0

An enum for specifying which group a provider belongs to. This is

Packit Service c6b9b0
can be used to organize the providers while displaying them in an
Packit Service c6b9b0
user interface.

Packit Service c6b9b0
Packit Service c6b9b0

Members

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_BRANDED

Packit Service c6b9b0
Packit Service c6b9b0

Providers with a well-known brand. For

Packit Service c6b9b0
  example, Google and Facebook.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_CONTACTS

Packit Service c6b9b0
Packit Service c6b9b0

Providers that offer address book services.

Packit Service c6b9b0
  For example, CardDAV.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_MAIL

Packit Service c6b9b0
Packit Service c6b9b0

Providers that offer email-like messaging

Packit Service c6b9b0
  services. For example, IMAP and SMTP.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_TICKETING

Packit Service c6b9b0
Packit Service c6b9b0

Providers with ticketing

Packit Service c6b9b0
  capabilities. For example, Kerberos.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_CHAT

Packit Service c6b9b0
Packit Service c6b9b0

Providers that offer chat-like messaging

Packit Service c6b9b0
  capabilities. For example, XMPP, IRC.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_GROUP_INVALID

Packit Service c6b9b0
Packit Service c6b9b0

Used for error handling. No provider

Packit Service c6b9b0
  should belong to this group.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

enum GoaProviderFeatures

Packit Service c6b9b0

These flags specify the features exported by each provider. They can be

Packit Service c6b9b0
expecially useful to restrict the list of available providers when
Packit Service c6b9b0
requesting the creation of an account for a specific purpose (eg. from a
Packit Service c6b9b0
chat program).

Packit Service c6b9b0
Packit Service c6b9b0

Members

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_BRANDED

Packit Service c6b9b0
Packit Service c6b9b0

Common providers to be highlighted (ie. Google, OwnCloud).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_MAIL

Packit Service c6b9b0
Packit Service c6b9b0

Mail services (ie. SMTP, IMAP).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_CALENDAR

Packit Service c6b9b0
Packit Service c6b9b0

Calendaring services (ie. CalDAV).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_CONTACTS

Packit Service c6b9b0
Packit Service c6b9b0

Addressbook services (ie. CardDAV).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_CHAT

Packit Service c6b9b0
Packit Service c6b9b0

Instant messaging services (ie. XMPP, IRC).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_DOCUMENTS

Packit Service c6b9b0
Packit Service c6b9b0

Documents storage services (ie. Google Documents).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_PHOTOS

Packit Service c6b9b0
Packit Service c6b9b0

Photos storage services (ie. Flickr).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_FILES

Packit Service c6b9b0
Packit Service c6b9b0

Files storage services (ie. WebDAV).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_TICKETING

Packit Service c6b9b0
Packit Service c6b9b0

Ticketing services (ie. Kerberos).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_READ_LATER

Packit Service c6b9b0
Packit Service c6b9b0

Read later services (eg. Pocket).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_PRINTERS

Packit Service c6b9b0
Packit Service c6b9b0

Network printing services (e.g. Google Cloud Print).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_MAPS

Packit Service c6b9b0
Packit Service c6b9b0

Maps related services (e.g. Foursquare, Facebook).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_MUSIC

Packit Service c6b9b0
Packit Service c6b9b0

Music related services (e.g. Vkontakte).

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_TODO

Packit Service c6b9b0
 
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_FEATURE_INVALID

Packit Service c6b9b0
Packit Service c6b9b0

Used for error handling. No provider

Packit Service c6b9b0
  should provide this feature.

Packit Service c6b9b0
Packit Service c6b9b0
 
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Since: 3.10

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

GOA_PROVIDER_EXTENSION_POINT_NAME

Packit Service c6b9b0
#define GOA_PROVIDER_EXTENSION_POINT_NAME "goa-backend-provider"
Packit Service c6b9b0
Packit Service c6b9b0

Extension point for GoaProvider implementations.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Property Details

Packit Service c6b9b0
Packit Service c6b9b0

The “preseed-data” property

Packit Service c6b9b0
  “preseed-data”             GVariant *
Packit Service c6b9b0

An GVariant of type a{sv} storing any information already collected that

Packit Service c6b9b0
can be useful when creating a new account. For instance, this can be useful
Packit Service c6b9b0
to reuse the HTTP cookies from an existing browser session to skip the
Packit Service c6b9b0
prompt for username and password in the OAuth2-based providers by passing
Packit Service c6b9b0
a GVariant with the following contents:

Packit Service c6b9b0
Packit Service c6b9b0
  
Packit Service c6b9b0
    
Packit Service c6b9b0
      
Packit Service c6b9b0
        
1
Packit Service c6b9b0
2
Packit Service c6b9b0
3
Packit Service c6b9b0
4
Packit Service c6b9b0
5
Packit Service c6b9b0
6
Packit Service c6b9b0
7
Packit Service c6b9b0
8
Packit Service c6b9b0
9
Packit Service c6b9b0
10
Packit Service c6b9b0
11
Packit Service c6b9b0
12
Packit Service c6b9b0
13
Packit Service c6b9b0
14
Packit Service c6b9b0
        
{
Packit Service c6b9b0
  "cookies": [
Packit Service c6b9b0
    {
Packit Service c6b9b0
      "domain": "example.com",
Packit Service c6b9b0
      "name": "LSID",
Packit Service c6b9b0
      "value": "asdfasdfasdf"
Packit Service c6b9b0
    },
Packit Service c6b9b0
    {
Packit Service c6b9b0
      "domain": "accounts.example.com",
Packit Service c6b9b0
      "name": "SSID",
Packit Service c6b9b0
      "value": "asdfasdfasdf"
Packit Service c6b9b0
    }
Packit Service c6b9b0
  ]
Packit Service c6b9b0
}
Packit Service c6b9b0
      
Packit Service c6b9b0
    
Packit Service c6b9b0
  
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Unknown or unsupported keys will be ignored by providers.

Packit Service c6b9b0
Packit Service c6b9b0

GoaProvider:preseed-data has been deprecated since version 3.28 and should not be used in newly-written code.

Packit Service c6b9b0

This property does nothing.

Packit Service c6b9b0
Packit Service c6b9b0

Flags: Read / Write

Packit Service c6b9b0

Allowed values: GVariant<a{sv}>

Packit Service c6b9b0

Default value: NULL

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Generated by GTK-Doc V1.28
Packit Service c6b9b0
</body>
Packit Service c6b9b0
</html>