TdxOAuth2AuthorizationAgent.RegisterScopeRequestor(IdxOAuth2AuthorizationAgentScopeRequestor) Method

Associates the specified online data provider with the authorization agent.

Declaration

procedure RegisterScopeRequestor(const AIntf: IdxOAuth2AuthorizationAgentScopeRequestor);

Parameters

Name	Type
AIntf	IdxOAuth2AuthorizationAgentScopeRequestor

Remarks

The authorization agent iterates through its internal list of associated online data providers and calls each GetScopes function they implement to use the returned results as a part of HTTP requests to an OAuth 2.0 authentication server to obtain all account access permissions the data providers need. The RegisterScopeRequestor and UnregisterScopeRequestor procedures manage the list of associated data providers that require specific account access permissions to work with online resources on behalf of an end-user.

You can call the RegisterScopeRequestor procedure to add the custom OAuth 2.0 online data provider passed as the AIntf parameter to the authorization agent’s list of account access scope requestors. A data provider must implement the IdxOAuth2AuthorizationAgentScopeRequestor interface. All DevExpress online data providers call this procedure internally to be able to request specific account access permissions via an OAuth 2.0-compatible authorization agent. Refer to the corresponding data provider class descriptions for additional information.

Note

RegisterScopeRequestor calls the RefreshScopes procedure internally to update the list of account access permissions according to the expanded list of associated data providers on the next attempt to authorize the agent in an online account.