Interface IAttributesClient

interface IAttributesClient {
    getAttribute(args: {
        attributeKey: string;
        everyone?: boolean;
        repositoryId: string;
    }): Promise<Attribute>;
    listAttributes(args: {
        count?: boolean;
        everyone?: boolean;
        orderby?: null | string;
        prefer?: null | string;
        repositoryId: string;
        select?: null | string;
        skip?: number;
        top?: number;
    }): Promise<AttributeCollectionResponse>;
    listAttributesForEach(args: {
        callback: ((response: AttributeCollectionResponse) => Promise<boolean>);
        count?: boolean;
        everyone?: boolean;
        maxPageSize?: number;
        orderby?: string;
        repositoryId: string;
        select?: string;
        skip?: number;
        top?: number;
    }): Promise<void>;
    listAttributesNextLink(args: {
        maxPageSize?: number;
        nextLink: string;
    }): Promise<AttributeCollectionResponse>;
}

Implemented by

Methods

getAttribute listAttributes listAttributesForEach listAttributesNextLink

Methods

getAttribute

  • getAttribute(args): Promise<Attribute>
    • Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group.
    • Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          attributeKey: string;
          everyone?: boolean;
          repositoryId: string;
      }
      • attributeKey: string

        The requested attribute key.

      • Optionaleveryone?: boolean

        (optional) Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. The default value is false.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<Attribute>

    A single attribute associated with the authenticated user.

listAttributes

  • listAttributes(args): Promise<AttributeCollectionResponse>
    • Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group.
    • Attribute keys can be used with subsequent calls to get specific attribute values.
    • Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups.
    • Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          everyone?: 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.

      • Optionaleveryone?: boolean

        (optional) Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. 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.

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

    A collection of attributes associated with the authenticated user.

listAttributesForEach

  • listAttributesForEach(args): Promise<void>

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

      • Optionaleveryone?: boolean

        (optional) Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of attributes key value pairs allowed per API response schema

      • Optionalorderby?: string

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

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

listAttributesNextLink

  • listAttributesNextLink(args): Promise<AttributeCollectionResponse>

  • Returns the attribute key value pairs using a next link

    Parameters

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

        (optional) the maximum page size or number of attribute keys allowed per API response schema

      • nextLink: string

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

    Returns Promise<AttributeCollectionResponse>

    A collection of attributes associated with the authenticated user.

Settings

Member Visibility

On This Page

Methods