Interface ILocationsApi

interface ILocationsApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deleteServiceDefinition(
        serviceType: string,
        identifier: string,
    ): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getConnectionData(
        connectOptions?: ConnectOptions,
        lastChangeId?: number,
        lastChangeId64?: number,
    ): Promise<ConnectionData>;
    getResourceArea(
        areaId: string,
        enterpriseName?: string,
        organizationName?: string,
    ): Promise<ResourceAreaInfo>;
    getResourceAreaByHost(
        areaId: string,
        hostId: string,
    ): Promise<ResourceAreaInfo>;
    getResourceAreas(
        enterpriseName?: string,
        organizationName?: string,
    ): Promise<ResourceAreaInfo[]>;
    getResourceAreasByHost(hostId: string): Promise<ResourceAreaInfo[]>;
    getServiceDefinition(
        serviceType: string,
        identifier: string,
        allowFaultIn?: boolean,
        previewFaultIn?: boolean,
    ): Promise<ServiceDefinition>;
    getServiceDefinitions(serviceType?: string): Promise<ServiceDefinition[]>;
    updateServiceDefinitions(
        serviceDefinitions: VssJsonCollectionWrapperV<ServiceDefinition[]>,
    ): Promise<void>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createRequestOptions deleteServiceDefinition formatResponse getConnectionData getResourceArea getResourceAreaByHost getResourceAreas getResourceAreasByHost getServiceDefinition getServiceDefinitions updateServiceDefinitions

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createRequestOptions

deleteServiceDefinition

formatResponse

getConnectionData

getResourceArea

getResourceAreaByHost

getResourceAreas

getResourceAreasByHost

getServiceDefinition

getServiceDefinitions

updateServiceDefinitions

Settings

Member Visibility

On This Page

Properties
Methods