LocationsRestClient class

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Extends

Dettagli costruttore

LocationsRestClient(IVssRestClientOptions)

new LocationsRestClient(options: IVssRestClientOptions)

Parametri

Dettagli metodo

deleteServiceDefinition(string, string)

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

Parametri

serviceType

string

identifier

string

Valori restituiti

Promise<void>

getConnectionData(ConnectOptions, number, number)

Questo è stato copiato e adattato da TeamFoundationConnectionService.Connect()

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

Parametri

connectOptions
ConnectOptions
lastChangeId

number

LastChangeId obsoleto a 32 bit

lastChangeId64

number

LastChangeId a 64 bit non troncato

Valori restituiti

Promise<ConnectionData>

getResourceArea(string, string, string, string)

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

Parametri

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Valori restituiti

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string)

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

Parametri

areaId

string

hostId

string

accessMapping

string

Valori restituiti

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string)

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

Parametri

areaId

string

instanceId

string

accessMapping

string

Valori restituiti

Promise<ResourceAreaInfo>

getResourceAreas(string, string)

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

Parametri

enterpriseName

string

organizationName

string

Valori restituiti

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string)

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

Parametri

hostId

string

Valori restituiti

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Trova una determinata definizione di servizio.

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

Parametri

serviceType

string

identifier

string

allowFaultIn

boolean

Se true, si tenterà di eseguire un errore in un mapping dell'istanza host se in SPS.

previewFaultIn

boolean

Se true, calcoleremo e restituiremo un mapping dell'istanza host, ma non lo renderemo persistente.

Valori restituiti

getServiceDefinitions(string)

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

Parametri

serviceType

string

Valori restituiti

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

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

Parametri

Valori restituiti

Promise<void>