Compartir a través de

FileContainerRestClient class

  • Referencia
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 los contenedores filtrados por una lista separada por comas de uri de artefacto dentro del mismo ámbito, si no se especifican, 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 dependiente de los parámetros especificados o del encabezado de solicitud ACEPTAR HTTP.

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

Guid que representa el ámbito del contenedor. Suele ser 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

Id. de contenedor.

itemPath

string

Ruta de acceso que se va a eliminar.

scope

string

Guid que representa el ámbito del contenedor. Suele ser el identificador del proyecto.

Devoluciones

Promise<void>

getContainers(string, string)

Obtiene los contenedores filtrados por una lista separada por comas de uri de artefacto dentro del mismo ámbito, si no se especifican, devuelve todos los contenedores.

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

Parámetros

scope

string

Guid que representa el ámbito del contenedor. Suele ser 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 dependiente de los parámetros especificados o del encabezado de solicitud ACEPTAR HTTP.

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

Identificador de contenedor solicitado

scope

string

Guid que representa el ámbito del contenedor. Suele ser el identificador del proyecto.

itemPath

string

Ruta de acceso al elemento de interés

metadata

boolean

Si es true, esto invalida 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 invalida 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 distinto del formato JSON, se usará este nombre de descarga (de lo contrario, el valor predeterminado es itemPath).

includeDownloadTickets

boolean

isShallow

boolean

Si es true, devuelve solo elementos secundarios inmediatos (archivos & carpetas) para el itemPath especificado. False devolverá todos los elementos de forma recursiva dentro de itemPath.

ignoreRequestedMediaType

boolean

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

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Establézcalo en false para no guardar la ruta de acceso absoluta al directorio especificado del artefacto en el archivo devuelto. Solo funciona 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 secuencia con contenido. El valor predeterminado es False.

Devoluciones

Promise<FileContainerItem[]>