Skip to main content

TdxOAuth2AuthorizationAgentUserInfo.GetScopes Method

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

Declaration

function GetScopes: TStringList; virtual; abstract;

Returns

Type Description
TStringList

A string list populated with account visibility scopes.

Remarks

The user information provider’s OAuth 2.0-compatible authorization agent calls the GetScopes function internally via the IdxOAuth2AuthorizationAgentScopeRequestor interface to request the permissions required to retrieve user data (such as e-mail and display name) from a connected online account.

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

See Also