Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttachmentsApi

Hierarchy

  • AttachmentsApi

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<WikiAttachment>

  • Creates an attachment in the wiki.

    Parameters

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

    Returns Promise<WikiAttachment>

createAttachment_1

  • createAttachment_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AttachmentReference>

  • Uploads an attachment. On accounts with higher attachment upload limits (>130MB), you will need to use chunked upload. To upload an attachment in multiple chunks, you first need to Start a Chunked Upload and then follow the example from the Upload Chunk section.

    Parameters

    • params: object
      • apiVersion: string
      • Optional areaPath?: string
      • body: string
      • Optional fileName?: string
      • organization: string
      • project: string
      • Optional uploadType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<AttachmentReference>

createTestResultAttachment

  • createTestResultAttachment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestAttachmentReference>

createTestRunAttachment

  • createTestRunAttachment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestAttachmentReference>

getAttachment

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

  • Gets a specific attachment.

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • name: string
      • organization: string
      • project: string
      • recordId: string
      • timelineId: string
      • type: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getAttachment_2

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

  • Downloads an attachment.

    Parameters

    • params: object
      • apiVersion: string
      • Optional download?: boolean
      • Optional fileName?: string
      • id: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getAttachments

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

  • Gets the list of attachments of a specific type that are associated with a build.

    Parameters

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

    Returns Promise<ArrayWrapper<Attachment>>

getReleaseTaskAttachmentContent

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

  • Get a release task attachment.

    Parameters

    • params: object
      • apiVersion: string
      • attemptId: number
      • environmentId: number
      • name: string
      • organization: string
      • planId: string
      • project: string
      • recordId: string
      • releaseId: number
      • timelineId: string
      • type: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getReleaseTaskAttachments

  • Get the release task attachments.

    Parameters

    • params: object
      • apiVersion: string
      • attemptId: number
      • environmentId: number
      • organization: string
      • planId: string
      • project: string
      • releaseId: number
      • type: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ReleaseTaskAttachment>>

getTaskAttachmentContent

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

  • GetTaskAttachmentContent API is deprecated. Use GetReleaseTaskAttachmentContent API instead.

    Parameters

    • params: object
      • apiVersion: string
      • attemptId: number
      • environmentId: number
      • name: string
      • organization: string
      • project: string
      • recordId: string
      • releaseId: number
      • timelineId: string
      • type: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getTaskAttachments

  • GetTaskAttachments API is deprecated. Use GetReleaseTaskAttachments API instead.

    Parameters

    • params: object
      • apiVersion: string
      • attemptId: number
      • environmentId: number
      • organization: string
      • project: string
      • releaseId: number
      • timelineId: string
      • type: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ReleaseTaskAttachment>>

getTestResultAttachment

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

  • Download a test result attachment by its ID.

    Parameters

    • params: object
      • apiVersion: string
      • attachmentId: number
      • organization: string
      • project: string
      • runId: number
      • testCaseResultId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getTestResultAttachments

  • Get list of test result attachments reference.

    Parameters

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

    Returns Promise<ArrayWrapper<TestAttachment>>

getTestRunAttachment

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

  • Download a test run attachment by its ID.

    Parameters

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

    Returns Promise<string>

getTestRunAttachments

  • Get list of test run attachments reference.

    Parameters

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

    Returns Promise<ArrayWrapper<TestAttachment>>

uploadAttachment

  • uploadAttachment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AttachmentReference>

  • Uploads an attachment chunk. Before performing Upload a Chunk, make sure to have an attachment id returned in Start a Chunked Upload example on Create section. Specify the byte range of the chunk using Content-Length. For example: "Content - Length": "bytes 0 - 39999 / 50000" for the first 40000 bytes of a 50000 byte file.

    Parameters

    • params: object
      • apiVersion: string
      • body: string
      • contentRangeHeader: string
      • Optional fileName?: string
      • id: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<AttachmentReference>

Generated using TypeDoc