Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChangesetsApi

Hierarchy

  • ChangesetsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createChangeset

  • createChangeset(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TfvcChangesetRef>

  • Create a new changeset. Accepts TfvcChangesetToCreate as JSON body

    Parameters

    • params: object
      • apiVersion: string
      • body: TfvcChangeset
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TfvcChangesetRef>

getBatchedChangesets

getChangeset

  • getChangeset(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TfvcChangeset>

  • Retrieve a Tfvc Changeset

    Parameters

    • params: object
      • Optional $Orderby?: string
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • id: number
      • Optional includeDetails?: boolean
      • Optional includeSourceRename?: boolean
      • Optional includeWorkItems?: boolean
      • Optional maxChangeCount?: number
      • Optional maxCommentLength?: number
      • organization: string
      • project: string
      • Optional searchCriteriaAuthor?: string
      • Optional searchCriteriaFollowRenames?: boolean
      • Optional searchCriteriaFromDate?: string
      • Optional searchCriteriaFromId?: number
      • Optional searchCriteriaIncludeLinks?: boolean
      • Optional searchCriteriaItemPath?: string
      • Optional searchCriteriaMappings?: string
      • Optional searchCriteriaToDate?: string
      • Optional searchCriteriaToId?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TfvcChangeset>

getChangesetChanges

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

  • Retrieve Tfvc changes for a given changeset.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • id: number
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TfvcChange>>

getChangesetWorkItems

  • Retrieves the work items associated with a particular changeset.

    Parameters

    • params: object
      • apiVersion: string
      • id: number
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<AssociatedWorkItem>>

getChangesets

  • Retrieve Tfvc Changesets Note: This is a new version of the GetChangesets API that doesn't expose the unneeded queryParams present in the 1.0 version of the API.

    Parameters

    • params: object
      • Optional $Orderby?: string
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional maxCommentLength?: number
      • organization: string
      • project: string
      • Optional searchCriteriaAuthor?: string
      • Optional searchCriteriaFollowRenames?: boolean
      • Optional searchCriteriaFromDate?: string
      • Optional searchCriteriaFromId?: number
      • Optional searchCriteriaIncludeLinks?: boolean
      • Optional searchCriteriaItemPath?: string
      • Optional searchCriteriaMappings?: string
      • Optional searchCriteriaToDate?: string
      • Optional searchCriteriaToId?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TfvcChangesetRef>>

Generated using TypeDoc