Class PushesApi

Hierarchy

PushesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PushesApi(basePath?: string): PushesApi

- Defined in api/api.ts:61492
Parameters
- Optional basePath: string
Returns PushesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createPush

createPush(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPush>

- Defined in api/api.ts:61509
Push changes to the repository.

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

getPush

getPush(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPush>

- Defined in api/api.ts:61577
Retrieves a particular push.

Parameters
- params: object
  - apiVersion: string
  - Optional includeCommits?: number
  - Optional includeRefUpdates?: boolean
  - organization: string
  - project: string
  - pushId: number
  - repositoryId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GitPush>

getPushes

getPushes(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GitPush>>

- Defined in api/api.ts:61656
Retrieves pushes associated with the specified repository.

Parameters
- params: object
  - Optional $Skip?: number
  - Optional $Top?: number
  - apiVersion: string
  - organization: string
  - project: string
  - repositoryId: string
  - Optional searchCriteriaFromDate?: Date
  - Optional searchCriteriaIncludeLinks?: boolean
  - Optional searchCriteriaIncludeRefUpdates?: boolean
  - Optional searchCriteriaPusherId?: string
  - Optional searchCriteriaRefName?: string
  - Optional searchCriteriaToDate?: Date
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<GitPush>>

Generated using TypeDoc