Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional accessToken

accessToken: undefined | string

An existing valid accessToken

Optional accessUrl

accessUrl: undefined | string

Endpoint for token generation, defaults to 'https://accounts.google.com/o/oauth2/token'

Optional clientId

clientId: undefined | string

Client ID value

Optional clientSecret

clientSecret: undefined | string

Client secret value

Optional expires

expires: ms

Optional Access Token expire time in ms

Optional privateKey

privateKey: string | object

Private key for JSW

Optional refreshToken

refreshToken: undefined | string

Refresh token for an user

Optional timeout

timeout: s

Optional TTL for Access Token in seconds

Optional user

user: undefined | string

User e-mail address

Methods

Optional provisionCallback

  • provisionCallback(user: string, renew: boolean, callback: function): void
  • Function to run when a new access token is required

    Parameters

    • user: string
    • renew: boolean
    • callback: function
        • (err: Error | null, accessToken: string, expires: number): void
        • Parameters

          • err: Error | null
          • accessToken: string
          • expires: number

          Returns void

    Returns void

Generated using TypeDoc