AuthGoogle Delphi DLL Reference Documentation

AuthGoogle

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

Create/Dispose

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

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.

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, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

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.

Get Google API Access Token using P12 Service Account Key

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.

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.

Get Google API Access Token using JSON Private Key

procedure CkAuthGoogle_getLastErrorHtml(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;

function CkAuthGoogle__lastErrorHtml(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

procedure CkAuthGoogle_getLastErrorText(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;

function CkAuthGoogle__lastErrorText(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

procedure CkAuthGoogle_getLastErrorXml(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;

function CkAuthGoogle__lastErrorXml(objHandle: HCkAuthGoogle): PWideChar; stdcall;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

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

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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.

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.

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.

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.

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.

procedure CkAuthGoogle_getVersion(objHandle: HCkAuthGoogle; outPropVal: HCkString); stdcall;

function CkAuthGoogle__version(objHandle: HCkAuthGoogle): PWideChar; stdcall;

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

Methods

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

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.

Returns True for success, False for failure.

Get Google API Access Token using JSON Private Key

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. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns nil on failure

How to Run an Asynchronous Task

function CkAuthGoogle_SaveLastError(objHandle: HCkAuthGoogle;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

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.

Get Google API Access Token using P12 Service Account Key