Class UserRefreshClient (9.0.0)

Inheritance

AuthClient > OAuth2Client > UserRefreshClient

constructor(clientId?: string, clientSecret?: string, refreshToken?: string);

User Refresh Token credentials.

Parameters
Name	Description
`clientId`	`string` The authentication client ID.
`clientSecret`	`string` The authentication client secret.
`refreshToken`	`string` The authentication refresh token.

constructor(options: UserRefreshClientOptions);

Constructs a new instance of the UserRefreshClient class

Parameter
Name	Description
`options`	`UserRefreshClientOptions`

constructor(clientId?: string, clientSecret?: string, refreshToken?: string);

Constructs a new instance of the UserRefreshClient class

_refreshToken?: string | null;

fromJSON(json: JWTInput): void;

Create a UserRefreshClient credentials instance using the given input options.

Parameter
Name	Description
`json`	`JWTInput` The input object.

Returns
Type	Description
`void`

fromStream(inputStream: stream.Readable): Promise<void>;

Create a UserRefreshClient credentials instance using the given input stream.

Parameter
Name	Description
`inputStream`	`stream.Readable` The input stream.

Returns
Type	Description
`Promise<void>`

fromStream(inputStream: stream.Readable, callback: (err?: Error) => void): void;

Returns
Type	Description
`void`

protected refreshTokenNoCache(refreshToken?: string | null): Promise<GetTokenResponse>;

Refreshes the access token.

Parameter
Name	Description
`refreshToken`	`string \| null` An ignored refreshToken..

Returns
Type	Description
`Promise<GetTokenResponse>`