FileContainerRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

FileContainerRestClient(IVssRestClientOptions)

Métodos

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Crea los elementos especificados en el contenedor al que se hace referencia.
deleteItem(number, string, string)	Elimina los elementos especificados en un contenedor.
getContainers(string, string)	Obtiene contenedores filtrados por una lista separada por comas de uris de artefactos dentro del mismo ámbito, si no se especifica devuelve todos los contenedores
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Obtiene el objeto contenedor de archivos especificado en un formato que depende de los parámetros especificados o del encabezado de solicitud HTTP Accept

Detalles del constructor

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

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

Crea los elementos especificados en el contenedor al que se hace referencia.

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

Parámetros

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Un guid que representa el ámbito del contenedor. A menudo es el identificador del proyecto.

Devoluciones

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Elimina los elementos especificados en un contenedor.

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

Parámetros

containerId

number

Identificador de contenedor.

itemPath

string

Ruta de acceso a eliminar.

scope

string

Un guid que representa el ámbito del contenedor. A menudo es el identificador del proyecto.

Devoluciones

Promise<void>

getContainers(string, string)

Obtiene contenedores filtrados por una lista separada por comas de uris de artefactos dentro del mismo ámbito, si no se especifica devuelve todos los contenedores

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

Parámetros

scope

string

Un guid que representa el ámbito del contenedor. A menudo es el identificador del proyecto.

artifactUris

string

Devoluciones

Promise<FileContainer[]>

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

Obtiene el objeto contenedor de archivos especificado en un formato que depende de los parámetros especificados o del encabezado de solicitud 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

El identificador de contenedor solicitado

scope

string

Un guid que representa el ámbito del contenedor. A menudo es el identificador del proyecto.

itemPath

string

La ruta al elemento de interés

metadata

boolean

Si es true, esto anula cualquier parámetro de formato especificado o encabezado de solicitud HTTP Accept para proporcionar información no recursiva para el itemPath especificado

format

string

Si se especifica, esto anula el encabezado de solicitud HTTP Accept para devolver 'json' o 'zip'. Si se especifica $format, api-version también debe especificarse como parámetro de consulta.

downloadFileName

string

Si se especifica y devuelve un formato que no sea JSON, se usará este nombre de descarga (de lo contrario, el valor predeterminado es itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Si es true, devuelve solo children (files & folders) inmediatos para el itemPath dado. False devolverá todos los elementos de forma recursiva dentro de itemPath.

ignoreRequestedMediaType

boolean

Establézcalo en true para ignorar el encabezado de solicitud HTTP Accept. El valor predeterminado es False.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Establézcalo en false para no guardar la ruta absoluta al directorio especificado del artefacto en el archivo devuelto. Funciona solo para directorios de artefactos. El valor predeterminado es true.

preferRedirect

boolean

Establézcalo en true para obtener la respuesta de redireccionamiento que conduce a la transmisión con contenido. El valor predeterminado es False.

Devoluciones

Promise<FileContainerItem[]>