Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SourceProvidersApi

Hierarchy

  • SourceProvidersApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getFileContents

  • getFileContents(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

  • Gets the contents of a file in the given source code repository.

    Parameters

    • params: object
      • apiVersion: string
      • Optional commitOrBranch?: string
      • organization: string
      • Optional path?: string
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getPathContents

  • Gets the contents of a directory in the given source code repository.

    Parameters

    • params: object
      • apiVersion: string
      • Optional commitOrBranch?: string
      • organization: string
      • Optional path?: string
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<SourceRepositoryItem>>

getPullRequest

  • getPullRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PullRequest>

  • Gets a pull request object from source provider.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • providerName: string
      • pullRequestId: string
      • Optional repositoryId?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PullRequest>

listBranches

  • listBranches(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<string>>

  • Gets a list of branches for the given source code repository.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<string>>

listRepositories

  • listRepositories(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SourceRepositories>

  • Gets a list of source code repositories.

    Parameters

    • params: object
      • apiVersion: string
      • Optional continuationToken?: string
      • organization: string
      • Optional pageResults?: boolean
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional resultSet?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<SourceRepositories>

listSourceProviders

  • Get a list of source providers and their capabilities.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<SourceProviderAttributes>>

listWebhooks

  • Gets a list of webhooks installed in the given source code repository.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<RepositoryWebhook>>

restoreWebhooks

  • restoreWebhooks(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Recreates the webhooks for the specified triggers in the given source code repository.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<string>
      • organization: string
      • project: string
      • providerName: string
      • Optional repository?: string
      • Optional serviceEndpointId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

Generated using TypeDoc