Skip to main content

TcxSchedulerWebServiceStorageOAuth2CustomProvider.GetScopes Method

Returns the list of online account visibility scopes (that is, account data access permissions) that the event data provider requests on a successful connection.

Declaration

function GetScopes: TStringList; virtual;

Returns

Type
TStringList

Remarks

The authorization agent associated with the OAuth 2.0-compabitle online event data provider calls the GetScopes function internally via the IdxOAuth2AuthorizationAgentScopeRequestor interface to request all data access permissions required to work with online calendars in a connected account. The returned list of permissions depends on the ReadOnly property value. Every time it changes, the associated authorization agent updates its list of access permissions and restarts an established connection to an online account.

Each TcxSchedulerWebServiceStorageOAuth2CustomProvider class descendant implements its GetScopes function, so it returns a list of data access permission strings specific to a particular online account type.

See Also