Class FileContainerApiBase

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createItems createRequestOptions deleteItem formatResponse getContainers getItems

Constructors

constructor

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createItems

createRequestOptions

deleteItem

formatResponse

getContainers

getItems

  • getItems(
        containerId: number,
        scope?: string,
        itemPath?: string,
        metadata?: boolean,
        format?: string,
        downloadFileName?: string,
        includeDownloadTickets?: boolean,
        isShallow?: boolean,
        ignoreRequestedMediaType?: boolean,
        includeBlobMetadata?: boolean,
        saveAbsolutePath?: boolean,
        preferRedirect?: boolean,
    ): Promise<FileContainerItem[]>

    Gets the specified file container object in a format dependent upon the given parameters or HTTP Accept request header

    Parameters

    • containerId: number

      The requested container Id

    • Optionalscope: string

      A guid representing the scope of the container. This is often the project id.

    • OptionalitemPath: string

      The path to the item of interest

    • Optionalmetadata: boolean

      If true, this overrides any specified format parameter or HTTP Accept request header to provide non-recursive information for the given itemPath

    • Optionalformat: string

      If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'. If $format is specified, then api-version should also be specified as a query parameter.

    • OptionaldownloadFileName: string

      If specified and returning other than JSON format, then this download name will be used (else defaults to itemPath)

    • OptionalincludeDownloadTickets: boolean
    • OptionalisShallow: boolean

      If true, returns only immediate children(files & folders) for the given itemPath. False will return all items recursively within itemPath.

    • OptionalignoreRequestedMediaType: boolean

      Set to true to ignore the HTTP Accept request header. Default is false.

    • OptionalincludeBlobMetadata: boolean
    • OptionalsaveAbsolutePath: boolean

      Set to false to not save the absolute path to the specified directory of the artifact in the returned archive. Works only for artifact directories. Default is true.

    • OptionalpreferRedirect: boolean

      Set to true to get the redirect response which leads to the stream with content. Default is false.

    Returns Promise<FileContainerItem[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods