Interface IFileContainerApi

interface IFileContainerApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createItem(
        contentStream: ReadableStream,
        uncompressedLength: number,
        containerId: number,
        itemPath: string,
        scope: string,
        options: any,
    ): Promise<FileContainerItem>;
    createItems(
        items: VssJsonCollectionWrapperV<FileContainerItem[]>,
        containerId: number,
        scope?: string,
    ): Promise<FileContainerItem[]>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deleteItem(
        containerId: number,
        itemPath: string,
        scope?: string,
    ): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getContainers(
        scope?: string,
        artifactUris?: string,
    ): Promise<FileContainer[]>;
    getItem(
        containerId: number,
        scope?: string,
        itemPath?: string,
        downloadFileName?: string,
    ): Promise<IRestResponse<ReadableStream>>;
    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[]>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createItem createItems createRequestOptions deleteItem formatResponse getContainers getItem getItems

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createItem

createItems

createRequestOptions

deleteItem

formatResponse

getContainers

getItem

  • getItem(
        containerId: number,
        scope?: string,
        itemPath?: string,
        downloadFileName?: string,
    ): Promise<IRestResponse<ReadableStream>>

    Parameters

    • containerId: number
    • Optionalscope: string
    • OptionalitemPath: string
    • OptionaldownloadFileName: string

    Returns Promise<IRestResponse<ReadableStream>>

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[]>

    Parameters

    • containerId: number
    • Optionalscope: string
    • OptionalitemPath: string
    • Optionalmetadata: boolean
    • Optionalformat: string
    • OptionaldownloadFileName: string
    • OptionalincludeDownloadTickets: boolean
    • OptionalisShallow: boolean
    • OptionalignoreRequestedMediaType: boolean
    • OptionalincludeBlobMetadata: boolean
    • OptionalsaveAbsolutePath: boolean
    • OptionalpreferRedirect: boolean

    Returns Promise<FileContainerItem[]>

Settings

Member Visibility

On This Page

Properties
Methods