Back to Devexpress

TdxMicrosoftGraphAPIOAuth2AuthorizationAgent Members

vcl-dxauthorizationagents-dot-tdxmicrosoftgraphapioauth2authorizationagent-dot-underscore-members.md

latest20.3 KB
Original Source

TdxMicrosoftGraphAPIOAuth2AuthorizationAgent Members

A non-visual component designed to authorize your application in a Microsoft online account.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
AccessTokenReturns the online account access token. Inherited from TdxOAuth2AuthorizationAgent.
AccessTokenExpiresInReturns the account access token expiration time, in seconds. Inherited from TdxOAuth2AuthorizationAgent.
AccessTokenTypeReturns the account access token’s type name. Inherited from TdxOAuth2AuthorizationAgent.
AdditionalScopesSpecifies account access scopes. Inherited from TdxOAuth2AuthorizationAgent.
ClientIDSpecifies the OAuth 2.0 unique client identifier. Inherited from TdxOAuth2AuthorizationAgent.
ClientSecretSpecifies the OAuth 2.0 client secret. Inherited from TdxOAuth2AuthorizationAgent.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
DesignInfoInherited from TComponent.
IsAuthorizedIdentifies if the agent is successfully authorized in an online account. Inherited from TdxCustomAuthorizationAgent.
NameInherited from TComponent.
ObserversInherited from TComponent.
OwnerInherited from TComponent.
RedirectUriSpecifies the universal resource identifier to receive an OAuth 2.0 account access token. Inherited from TdxOAuth2AuthorizationAgent.
RefreshTokenReturns the refresh token that the authorization agent uses. Inherited from TdxOAuth2AuthorizationAgent.
TagInherited from TComponent.
UserAgentSpecifies the authorization agent’s user agent string. Inherited from TdxCustomAuthorizationAgent.
VCLComObjectInherited from TComponent.

Methods

NameDescription
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject)Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject)Inherited from TComponent.
BeginInvoke(TProc,TObject)Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject)Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject)Inherited from TComponent.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FindComponent(String)Inherited from TComponent.
FinishAuthorizationPerforms all routines required to properly terminate the current authorization session. Inherited from TdxCustomAuthorizationAgent.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetAuthorizationHeaderInherited from TdxCustomAuthorizationAgent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetHashCodeInherited from TObject.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
HasParentInherited from TComponent.
InsertComponent(TComponent)Inherited from TComponent.
IsAccessTokenValidIdentifies if the authorization agent has a valid account access token. Inherited from TdxOAuth2AuthorizationAgent.
IsImplementorOf(IInterface)Inherited from TComponent.
Load(string,string,string)Assigns the specified access and refresh tokens to the authorization agent. Inherited from TdxOAuth2AuthorizationAgent.
LoadedInherited from TComponent.
Notification(TComponent,TOperation)Inherited from TComponent.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RefreshAccessTokenUpdates the account access token. Inherited from TdxOAuth2AuthorizationAgent.
RefreshScopes(Boolean)Updates the list of active online account access scopes. Inherited from TdxOAuth2AuthorizationAgent.
RegisterScopeRequestor(IdxOAuth2AuthorizationAgentScopeRequestor)Associates the specified online data provider with the authorization agent. Inherited from TdxOAuth2AuthorizationAgent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RestartAuthorizationRestarts the current authorization session. Inherited from TdxCustomAuthorizationAgent.
RevokeAccessTokenRenders the account access and refresh tokens invalid and terminates the current authorization session. Inherited from TdxOAuth2AuthorizationAgent.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
StartAuthorizationPerforms all routines required to authorize the agent in an online account. Inherited from TdxCustomAuthorizationAgent.
ToStringInherited from TObject.
UnregisterScopeRequestor(IdxOAuth2AuthorizationAgentScopeRequestor)Disconnects the specified online data provider from the authorization agent. Inherited from TdxOAuth2AuthorizationAgent.
UpdateAction(TBasicAction)Inherited from TComponent.
ValidateAccessTokenValidates the account access token. Inherited from TdxOAuth2AuthorizationAgent.
ValidateAuthorizationInherited from TdxCustomAuthorizationAgent.

Events

NameDescription
OnErrorNotifies of an error occurring in the authorization agent. Inherited from TdxCustomAuthorizationAgent.
OnFinishAuthorizationNotifies of a successful termination of the current authorization session. Inherited from TdxCustomAuthorizationAgent.
OnGetClientSecretOccurs on an attempt to authorize in an online account via the OAuth 2.0 authentication protocol. Inherited from TdxOAuth2AuthorizationAgent.
OnReceiveAccessTokenOccurs on an attempt to receive an OAuth 2.0 account access token. Inherited from TdxOAuth2AuthorizationAgent.
OnReceiveAuthorizationCode protectedOccurs on an attempt to receive an OAuth 2.0 authorization code. Inherited from TdxOAuth2AuthorizationAgent.
OnStartAuthorizationNotifies of a successful start of the authorization session. Inherited from TdxCustomAuthorizationAgent.

Constants

NameDescription
DefaultClientIDSpecifies the default OAuth 2.0 client identifier for a Microsoft Graph® API-compatible authorization agent component.
DefaultClientSecretSpecifies the default OAuth 2.0 client secret for a Microsoft Graph® API-compatible authorization agent component.

See Also

TdxMicrosoftGraphAPIOAuth2AuthorizationAgent Class

dxAuthorizationAgents Unit