AuthGoogle Delphi DLL Reference Documentation

AuthGoogle

Current Version: 11.1.0

Provides functionality for authenticating calls to the Google Cloud Platform API and Google Apps API using a service account.

Create/Dispose

var
myObject: HCkAuthGoogle;

begin
myObject := CkAuthGoogle_Create();

// ...

CkAuthGoogle_Dispose(myObject);
end;
function CkAuthGoogle_Create: HCkAuthGoogle; stdcall;

Creates an instance of the HCkAuthGoogle object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkAuthGoogle_Dispose(handle: HCkAuthGoogle); stdcall;

Objects created by calling CkAuthGoogle_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AccessToken
procedure CkAuthGoogle_getAccessToken(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putAccessToken(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__accessToken(objHandle: HCkAuthGoogle): PWideChar; stdcall;
Introduced in version 9.5.0.58

The access token to be used in Google API requests. This property is set on a successful call to ObtainAccessToken.

Important: This class is used for authenticating calls to the Google Cloud Platform API and Google Apps API using a service account.. For 3-legged OAuth2, where a browser must be used to interactively get permission from the Google account owner, use the Chilkat OAuth2 class/object.

See the notes about PWideChar memory ownership and validity.

top
DebugLogFilePath
procedure CkAuthGoogle_getDebugLogFilePath(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putDebugLogFilePath(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__debugLogFilePath(objHandle: HCkAuthGoogle): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
top
EmailAddress
procedure CkAuthGoogle_getEmailAddress(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putEmailAddress(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__emailAddress(objHandle: HCkAuthGoogle): PWideChar; stdcall;
Introduced in version 9.5.0.58

The client email address of the service account. If a JSON key is used, then the client_email should already be specified within the JSON key, and this property is unused. This property must be set if using a P12 key.

See the notes about PWideChar memory ownership and validity.

top
ExpireNumSeconds
function CkAuthGoogle_getExpireNumSeconds(objHandle: HCkAuthGoogle): Integer; stdcall;
procedure CkAuthGoogle_putExpireNumSeconds(objHandle: HCkAuthGoogle; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.58

The expiration time, in seconds, of the access token to be requested. The maximum value is 1 hour (3600 seconds). The default value is 3600.

top
Iat
function CkAuthGoogle_getIat(objHandle: HCkAuthGoogle): Integer; stdcall;
procedure CkAuthGoogle_putIat(objHandle: HCkAuthGoogle; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.77

This property can be set to override the default current date/time value for the iat claim of the JWT. It can be set to a value indicating the number of seconds from 1970-01-01T00:00:00Z UTC.

The default value is 0, which indicates to use the iat value for the current system date/time. Unless explicitly needed, always leave this property at the default value.

top
JsonKey
procedure CkAuthGoogle_getJsonKey(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putJsonKey(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__jsonKey(objHandle: HCkAuthGoogle): PWideChar; stdcall;
Introduced in version 9.5.0.58

The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

See the notes about PWideChar memory ownership and validity.

top
LastErrorHtml
procedure CkAuthGoogle_getLastErrorHtml(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
function CkAuthGoogle__lastErrorHtml(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastErrorText
procedure CkAuthGoogle_getLastErrorText(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
function CkAuthGoogle__lastErrorText(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastErrorXml
procedure CkAuthGoogle_getLastErrorXml(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
function CkAuthGoogle__lastErrorXml(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastMethodSuccess
function CkAuthGoogle_getLastMethodSuccess(objHandle: HCkAuthGoogle): wordbool; stdcall;
procedure CkAuthGoogle_putLastMethodSuccess(objHandle: HCkAuthGoogle; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumSecondsRemaining
function CkAuthGoogle_getNumSecondsRemaining(objHandle: HCkAuthGoogle): Integer; stdcall;
Introduced in version 9.5.0.58

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

top
Scope
procedure CkAuthGoogle_getScope(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putScope(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__scope(objHandle: HCkAuthGoogle): PWideChar; stdcall;
Introduced in version 9.5.0.58

A space-delimited list of the permissions that the application requests.

See the notes about PWideChar memory ownership and validity.

top
SubEmailAddress
procedure CkAuthGoogle_getSubEmailAddress(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
procedure CkAuthGoogle_putSubEmailAddress(objHandle: HCkAuthGoogle; newPropVal: PWideChar); stdcall;
function CkAuthGoogle__subEmailAddress(objHandle: HCkAuthGoogle): PWideChar; stdcall;
Introduced in version 9.5.0.58

The email address of the user for which the application is requesting delegated access.

See the notes about PWideChar memory ownership and validity.

top
Valid
function CkAuthGoogle_getValid(objHandle: HCkAuthGoogle): wordbool; stdcall;
Introduced in version 9.5.0.58

True if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

top
VerboseLogging
function CkAuthGoogle_getVerboseLogging(objHandle: HCkAuthGoogle): wordbool; stdcall;
procedure CkAuthGoogle_putVerboseLogging(objHandle: HCkAuthGoogle; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
procedure CkAuthGoogle_getVersion(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;
function CkAuthGoogle__version(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Version of the component/library, such as "10.1.0"

See the notes about PWideChar memory ownership and validity.

More Information and Examples
top

Methods

AddClaims
function CkAuthGoogle_AddClaims(objHandle: HCkAuthGoogle;
    json: HCkJsonObject): wordbool; stdcall;
Introduced in version 9.5.0.99

Adds additional custom claims to the JWT claims set.

Returns True for success, False for failure.

top
GetP12
function CkAuthGoogle_GetP12(objHandle: HCkAuthGoogle): HCkPfx; stdcall;
Introduced in version 9.5.0.58

Returns the private key in a PFX (P12) object. This is only possible if the private key was previously set by calling SetP12.

Returns nil on failure

top
LoadTaskCaller
function CkAuthGoogle_LoadTaskCaller(objHandle: HCkAuthGoogle;
    task: HCkTask): wordbool; stdcall;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top
ObtainAccessToken
function CkAuthGoogle_ObtainAccessToken(objHandle: HCkAuthGoogle;
    connection: HCkSocket): wordbool; stdcall;
Introduced in version 9.5.0.58

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The connection is an existing connection to www.googleapis.com.

Important: Make sure your computer's date/time is accurately set to the current date/time, otherwise you'll get a 400 response status code with this error: Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your iat and exp values and use a clock with skew to account for clock differences between systems..

Returns True for success, False for failure.

top
ObtainAccessTokenAsync (1)
function CkAuthGoogle_ObtainAccessTokenAsync(objHandle: HCkAuthGoogle;
    connection: HCkSocket): HCkTask; stdcall;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SetP12
function CkAuthGoogle_SetP12(objHandle: HCkAuthGoogle;
    key: HCkPfx): wordbool; stdcall;
Introduced in version 9.5.0.58

Sets the P12 private key to be used for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

Returns True for success, False for failure.

top

Events

AbortCheck
function MyAbortCheck(): Integer; cdecl;
Introduced in version 9.5.0.82

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return True to abort; return False to continue (not abort)

More Information and Examples
top
PercentDone
function MyPercentDone(pctDone: Integer): Integer; cdecl;
Introduced in version 9.5.0.82

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

Return True to abort; return False to continue (not abort)

More Information and Examples
top
ProgressInfo
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
Introduced in version 9.5.0.82

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples
top
TaskCompleted
procedure MyTaskCompleted(task: HCkTask) cdecl;
Introduced in version 9.5.0.82

Called from the background thread when an asynchronous task completes.

top