Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PullRequestAttachmentsApi

Hierarchy

  • PullRequestAttachmentsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createAttachment

  • createAttachment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Attachment>

  • Attach a new file to a pull request.

    Parameters

    • params: object
      • apiVersion: string
      • body: string
      • fileName: string
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Attachment>

deleteAttachment

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

  • Delete a pull request attachment.

    Parameters

    • params: object
      • apiVersion: string
      • fileName: string
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getAttachment

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

  • Get the file content of a pull request attachment.

    Parameters

    • params: object
      • apiVersion: string
      • fileName: string
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getAttachments

  • getAttachments(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Attachment>>

  • Get a list of files attached to a given pull request.

    Parameters

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

    Returns Promise<ArrayWrapper<Attachment>>

Generated using TypeDoc