Class CixApi

Hierarchy (View Summary)

ClientApiBase
- CixApi

Implements

ICixApi

Index

Constructors

constructor

new CixApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): CixApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns CixApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/CIXApi.ts:28

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ICixApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createProjectConnection

createProjectConnection(
createConnectionInputs: CreatePipelineConnectionInputs,
project: string,
): Promise<PipelineConnection>
Creates a new Pipeline connection between the provider installation and the specified project. Returns the PipelineConnection object created.
Parameters
- createConnectionInputs: CreatePipelineConnectionInputs
- project: string
Returns Promise<PipelineConnection>
Implementation of ICixApi.createProjectConnection
- Defined in repos/azure-devops-node-api/api/CIXApi.ts:95

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ICixApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createResources

createResources(
creationParameters: { [key: string]: ResourceCreationParameter },
project: string,
): Promise<CreatedResources>
Parameters
- creationParameters: { [key: string]: ResourceCreationParameter }
- project: string
  Project ID or project name
Returns Promise<CreatedResources>
Implementation of ICixApi.createResources
- Defined in repos/azure-devops-node-api/api/CIXApi.ts:203

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ICixApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getConfigurations

getConfigurations(
    project: string,
    repositoryType?: string,
    repositoryId?: string,
    branch?: string,
    serviceConnectionId?: string,
): Promise<ConfigurationFile[]>
Gets a list of existing configuration files for the given repository.
Parameters
- project: string
  Project ID or project name
- OptionalrepositoryType: string
  The type of the repository such as GitHub, TfsGit (i.e. Azure Repos), Bitbucket, etc.
- OptionalrepositoryId: string
  The vendor-specific identifier or the name of the repository, e.g. Microsoft/vscode (GitHub) or e9d82045-ddba-4e01-a63d-2ab9f040af62 (Azure Repos)
- Optionalbranch: string
  The repository branch where to look for the configuration file.
- OptionalserviceConnectionId: string
  If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TfsGit (i.e. Azure Repos).
Returns Promise<ConfigurationFile[]>
Implementation of ICixApi.getConfigurations
- Defined in repos/azure-devops-node-api/api/CIXApi.ts:41

getDetectedBuildFrameworks

getDetectedBuildFrameworks(
    project: string,
    repositoryType?: string,
    repositoryId?: string,
    branch?: string,
    detectionType?: BuildFrameworkDetectionType,
    serviceConnectionId?: string,
): Promise<DetectedBuildFramework[]>
Returns a list of build frameworks that best match the given repository based on its contents.
Parameters
- project: string
  Project ID or project name
- OptionalrepositoryType: string
  The type of the repository such as GitHub, TfsGit (i.e. Azure Repos), Bitbucket, etc.
- OptionalrepositoryId: string
  The vendor-specific identifier or the name of the repository, e.g. Microsoft/vscode (GitHub) or e9d82045-ddba-4e01-a63d-2ab9f040af62 (Azure Repos)
- Optionalbranch: string
  The repository branch to detect build frameworks for.
- OptionaldetectionType: BuildFrameworkDetectionType
- OptionalserviceConnectionId: string
  If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TfsGit (i.e. Azure Repos).
Returns Promise<DetectedBuildFramework[]>
Implementation of ICixApi.getDetectedBuildFrameworks
- Defined in repos/azure-devops-node-api/api/CIXApi.ts:149

Class CixApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CixApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createProjectConnection

Parameters

Returns Promise<PipelineConnection>

createRequestOptions

Parameters

Returns IRequestOptions

createResources

Parameters

Returns Promise<CreatedResources>

formatResponse

Parameters

Returns any

getConfigurations

Parameters

Returns Promise<ConfigurationFile[]>

getDetectedBuildFrameworks

Parameters

Returns Promise<DetectedBuildFramework[]>

Settings

On This Page