Class ShelvesetsApi

Hierarchy

ShelvesetsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShelvesetsApi(basePath?: string): ShelvesetsApi

- Defined in api/api.ts:68853
Parameters
- Optional basePath: string
Returns ShelvesetsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getShelveset

getShelveset(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TfvcShelveset>

- Defined in api/api.ts:68875
Get a single deep shelveset.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - Optional requestDataIncludeDetails?: boolean
  - Optional requestDataIncludeLinks?: boolean
  - Optional requestDataIncludeWorkItems?: boolean
  - Optional requestDataMaxChangeCount?: number
  - Optional requestDataMaxCommentLength?: number
  - Optional requestDataName?: string
  - Optional requestDataOwner?: string
  - shelvesetId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<TfvcShelveset>

getShelvesetChanges

getShelvesetChanges(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TfvcChange>>

- Defined in api/api.ts:68960
Get changes included in a shelveset.

Parameters
- params: object
  - Optional $Skip?: number
  - Optional $Top?: number
  - apiVersion: string
  - organization: string
  - shelvesetId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<TfvcChange>>

getShelvesetWorkItems

getShelvesetWorkItems(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<AssociatedWorkItem>>

- Defined in api/api.ts:69023
Get work items associated with a shelveset.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - shelvesetId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<AssociatedWorkItem>>

Generated using TypeDoc