Class GoogleToken (7.0.1)

Package

constructor(options?: TokenOptions);

Create a GoogleToken.

Parameter
Name	Description
`options`	`TokenOptions` Configuration object.

get accessToken(): string | undefined;

additionalClaims?: {};

eagerRefreshThresholdMillis?: number;

email?: string;

expiresAt?: number;

get idToken(): string | undefined;

iss?: string;

key?: string;

keyFile?: string;

rawToken?: TokenData;

get refreshToken(): string | undefined;

scope?: string;

sub?: string;

tokenExpires?: number;

get tokenType(): string | undefined;

transporter: Transporter;

getCredentials(keyFile: string): Promise<Credentials>;

Given a keyFile, extract the key and client email if available

Parameter
Name	Description
`keyFile`	`string` Path to a json, pem, or p12 file that contains the key.

Returns
Type	Description
`Promise<Credentials>`	an object with privateKey and clientEmail properties

getToken(opts?: GetTokenOptions): Promise<TokenData>;

Returns a cached token or retrieves a new one from Google.

Parameter
Name	Description
`opts`	`GetTokenOptions`

Returns
Type	Description
`Promise<TokenData>`

getToken(callback: GetTokenCallback, opts?: GetTokenOptions): void;

Returns
Type	Description
`void`

hasExpired(): boolean;

Returns whether the token has expired.

true if the token has expired, false otherwise.

Returns
Type	Description
`boolean`

isTokenExpiring(): boolean;

Returns whether the token will expire within eagerRefreshThresholdMillis

true if the token will be expired within eagerRefreshThresholdMillis, false otherwise.

Returns
Type	Description
`boolean`

revokeToken(): Promise<void>;

Revoke the token if one is set.

Returns
Type	Description
`Promise<void>`

revokeToken(callback: (err?: Error) => void): void;

Parameter
Name	Description
`callback`	`(err?: Error) => void`

Returns
Type	Description
`void`