Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

client_id?: string

A client ID for your application (see the reference documentation).

It is recommended that the ID is of the form company name- application name- version ID.

client_secret?: string

Client secret provided by Google. This is unique for each application and is accessible from Google’s Developer Console when registering an application. It must be paired with the #GDataOAuth2Authorizer:client-id.

See the reference documentation for details.

locale?: string

The locale to use for network requests, in UNIX locale format. (e.g. "en_GB", "cs", "de_DE".) Use %NULL for the default "C" locale (typically "en_US").

This locale will be used by the server-side software to localise the authentication and authorization pages at the URI returned by gdata_oauth2_authorizer_build_authentication_uri().

The server-side behaviour is undefined if it doesn't support a given locale.

proxy_resolver?: Gio.ProxyResolver

The #GProxyResolver used to determine a proxy URI.

redirect_uri?: string

Redirect URI to send the response from the authorisation request to. This must either be %GDATA_OAUTH2_REDIRECT_URI_OOB, %GDATA_OAUTH2_REDIRECT_URI_OOB_AUTO, or a http://localhost URI with any port number (optionally) specified.

This URI is where the authorisation server will redirect the user after they have completed interacting with the authentication page (gdata_oauth2_authorizer_build_authentication_uri()). If it is %GDATA_OAUTH2_REDIRECT_URI_OOB, a page will be returned in the user’s browser with the authorisation code in its title and also embedded in the page for the user to copy if it is not possible to automatically extract the code from the page title. If it is %GDATA_OAUTH2_REDIRECT_URI_OOB_AUTO, a similar page will be returned with the authorisation code in its title, but without displaying the code to the user — the user will simply be asked to close the page. If it is a localhost URI, the authentication page will redirect to that URI with the authorisation code appended as a code query parameter. If the user denies the authentication request, the authentication page will redirect to that URI with error=access_denied appended as a query parameter.

Note that the redirect URI used must match that registered in Google’s Developer Console for your application.

See the reference documentation for details about choosing a redirect URI.

refresh_token?: string

The server provided refresh token, which can be stored and passed in to new #GDataOAuth2Authorizer instances before calling gdata_authorizer_refresh_authorization_async() to create a new short-lived access token.

The refresh token is opaque data and must not be parsed.

timeout?: number

A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be cancelled and %GDATA_SERVICE_ERROR_NETWORK_ERROR will be returned.

If the timeout is 0, operations will never time out.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method