LocationsRestClient class

應該用來對 VSS REST API 提出要求的基類(衍生自)

Extends

建構函式詳細資料

LocationsRestClient(IVssRestClientOptions)

new LocationsRestClient(options: IVssRestClientOptions)

參數

方法詳細資料

deleteServiceDefinition(string, string)

function deleteServiceDefinition(serviceType: string, identifier: string): Promise<void>

參數

serviceType

string

identifier

string

傳回

Promise<void>

getConnectionData(ConnectOptions, number, number)

這是從 TeamFoundationConnectionService.Connect 複製並改編的

function getConnectionData(connectOptions?: ConnectOptions, lastChangeId?: number, lastChangeId64?: number): Promise<ConnectionData>

參數

connectOptions
ConnectOptions
lastChangeId

number

過時的 32 位 LastChangeId

lastChangeId64

number

未截斷的 64 位 LastChangeId

傳回

Promise<ConnectionData>

getResourceArea(string, string, string, string)

function getResourceArea(areaId: string, enterpriseName?: string, organizationName?: string, accessMapping?: string): Promise<ResourceAreaInfo>

參數

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

傳回

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string)

function getResourceAreaByHost(areaId: string, hostId: string, accessMapping?: string): Promise<ResourceAreaInfo>

參數

areaId

string

hostId

string

accessMapping

string

傳回

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string)

function getResourceAreaByInstanceId(areaId: string, instanceId: string, accessMapping: string): Promise<ResourceAreaInfo>

參數

areaId

string

instanceId

string

accessMapping

string

傳回

Promise<ResourceAreaInfo>

getResourceAreas(string, string)

function getResourceAreas(enterpriseName?: string, organizationName?: string): Promise<ResourceAreaInfo[]>

參數

enterpriseName

string

organizationName

string

傳回

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string)

function getResourceAreasByHost(hostId: string): Promise<ResourceAreaInfo[]>

參數

hostId

string

傳回

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

尋找指定的服務定義。

function getServiceDefinition(serviceType: string, identifier: string, allowFaultIn?: boolean, previewFaultIn?: boolean): Promise<ServiceDefinition>

參數

serviceType

string

identifier

string

allowFaultIn

boolean

如果為 true,我們會在 SPS 中嘗試在主機實例對應中發生錯誤。

previewFaultIn

boolean

如果為 true,我們會計算並傳回主機實例對應,但不會保存它。

傳回

getServiceDefinitions(string)

function getServiceDefinitions(serviceType?: string): Promise<ServiceDefinition[]>

參數

serviceType

string

傳回

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

function updateServiceDefinitions(serviceDefinitions: VssJsonCollectionWrapperV<ServiceDefinition[]>): Promise<void>

參數

傳回

Promise<void>