Class LfApiClient

repositoryApiClientV1

repositoryApiClientV2

StaticcreateFromAccessKey

• createFromAccessKey(
      servicePrincipalKey: string,
      accessKey: LfApiClientCore.AccessKey,
      scope?: string,
      baseUrlDebug?: string,
  ): ILfApiClient

  Create a Laserfiche API client that will use Laserfiche Cloud OAuth client credentials to get access tokens.

  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

    (optional) The requested space-delimited scopes for the access token.
  • OptionalbaseUrlDebug: string

    (optional) override for the Laserfiche API base url.

  Returns ILfApiClient

StaticcreateFromGetAccessTokenFunc

• createFromGetAccessTokenFunc(
      getAccessTokenFunc: () => Promise<
          LfApiClientCore.GetAccessTokenResponse,
      >,
      baseUrlDebug?: string,
  ): ILfApiClient

  Create a Laserfiche API client.

  Parameters

  • getAccessTokenFunc: () => Promise<LfApiClientCore.GetAccessTokenResponse>

    A function that will be used to retrieve the current Laserfiche API access token.
  • OptionalbaseUrlDebug: string

    (optional) override for the Laserfiche API base url.

  Returns ILfApiClient

StaticcreateFromHttpRequestHandler

• createFromHttpRequestHandler(
      httpRequestHandler: LfApiClientCore.HttpRequestHandler,
      baseUrlDebug?: string,
  ): ILfApiClient

  Create a Laserfiche API client.

  Parameters

  • httpRequestHandler: LfApiClientCore.HttpRequestHandler

    The http request handler for the Laserfiche API client.
  • OptionalbaseUrlDebug: string

    (optional) override for the Laserfiche repository API base url.

  Returns ILfApiClient