Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatusApi

Hierarchy

  • StatusApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StatusApi(basePath?: string): StatusApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getStatusBadge

  • getStatusBadge(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>
  • <p>Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration.</p> <p>If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.</p>

    Parameters

    • params: object
      • apiVersion: string
      • Optional branchName?: string
      • Optional configuration?: string
      • definition: string
      • Optional jobName?: string
      • Optional label?: string
      • organization: string
      • project: string
      • Optional stageName?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

Generated using TypeDoc