Interface ICixApi

interface ICixApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createProjectConnection(
        createConnectionInputs: CreatePipelineConnectionInputs,
        project: string,
    ): Promise<PipelineConnection>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createResources(
        creationParameters: { [key: string]: ResourceCreationParameter },
        project: string,
    ): Promise<CreatedResources>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getConfigurations(
        project: string,
        repositoryType?: string,
        repositoryId?: string,
        branch?: string,
        serviceConnectionId?: string,
    ): Promise<ConfigurationFile[]>;
    getDetectedBuildFrameworks(
        project: string,
        repositoryType?: string,
        repositoryId?: string,
        branch?: string,
        detectionType?: BuildFrameworkDetectionType,
        serviceConnectionId?: string,
    ): Promise<DetectedBuildFramework[]>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createProjectConnection createRequestOptions createResources formatResponse getConfigurations getDetectedBuildFrameworks

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createProjectConnection

createRequestOptions

createResources

formatResponse

getConfigurations

  • getConfigurations(
        project: string,
        repositoryType?: string,
        repositoryId?: string,
        branch?: string,
        serviceConnectionId?: string,
    ): Promise<ConfigurationFile[]>

    Parameters

    • project: string
    • OptionalrepositoryType: string
    • OptionalrepositoryId: string
    • Optionalbranch: string
    • OptionalserviceConnectionId: string

    Returns Promise<ConfigurationFile[]>

getDetectedBuildFrameworks

Settings

Member Visibility

On This Page

Properties
Methods