Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GoogleToken

Hierarchy

  • GoogleToken

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Create a GoogleToken.

    Parameters

    Returns GoogleToken

Properties

Optional additionalClaims

additionalClaims?: {}

Type declaration

    Optional eagerRefreshThresholdMillis

    eagerRefreshThresholdMillis?: number

    Optional email

    email?: string

    Optional expiresAt

    expiresAt?: number

    Optional iss

    iss?: string

    Optional key

    key?: string

    Optional keyFile

    keyFile?: string

    Optional rawToken

    rawToken?: TokenData

    Optional scope

    scope?: string

    Optional sub

    sub?: string

    Optional tokenExpires

    tokenExpires?: number

    transporter

    transporter: Transporter

    Accessors

    accessToken

    • get accessToken(): undefined | string

    • Returns undefined | string

    idToken

    • get idToken(): undefined | string

    • Returns undefined | string

    refreshToken

    • get refreshToken(): undefined | string

    • Returns undefined | string

    tokenType

    • get tokenType(): undefined | string

    • Returns undefined | string

    Methods

    getCredentials

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

      Parameters

      • keyFile: string

        Path to a json, pem, or p12 file that contains the key.

      Returns Promise<Credentials>

      an object with privateKey and clientEmail properties

    getToken

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

      Parameters

      Returns Promise<TokenData>

    • Parameters

      Returns void

    hasExpired

    • hasExpired(): boolean

    • Returns whether the token has expired.

      Returns boolean

      true if the token has expired, false otherwise.

    isTokenExpiring

    • isTokenExpiring(): boolean

    • Returns whether the token will expire within eagerRefreshThresholdMillis

      Returns boolean

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

    revokeToken

    • revokeToken(): Promise<void>
    • revokeToken(callback: (err?: Error) => void): void

    • Revoke the token if one is set.

      Returns Promise<void>

    • Parameters

      • callback: (err?: Error) => void
          • (err?: Error): void

          • Parameters

            • Optional err: Error

            Returns void

      Returns void