FileContainerRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

RestClientBase

Construtores

FileContainerRestClient(IVssRestClientOptions)

Métodos

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Cria os itens especificados no contêiner referenciado.
deleteItem(number, string, string)	Exclui os itens especificados em um contêiner.
getContainers(string, string)	Obtém contêineres filtrados por uma lista separada por vírgulas de uris de artefato dentro do mesmo escopo, se não especificado retorna todos os contêineres
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Obtém o objeto de contêiner de arquivo especificado em um formato dependente dos parâmetros fornecidos ou do cabeçalho de solicitação HTTP Accept

Detalhes do construtor

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)

Cria os itens especificados no contêiner referenciado.

function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>

Parâmetros

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Um guid que representa o escopo do contêiner. Geralmente, essa é a ID do projeto.

Retornos

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Exclui os itens especificados em um contêiner.

function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>

Parâmetros

containerId

number

ID do contêiner.

itemPath

string

Caminho a ser excluído.

scope

string

Um guid que representa o escopo do contêiner. Geralmente, essa é a ID do projeto.

Retornos

Promise<void>

getContainers(string, string)

Obtém contêineres filtrados por uma lista separada por vírgulas de uris de artefato dentro do mesmo escopo, se não especificado retorna todos os contêineres

function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>

Parâmetros

scope

string

Um guid que representa o escopo do contêiner. Geralmente, essa é a ID do projeto.

artifactUris

string

Retornos

Promise<FileContainer[]>

getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)

Obtém o objeto de contêiner de arquivo especificado em um formato dependente dos parâmetros fornecidos ou do cabeçalho de solicitação HTTP Accept

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

Parâmetros

containerId

number

A ID do contêiner solicitada

scope

string

Um guid que representa o escopo do contêiner. Geralmente, essa é a ID do projeto.

itemPath

string

O caminho para o item de interesse

metadata

boolean

Se for true, isso substituirá qualquer parâmetro de formato especificado ou cabeçalho de solicitação HTTP Accept para fornecer informações não recursivas para o itemPath fornecido

format

string

Se especificado, isso substitui o cabeçalho de solicitação HTTP Accept para retornar 'json' ou 'zip'. Se $format for especificado, a api-version também deverá ser especificada como um parâmetro de consulta.

downloadFileName

string

Se especificado e retornando diferente do formato JSON, esse nome de download será usado (caso contrário, o padrão é itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Se for true, retornará apenas filhos imediatos (arquivos & pastas) para o itemPath fornecido. False retornará todos os itens recursivamente no itemPath.

ignoreRequestedMediaType

boolean

Defina como true para ignorar o cabeçalho de solicitação aceitar HTTP. O padrão é false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Defina como false para não salvar o caminho absoluto no diretório especificado do artefato no arquivo retornado. Funciona apenas para diretórios de artefatos. O padrão é true.

preferRedirect

boolean

Defina como true para obter a resposta de redirecionamento que leva ao fluxo com conteúdo. O padrão é false.

Retornos

Promise<FileContainerItem[]>