AuthGoogle ActiveX Reference Documentation

AuthGoogle

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

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatAuthGoogle

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.AuthGoogle")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.AuthGoogle")

(Delphi)
obj := TChilkatAuthGoogle.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.AuthGoogle')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.AuthGoogle")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.AuthGoogle', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.AuthGoogle");

Properties

AccessToken As String

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.

DebugLogFilePath As String

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.

EmailAddress As String

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.

(Classic ASP) Get Google API Access Token using P12 Service Account Key

(Visual FoxPro) Get Google API Access Token using P12 Service Account Key

(PowerBuilder) Get Google API Access Token using P12 Service Account Key

(SQL Server) Get Google API Access Token using P12 Service Account Key

(Visual Basic 6.0) Get Google API Access Token using P12 Service Account Key

(VBScript) Get Google API Access Token using P12 Service Account Key

ExpireNumSeconds As Long

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.

JsonKey As String

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.

(Classic ASP) Get Google API Access Token using JSON Private Key

(Visual FoxPro) Get Google API Access Token using JSON Private Key

(PowerBuilder) Get Google API Access Token using JSON Private Key

(SQL Server) Get Google API Access Token using JSON Private Key

(Visual Basic 6.0) Get Google API Access Token using JSON Private Key

(VBScript) Get Google API Access Token using JSON Private Key

LastBinaryResult As Variant (read-only)

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 1. 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).

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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

LastErrorXml As String (read-only)

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

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 1. 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

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

NumSecondsRemaining As Long (read-only)

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.

Scope As String

Introduced in version 9.5.0.58

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

SubEmailAddress As String

Introduced in version 9.5.0.58

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

Valid As Long (read-only)

Introduced in version 9.5.0.58

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

VerboseLogging As Long

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

Version As String (read-only)

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

Methods

GetP12() As ChilkatPfx

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

ObtainAccessToken(connection As ChilkatSocket) As Long

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 1 for success, 0 for failure.

(Classic ASP) Get Google API Access Token using JSON Private Key

(Visual FoxPro) Get Google API Access Token using JSON Private Key

(PowerBuilder) Get Google API Access Token using JSON Private Key

(SQL Server) Get Google API Access Token using JSON Private Key

(Visual Basic 6.0) Get Google API Access Token using JSON Private Key

(VBScript) Get Google API Access Token using JSON Private Key

ObtainAccessTokenAsync(connection As ChilkatSocket) As ChilkatTask

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.)

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

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

SetP12(key As ChilkatPfx) As Long

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 1 for success, 0 for failure.

(Classic ASP) Get Google API Access Token using P12 Service Account Key

(Visual FoxPro) Get Google API Access Token using P12 Service Account Key

(PowerBuilder) Get Google API Access Token using P12 Service Account Key

(SQL Server) Get Google API Access Token using P12 Service Account Key

(Visual Basic 6.0) Get Google API Access Token using P12 Service Account Key

(VBScript) Get Google API Access Token using P12 Service Account Key

Events

AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myAuthgoogle As ChilkatAuthGoogle

Private Sub myAuthgoogle_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

BinaryData(data As Variant)

Binary data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myAuthgoogle As ChilkatAuthGoogle

Private Sub myAuthgoogle_BinaryData(data As Variant)

	'Insert application code here.

End Sub

PercentDone(ByVal pctDone As Long, abort As Long)

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myAuthgoogle As ChilkatAuthGoogle

Private Sub myAuthgoogle_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub

ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myAuthgoogle As ChilkatAuthGoogle

Private Sub myAuthgoogle_ProgressInfo(name As String, value As String)

	'Insert application code here.

End Sub

TextData(data As String)

Text data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myAuthgoogle As ChilkatAuthGoogle

Private Sub myAuthgoogle_TextData(data As String)

	'Insert application code here.

End Sub