Class LinkDefinitionsClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

getLinkDefinition listLinkDefinitions listLinkDefinitionsForEach listLinkDefinitionsNextLink processGetLinkDefinition processListLinkDefinitions

Constructors

constructor

Properties

ProtectedjsonParseReviver

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

Methods

getLinkDefinition

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

    Parameters

    • args: {
          linkDefinitionId: number;
          repositoryId: string;
          select?: null | string;
      }
      • linkDefinitionId: number

        The requested link definition ID.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LinkDefinition>

    A single link definition.

listLinkDefinitions

  • listLinkDefinitions(args): Promise<LinkDefinitionCollectionResponse>
    • Returns the link definitions in the repository.
    • Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links 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;
          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.

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

    A collection of link definitions.

listLinkDefinitionsForEach

  • listLinkDefinitionsForEach(args): Promise<void>

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

listLinkDefinitionsNextLink

ProtectedprocessGetLinkDefinition

ProtectedprocessListLinkDefinitions

Settings

Member Visibility

On This Page

Constructors
Properties
Methods