Class SimpleSearchesClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

createSimpleSearchOperation processCreateSimpleSearchOperation

Constructors

constructor

  • new SimpleSearchesClient(baseUrl?, http?): LfRepositoryClientV1.SimpleSearchesClient

  • Parameters

    • OptionalbaseUrl: string
    • Optionalhttp: {
          fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
      }
      • fetch:function
        • fetch(url, init?): Promise<Response>

        • Parameters

          • url: RequestInfo
          • Optionalinit: RequestInit

          Returns Promise<Response>

    Returns LfRepositoryClientV1.SimpleSearchesClient

Properties

ProtectedjsonParseReviver

jsonParseReviver: undefined | ((key: string, value: any) => any)

Methods

createSimpleSearchOperation

  • createSimpleSearchOperation(args): Promise<LfRepositoryClientV1.ODataValueContextOfIListOfEntry>
    • Runs a "simple" search operation on the repository.
    • Returns a truncated search result listing.
    • Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
    • Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
    • If field values are requested, only the first value is returned if it is a multi value field.
    • Null or Empty field values should not be used to determine if a field is assigned to the entry.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          fields?: null | string[];
          formatFields?: boolean;
          orderby?: string;
          repoId: string;
          request?: LfRepositoryClientV1.SimpleSearchRequest;
          select?: string;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

      • Optionalfields?: null | string[]

        (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each search result.

      • OptionalformatFields?: boolean

        (optional) Boolean for if field values should be formatted. Only applicable if Fields are specified.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV1.SimpleSearchRequest

        (optional) The Laserfiche search command to run.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV1.ODataValueContextOfIListOfEntry>

    Simple search run successfully.

ProtectedprocessCreateSimpleSearchOperation

Settings

Member Visibility

On This Page

Constructors
Properties
Methods