Class FoldersApi

Hierarchy

FoldersApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FoldersApi(basePath?: string): FoldersApi

- Defined in api/api.ts:45173
Parameters
- Optional basePath: string
Returns FoldersApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createFolder

createFolder(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Folder>

- Defined in api/api.ts:45190
Creates a new folder.

Parameters
- params: object
  - apiVersion: string
  - body: Folder
  - organization: string
  - path: string
  - project: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Folder>

deleteFolder

deleteFolder(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:45255
Deletes a definition folder. Definitions and their corresponding builds will also be deleted.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - path: string
  - project: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getFolders

getFolders(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Folder>>

- Defined in api/api.ts:45314
Gets a list of build definition folders.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - path: string
  - project: string
  - Optional queryOrder?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<Folder>>

updateFolder

updateFolder(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Folder>

- Defined in api/api.ts:45377
Updates an existing folder at given existing path

Parameters
- params: object
  - apiVersion: string
  - body: Folder
  - organization: string
  - path: string
  - project: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Folder>

Generated using TypeDoc