Class OAuthClientCredentialsHandler

Implements

LfApiClientCore.HttpRequestHandler

Index

Constructors

Methods

afterFetchResponseAsync beforeFetchRequestAsync

Constructors

constructor

new OAuthClientCredentialsHandler(servicePrincipalKey, accessKey, scope?): LfApiClientCore.OAuthClientCredentialsHandler
Constructor
Parameters
- servicePrincipalKey: string
  The service principal key created for the service principal from the Laserfiche Account Administration.
- accessKey: LfApiClientCore.AccessKey
  The access key exported from the Laserfiche Developer Console.
- Optionalscope: string
  Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
Returns LfApiClientCore.OAuthClientCredentialsHandler
- Defined in packages/lf-api-client-core-js/dist/lib/HttpHandlers/OAuthClientCredentialsHandler.d.ts:16

Methods

afterFetchResponseAsync

afterFetchResponseAsync(url, response, request): Promise<boolean>
Called to handle the response from the API service.
Parameters
- url: string
  The HTTP url
- response: Response
  The HTTP response
- request: RequestInit
  The HTTP request
Returns Promise<boolean>
true if the request should be retried.
Implementation of HttpRequestHandler.afterFetchResponseAsync
- Defined in packages/lf-api-client-core-js/dist/lib/HttpHandlers/OAuthClientCredentialsHandler.d.ts:30

beforeFetchRequestAsync

beforeFetchRequestAsync(url, request): Promise<LfApiClientCore.BeforeFetchResult>
Called to prepare the request to the API service.
Parameters
- url: string
  The HTTP url
- request: RequestInit
  The HTTP request
Returns Promise<LfApiClientCore.BeforeFetchResult>
Implementation of HttpRequestHandler.beforeFetchRequestAsync
- Defined in packages/lf-api-client-core-js/dist/lib/HttpHandlers/OAuthClientCredentialsHandler.d.ts:22