ContributionsRestClient class

Package:

azure-devops-extension-api

Base class that should be used (derived from) to make requests to VSS REST apis

Extends

RestClientBase

Constructors

ContributionsRestClient(IVssRestClientOptions)

Properties

RESOURCE_AREA_ID

Methods

getInstalledExtensionByName(string, string, string[])
getInstalledExtensions(string[], boolean, string[])
queryContributionNodes(ContributionNodeQuery)	Query for contribution nodes and provider details according the parameters in the passed in query object.
queryDataProviders(DataProviderQuery, string, string)

Constructor Details

ContributionsRestClient(IVssRestClientOptions)

new ContributionsRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Property Details

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Property Value

string

Method Details

getInstalledExtensionByName(string, string, string[])

function getInstalledExtensionByName(publisherName: string, extensionName: string, assetTypes?: string[]): Promise<InstalledExtension>

Parameters

publisherName

string

extensionName

string

assetTypes

string[]

Returns

Promise<InstalledExtension>

getInstalledExtensions(string[], boolean, string[])

function getInstalledExtensions(contributionIds?: string[], includeDisabledApps?: boolean, assetTypes?: string[]): Promise<InstalledExtension[]>

Parameters

contributionIds

string[]

includeDisabledApps

boolean

assetTypes

string[]

Returns

Promise<InstalledExtension[]>

queryContributionNodes(ContributionNodeQuery)

Query for contribution nodes and provider details according the parameters in the passed in query object.

function queryContributionNodes(query: ContributionNodeQuery): Promise<ContributionNodeQueryResult>

Parameters

query

ContributionNodeQuery

Returns

Promise<ContributionNodeQueryResult>

queryDataProviders(DataProviderQuery, string, string)

function queryDataProviders(query: DataProviderQuery, scopeName?: string, scopeValue?: string): Promise<DataProviderResult>

Parameters

query

DataProviderQuery

scopeName

string

scopeValue

string

Returns

Promise<DataProviderResult>