Class SearchesClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

listSearchContextHits listSearchContextHitsForEach listSearchContextHitsNextLink listSearchResults listSearchResultsForEach listSearchResultsNextLink processListSearchContextHits processListSearchResults processStartSearchEntry startSearchEntry

Constructors

constructor

  • new SearchesClient(
        baseUrl?: string,
        http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> },
    ): LfRepositoryClientV2.SearchesClient

    Parameters

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

    Returns LfRepositoryClientV2.SearchesClient

Properties

ProtectedjsonParseReviver

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

Methods

listSearchContextHits

  • listSearchContextHits(
        args: {
            count?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            rowNumber: number;
            select?: null | string;
            skip?: number;
            taskId: string;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.SearchContextHitCollectionResponse>
    • Returns the context hits associated with a search result entry.
    • Given a taskId, and rowNumber associated with a search entry in the listing, return the context hits for that entry.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          rowNumber: number;
          select?: null | string;
          skip?: number;
          taskId: string;
          top?: number;
      }
      • Optionalcount?: boolean

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

      • Optionalorderby?: null | string

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

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • rowNumber: number

        The search result listing row number to get context hits for.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • taskId: string

        The requested task ID.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<LfRepositoryClientV2.SearchContextHitCollectionResponse>

    A collection of context hits for a search result.

listSearchContextHitsForEach

  • listSearchContextHitsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.SearchContextHitCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            rowNumber: number;
            select?: string;
            skip?: number;
            taskId: string;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of search context hits of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.SearchContextHitCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          rowNumber: number;
          select?: string;
          skip?: number;
          taskId: string;
          top?: number;
      }
      • callback: (
            response: LfRepositoryClientV2.SearchContextHitCollectionResponse,
        ) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

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

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of search context hits allowed per API response schema.

      • Optionalorderby?: string

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

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • rowNumber: number

        The search result listing row number to get context hits for.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • taskId: string

        The requested task ID.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listSearchContextHitsNextLink

listSearchResults

  • listSearchResults(
        args: {
            count?: boolean;
            culture?: null | string;
            fields?: null | string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            refresh?: boolean;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            taskId: string;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>
    • Returns a search result listing if the search is completed.
    • Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
    • Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.
    • Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
    • Optionally returns field values for the entries in the folder. 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. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
    • Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc".
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          fields?: null | string[];
          formatFieldValues?: boolean;
          groupByEntryType?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          refresh?: boolean;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          taskId: string;
          top?: number;
      }
      • 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 formatFieldValues 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.

      • OptionalformatFieldValues?: boolean

        (optional) Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.

      • OptionalgroupByEntryType?: boolean

        (optional) Indicates if the result should be grouped by entry type or not. The default value is false.

      • Optionalorderby?: null | string

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

      • Optionalprefer?: null | string

        (optional) An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.

      • Optionalrefresh?: boolean

        (optional) Indicates if the search listing should be refreshed to show updated values. The default value is false.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • taskId: string

        The requested task ID.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<LfRepositoryClientV2.EntryCollectionResponse>

    A collection of entry search results.

listSearchResultsForEach

  • listSearchResultsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.EntryCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            culture?: string;
            fields?: string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            refresh?: boolean;
            repositoryId: string;
            select?: string;
            skip?: number;
            taskId: string;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of search results of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.EntryCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          culture?: string;
          fields?: string[];
          formatFieldValues?: boolean;
          groupByEntryType?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          refresh?: boolean;
          repositoryId: string;
          select?: string;
          skip?: number;
          taskId: string;
          top?: number;
      }
      • callback: (response: LfRepositoryClientV2.EntryCollectionResponse) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

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

      • Optionalculture?: 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 formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • Optionalfields?: string[]

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

      • OptionalformatFieldValues?: boolean

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

      • OptionalgroupByEntryType?: boolean

        (optional) An optional query parameter used to indicate if the result should be grouped by entry type or not.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of search results allowed per API response schema.

      • Optionalorderby?: string

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

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • Optionalrefresh?: boolean

        (optional) If the search listing should be refreshed to show updated values.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • taskId: string

        The requested task ID.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listSearchResultsNextLink

  • listSearchResultsNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>

    Returns a search result listing if the search is completed using a next link

    Parameters

    • args: { maxPageSize?: number; nextLink: string }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of search results allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<LfRepositoryClientV2.EntryCollectionResponse>

    A collection of entry search results.

ProtectedprocessListSearchContextHits

ProtectedprocessListSearchResults

ProtectedprocessStartSearchEntry

startSearchEntry

Settings

Member Visibility

On This Page

Constructors
Properties
Methods