Method

EBackendBackendschedule_authenticate

since: 3.16

Declaration [src]

void
e_backend_schedule_authenticate (
  EBackend* backend,
  const ENamedParameters* credentials
)

Description [src]

Schedules a new authenticate session, cancelling any previously run. This is usually done automatically, when an ‘authenticate’ signal is received for the associated ESource. With NULL credentials an attempt without it is run.

This is also the right entry point for sources authenticating with OAuth2: the EBackendClass.authenticate_sync() implementation can obtain the access token silently, for example with e_source_get_oauth2_access_token_sync(), while e_backend_schedule_credentials_required() would always open an interactive prompt for them.

Available since: 3.16

Parameters

credentials

Type: ENamedParameters

A credentials to use to authenticate, or NULL.

The argument can be NULL.

The data is owned by the caller of the method.