AuthGoogle DataFlex Reference Documentation

AuthGoogle

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

Object Creation

Handle hoAuthGoogle
Get Create(RefClass(cComChilkatAuthGoogle)) to hoAuthGoogle

Properties

Function ComAccessToken Returns String
Procedure Set ComAccessToken String value

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.

Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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.

Function ComEmailAddress Returns String
Procedure Set ComEmailAddress String value

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 ComExpireNumSeconds Returns Integer
Procedure Set ComExpireNumSeconds Integer value

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.

Function ComJsonKey Returns String
Procedure Set ComJsonKey String value

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

Function ComLastBinaryResult Returns Variant

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

Function ComLastErrorHtml Returns String

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.

Function ComLastErrorText Returns String

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

Function ComLastErrorXml Returns String

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 ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

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 ComLastStringResult Returns String

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

Function ComLastStringResultLen Returns Integer

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

Function ComNumSecondsRemaining Returns Integer

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.

Function ComScope Returns String
Procedure Set ComScope String value

Introduced in version 9.5.0.58

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

Function ComSubEmailAddress Returns String
Procedure Set ComSubEmailAddress String value

Introduced in version 9.5.0.58

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

Function ComValid Returns Boolean

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 ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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.

Function ComVersion Returns String

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

Methods

Function ComGetP12 Returns cComChilkatPfx

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 null on failure

Function ComObtainAccessToken cComChilkatSocket connection Returns Boolean

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 ComObtainAccessTokenAsync cComChilkatSocket connection Returns cComChilkatTask

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 null on failure

How to Run an Asynchronous Task

Function ComSetP12 cComChilkatPfx key Returns Boolean

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