Interface ITagDefinitionsClient

interface ITagDefinitionsClient {
    getTagDefinition(args: {
        culture?: null | string;
        repositoryId: string;
        select?: null | string;
        tagId: number;
    }): Promise<LfRepositoryClientV2.TagDefinition>;
    listTagDefinitions(args: {
        count?: boolean;
        culture?: null | string;
        orderby?: null | string;
        prefer?: null | string;
        repositoryId: string;
        select?: null | string;
        skip?: number;
        top?: number;
    }): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>;
    listTagDefinitionsForEach(args: {
        callback: ((response: LfRepositoryClientV2.TagDefinitionCollectionResponse) => Promise<boolean>);
        count?: boolean;
        culture?: string;
        maxPageSize?: number;
        orderby?: string;
        prefer?: string;
        repositoryId: string;
        select?: string;
        skip?: number;
        top?: number;
    }): Promise<void>;
    listTagDefinitionsNextLink(args: {
        maxPageSize?: number;
        nextLink: string;
    }): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>;
}

Implemented by

Methods

getTagDefinition listTagDefinitions listTagDefinitionsForEach listTagDefinitionsNextLink

Methods

getTagDefinition

  • getTagDefinition(args): Promise<LfRepositoryClientV2.TagDefinition>
    • Returns a single tag definition.
    • Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.
    • Allowed OData query options: Select
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          culture?: null | string;
          repositoryId: string;
          select?: null | string;
          tagId: number;
      }
      • 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.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • tagId: number

        The requested tag definition ID.

    Returns Promise<LfRepositoryClientV2.TagDefinition>

    A single tag definition.

listTagDefinitions

  • listTagDefinitions(args): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>
    • Returns all tag definitions in the repository.
    • Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific 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;
          culture?: null | string;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          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.

      • 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.

      • 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.

      • Optionaltop?: number

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

    Returns Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>

    A collection of tag definitions.

listTagDefinitionsForEach

  • listTagDefinitionsForEach(args): Promise<void>

  • It will continue to make the same call to get a list of tag definitions 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.TagDefinitionCollectionResponse) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: ((response: LfRepositoryClientV2.TagDefinitionCollectionResponse) => 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.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of tag definitions 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.

      • 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.

      • Optionaltop?: number

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

    Returns Promise<void>

listTagDefinitionsNextLink

  • listTagDefinitionsNextLink(args): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>

  • Returns all tag definitions in the repository using a next link

    Parameters

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

        (optional) the maximum page size or number of tag definitions allowed per API response schema

      • nextLink: string

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

    Returns Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>

    A collection of tag definitions.

Settings

Member Visibility

On This Page

Methods