Class RepositoryApiClient

attributesClient

auditReasonsClient

entriesClient

fieldDefinitionsClient

linkDefinitionsClient

repositoriesClient

searchesClient

serverSessionClient

simpleSearchesClient

tagDefinitionsClient

tasksClient

templateDefinitionsClient

defaultRequestHeaders

• get defaultRequestHeaders(): Record<string, string>

  Get the headers which will be sent with each request.

  Returns Record<string, string>
• set defaultRequestHeaders(headers: Record<string, string>): void

  Set the headers which will be sent with each request.

  Parameters

  • headers: Record<string, string>

  Returns void

StaticcreateFromAccessKey

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

  Create a Laserfiche repository 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 repository API base url.

  Returns LfRepositoryClientV1.RepositoryApiClient

StaticcreateFromGetAccessTokenFunc

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

  Create a Laserfiche repository 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 repository API base url.

  Returns LfRepositoryClientV1.RepositoryApiClient

StaticcreateFromHttpRequestHandler

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

  Create a Laserfiche repository client.

  Parameters

  • httpRequestHandler: LfApiClientCore.HttpRequestHandler

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

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

  Returns LfRepositoryClientV1.RepositoryApiClient

StaticcreateFromUsernamePassword

• createFromUsernamePassword(
      repositoryId: string,
      username: string,
      password: string,
      baseUrl: string,
  ): LfRepositoryClientV1.RepositoryApiClient

  Create a Laserfiche repository client that will use username and password to get access tokens for Laserfiche API. Password credentials grant type is implemented by the Laserfiche Self-Hosted API server. Not available in cloud.

  Parameters

  • repositoryId: string

    The repository ID
  • username: string

    The username
  • password: string

    The password
  • baseUrl: string

    API server base URL e.g., https://{APIServerName}/LFRepositoryAPI

  Returns LfRepositoryClientV1.RepositoryApiClient