Virtual Method

EBackendOAuth2Supportget_access_token_finish

since: 3.8

Declaration [src]

gboolean
get_access_token_finish (
  EOAuth2Support* support,
  GAsyncResult* result,
  gchar** out_access_token,
  gint* out_expires_in,
  GError** error
)

Description [src]

Finishes the operation started with e_oauth2_support_get_access_token().

Free the returned access token with g_free() when finished with it. If an error occurred, the function will set error and return FALSE.

Available since: 3.8

Parameters

result

Type: GAsyncResult

A GAsyncResult.

The data is owned by the caller of the method.
out_access_token

Type: gchar**

Return location for the access token, or NULL.

The argument will be set by the function.
The argument can be NULL.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
out_expires_in

Type: gint*

Return location for the token expiry, or NULL.

The argument will be set by the function.
The argument can be NULL.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the virtual function if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE on success, FALSE on failure.