TTMSFNCCloudOAuthAuthentication Class
Stores OAuth credentials, callback settings, and issued access tokens for a cloud service.
API unit family: TMSFNCCloudOAuth
Inherits from: TPersistent
Syntax
TTMSFNCCloudOAuthAuthentication = class(TPersistent)
Remarks
Use this object through TTMSFNCCustomCloudOAuth.Authentication to provide client credentials and inspect the tokens returned by the provider.
Properties
| Name | Description |
|---|---|
| AccessToken | Stores the access token used to authorize API requests. |
| AccessTokenExpiry | Stores the date and time when AccessToken expires. |
| AccessTokenRefresh | Stores the refresh token used to obtain a new access token. |
| AccessTokenSecret | Stores the secret paired with AccessToken when the provider uses token secrets. |
| AuthenticationToken | Stores the temporary authentication token returned during the OAuth flow. |
| AuthenticationTokenSecret | Stores the secret paired with AuthenticationToken when the provider uses token secrets. |
| CallBackURL | Specifies the callback URL registered with the OAuth provider. |
| ClientID | Specifies the OAuth client ID issued by the provider. |
| Key | Specifies the provider key or API key used by services that require one. |
| Locale | Specifies the locale sent to providers that support localized OAuth pages or responses. |
| Secret | Specifies the OAuth client secret issued by the provider. |
| ServerPort | Specifies the local HTTP server port used to receive OAuth callback requests. |
Methods
| Name | Description |
|---|---|
| CallBackPort | Returns the port number parsed from CallBackURL. |
| ClearTokens | Clears the access, refresh, and authentication token values. |
| IsAccessTokenValid | Indicates whether the current access token is still valid. |
| IsHTTPS | Indicates whether the callback URL uses HTTPS. |