Class DominoAccess

constructor

• new DominoAccess(params: DominoRestAccessJSON): DominoAccess

  Parameters

  • params: DominoRestAccessJSON

  Returns DominoAccess

baseUrl

credentials

OptionalexpiryTime

Optionaltoken

accessToken

• accessToken(callback?: () => Promise<AccessTokenReturn>): Promise<string>

  Parameters

  • Optionalcallback: () => Promise<AccessTokenReturn>

  Returns Promise<string>

  a promise the resolves the JWT token for access.

clone

• clone(alternateScope: string): DominoAccess

  Parameters

  • alternateScope: string

    the alternate scope the clone DominoAccess will have.

  Returns DominoAccess

  a clone of current DominoAccess that has the alternate scope.

expiry

• expiry(): null | number

  Returns null | number

  the expiry time of token in seconds or null if there is no expiry time yet.

scope

• scope(): null | string

  Returns null | string

  the scope of given credentials or null of no scope is given.

updateCredentials

• updateCredentials(incomingCredentials: RestCredentials): RestCredentials

  Parameters

  • incomingCredentials: RestCredentials

    the new credentials to have.

  Returns RestCredentials

  the incoming new credentials.