FileContainerRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

FileContainerRestClient(IVssRestClientOptions)

Métodos

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Cria os itens especificados no contentor referenciado.
deleteItem(number, string, string)	Elimina os itens especificados num contentor.
getContainers(string, string)	Obtém contentores filtrados por uma lista separada por vírgulas de uris de artefactos no mesmo âmbito, se não for especificado devolve todos os contentores
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Obtém o objeto de contentor de ficheiros especificado num formato dependente dos parâmetros especificados ou do cabeçalho do pedido HTTP Accept

Detalhes do Construtor

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

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

Cria os itens especificados no contentor 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 âmbito do contentor. Este é, muitas vezes, o ID do projeto.

Devoluções

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Elimina os itens especificados num contentor.

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

Parâmetros

containerId

number

ID do Contentor.

itemPath

string

Caminho a eliminar.

scope

string

Um guid que representa o âmbito do contentor. Este é, muitas vezes, o ID do projeto.

Devoluções

Promise<void>

getContainers(string, string)

Obtém contentores filtrados por uma lista separada por vírgulas de uris de artefactos no mesmo âmbito, se não for especificado devolve todos os contentores

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

Parâmetros

scope

string

Um guid que representa o âmbito do contentor. Este é, muitas vezes, o ID do projeto.

artifactUris

string

Devoluções

Promise<FileContainer[]>

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

Obtém o objeto de contentor de ficheiros especificado num formato dependente dos parâmetros especificados ou do cabeçalho do pedido 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

O ID de contentor pedido

scope

string

Um guid que representa o âmbito do contentor. Este é, muitas vezes, o ID do projeto.

itemPath

string

O caminho para o item de interesse

metadata

boolean

Se for verdadeiro, isto substitui qualquer parâmetro de formato especificado ou cabeçalho de pedido HTTP Accept para fornecer informações não recursivas para o itemPath especificado

format

string

Se for especificado, esta ação substitui o cabeçalho do pedido HTTP Accept para devolver "json" ou "zip". Se $format for especificado, a versão da API também deve ser especificada como um parâmetro de consulta.

downloadFileName

string

Se for especificado e devolver outro formato diferente de JSON, será utilizado este nome de transferência (caso contrário, a predefinição é itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Se for verdadeiro, devolve apenas subordinados imediatos (ficheiros & pastas) para o itemPath especificado. Falso irá devolver todos os itens de forma recursiva dentro de itemPath.

ignoreRequestedMediaType

boolean

Defina como verdadeiro para ignorar o cabeçalho do pedido aceitar HTTP. A predefinição é falso.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Defina como falso para não guardar o caminho absoluto para o diretório especificado do artefacto no arquivo devolvido. Funciona apenas para diretórios de artefactos. A predefinição é verdadeiro.

preferRedirect

boolean

Defina como verdadeiro para obter a resposta de redirecionamento que leva à transmissão em fluxo com conteúdo. A predefinição é falso.

Devoluções

Promise<FileContainerItem[]>