OAuthClient object

The OAuthClient object provides interfaces for obtaining the OAuth 2.0 access token and accessing the protected resources. For more information about using OAuthClient with OAuth 2.0, see the section called “Supporting OAuth 2.0 Authorization Server”.

Note

OAuthClient (as well as HTTPClient, RESTClient, CrypterObject, CoderObject, CompressorObject, DotNetAssembly, JSONGenerator, JSONParser, JSONPackage, PDF Builder objects, SMTPClient, PowerServerLabel, PowerServerResult) does not support multi-threading.

Note

If the default properties of OAuthClient do not provide all the parameters required by the OAuth authorization server, use the TokenRequest.AppendParam function to add custom parameters to the token request. For examples of using custom token request parameters, see the section called “Supporting OAuth 2.0 Authorization Server”.

Properties

OAuthClient property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.


Events

OAuthClient event

Occurs

Constructor

Immediately before the Open event occurs in the window.

Destructor

Immediately after the Close event occurs in the window.


Functions

OAuthClient function

Datatype returned

Description

AccessToken

Integer

Sends a request to get token information.

ClassName

String

Returns the name assigned to the object.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

PostEvent

Boolean

Adds the specified event to the end of the event queue for the specified object.

RequestResource

Integer

Sends a request to get resource.

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event

TypeOf

Object

Returns the type of the object.