TTMSFNCCloudOAuth Class
OAuth-enabled cloud service component base class exposed to the designer.
API unit family: TMSFNCCloudOAuth
Inherits from: TTMSFNCCustomCloudOAuth
Syntax
TTMSFNCCloudOAuth = class(TTMSFNCCustomCloudOAuth)
Remarks
Use descendant cloud service components for provider-specific APIs; this class exposes the shared authentication, persistence, and callback events.
Properties
| Name | Description |
|---|---|
| Authentication | Provides the credentials, callback URL, and token values used by the OAuth flow. (inherited from TTMSFNCCustomCloudOAuth) |
| PersistTokens | Configures how OAuth tokens are loaded from and saved to persistent storage. (inherited from TTMSFNCCustomCloudOAuth) |
Methods
| Name | Description |
|---|---|
| Authenticate | Starts the OAuth authentication workflow. (inherited from TTMSFNCCustomCloudOAuth) |
| ClearTokens | Clears the current token values and removes the persisted token data when applicable. (inherited from TTMSFNCCustomCloudOAuth) |
| Connect | Connects to the cloud service, loading tokens and authenticating when needed. (inherited from TTMSFNCCustomCloudOAuth) |
| DestroyHTTPServer | Stops and releases the local HTTP callback server used by the OAuth flow. (inherited from TTMSFNCCustomCloudOAuth) |
| FetchAccessToken | Starts authentication and resolves with the current access token. (inherited from TTMSFNCCustomCloudOAuth) |
| LoadTokens | Loads persisted credentials and token values according to PersistTokens. (inherited from TTMSFNCCustomCloudOAuth) |
| SaveTokens | Saves the current credentials and token values according to PersistTokens. (inherited from TTMSFNCCustomCloudOAuth) |
| TestTokens | Tests whether the current access tokens are accepted by the provider. (inherited from TTMSFNCCustomCloudOAuth) |
Events
| Name | Description |
|---|---|
| OnAccessDenied | Occurs when the OAuth provider rejects or denies the authorization request. (inherited from TTMSFNCCustomCloudOAuth) |
| OnAuthenticated | Occurs after authentication data is received from the OAuth provider. (inherited from TTMSFNCCustomCloudOAuth) |
| OnBeforeRunExternalBrowser | Occurs before the component opens the external authorization URL. (inherited from TTMSFNCCustomCloudOAuth) |
| OnConfigureHTTPServer | Occurs after the local HTTP callback server has been created and can be customized. (inherited from TTMSFNCCustomCloudOAuth) |
| OnConfigureHTTPServerSSLHandler | Occurs after the local HTTPS callback server SSL handler has been created and can be customized. (inherited from TTMSFNCCustomCloudOAuth) |
| OnConnected | Occurs after the component finishes the connect workflow successfully. (inherited from TTMSFNCCustomCloudOAuth) |
| OnGetAuthorizationPageHTML | Occurs before the callback page HTML is returned to the authorization browser. (inherited from TTMSFNCCustomCloudOAuth) |
| OnRequestTestTokensResult | Occurs after a token validation request returns its result. (inherited from TTMSFNCCustomCloudOAuth) |