AuthGoogle Objective-C Reference Documentation

CkoAuthGoogle

Current Version: 11.1.0

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

Object Creation

CkoAuthGoogle *obj = [[CkoAuthGoogle alloc] init];

Properties

AccessToken
@property (nonatomic, copy) NSString *AccessToken;
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.

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

More Information and Examples
top
EmailAddress
@property (nonatomic, copy) NSString *EmailAddress;
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.

top
ExpireNumSeconds
@property (nonatomic, copy) NSNumber *ExpireNumSeconds;
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
@property (nonatomic, copy) NSNumber *Iat;
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
@property (nonatomic, copy) NSString *JsonKey;
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.

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

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.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

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.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicates the success or failure of the most recent method call: YES means success, NO 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
@property (nonatomic, readonly, copy) NSNumber *NumSecondsRemaining;
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
@property (nonatomic, copy) NSString *Scope;
Introduced in version 9.5.0.58

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

top
SubEmailAddress
@property (nonatomic, copy) NSString *SubEmailAddress;
Introduced in version 9.5.0.58

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

top
Valid
@property (nonatomic, readonly) BOOL Valid;
Introduced in version 9.5.0.58

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

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

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

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

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

More Information and Examples
top

Methods

AddClaims
- (BOOL)AddClaims:(CkoJsonObject *)json;
Introduced in version 9.5.0.99

Adds additional custom claims to the JWT claims set.

Returns YES for success, NO for failure.

top
GetP12
- (CkoPfx *)GetP12;
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
- (BOOL)LoadTaskCaller:(CkoTask *)task;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns YES for success, NO for failure.

top
ObtainAccessToken
- (BOOL)ObtainAccessToken:(CkoSocket *)connection;
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 YES for success, NO for failure.

top
ObtainAccessTokenAsync (1)
- (CkoTask *)ObtainAccessTokenAsync:(CkoSocket *)connection;
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
- (BOOL)SetP12:(CkoPfx *)key;
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 YES for success, NO for failure.

top

Events

To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.

For example:

  CkoAuthGoogle *authgoogle = [[CkoAuthGoogle alloc] init];

  MyAuthGoogleProgress *callbackObj = [[MyAuthGoogleProgress alloc] init];

  [authgoogle setEventCallbackObject:callbackObj];

MyAuthGoogleProgress interface example:

#import "CkoAuthGoogleProgress.h"

@interface MyAuthGoogleProgress : CkoBaseProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;

    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;

    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;

    - (void)TaskCompleted:(CkoTask *)task;

@end
AbortCheck
- (void)AbortCheck:(BOOL *)abort;

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.

More Information and Examples
top
PercentDone
- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

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.

To abort the operation, set the abort output argument to YES. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples
top
ProgressInfo
- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

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
- (void)TaskCompleted:(CkoTask *)task;

Called from the background thread when an asynchronous task completes.

top