TfvcRestClient 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

TfvcRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createChangeset(TfvcChangeset, string)	Cree un nuevo conjunto de cambios.
getBatchedChangesets(TfvcChangesetsRequestData)	Devuelve conjuntos de cambios para una lista determinada de identificadores del conjunto de cambios.
getBranch(string, string, boolean, boolean)	Obtenga una única jerarquía de rama en la ruta de acceso especificada con elementos primarios o secundarios según se especifique.
getBranches(string, boolean, boolean, boolean, boolean)	Obtenga una colección de raíces de rama: elementos secundarios de primer nivel, ramas sin elementos primarios.
getBranchRefs(string, string, boolean, boolean)	Obtención de jerarquías de rama debajo del scopePath especificado
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Recuperar un conjunto de cambios de Tfvc
getChangesetChanges(number, number, number)	Recupera los cambios de Tfvc para un conjunto de cambios determinado.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Recuperación de conjuntos de cambios de Tfvc
getChangesetWorkItems(number)	Recupera los elementos de trabajo asociados a un conjunto de cambios determinado.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Obtener una lista de elementos de Tfvc
getItemsBatch(TfvcItemRequestData, string)	Publicar para recuperar un conjunto de elementos dada una lista de rutas de acceso o una ruta de acceso larga. Permite especificar los descriptores recursionLevel y version para cada ruta de acceso.
getItemsBatchZip(TfvcItemRequestData, string)	Publicar para recuperar un conjunto de elementos dada una lista de rutas de acceso o una ruta de acceso larga. Permite especificar los descriptores recursionLevel y version para cada ruta de acceso.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getLabel(string, TfvcLabelRequestData, string)	Obtenga una sola etiqueta profunda.
getLabelItems(string, number, number)	Obtener elementos debajo de una etiqueta.
getLabels(TfvcLabelRequestData, string, number, number)	Obtiene una colección de referencias de etiqueta superficial.
getShelveset(string, TfvcShelvesetRequestData)	Obtenga un único conjunto de estantes profundos.
getShelvesetChanges(string, number, number)	Obtiene los cambios incluidos en un conjunto de estantes.
getShelvesets(TfvcShelvesetRequestData, number, number)	Devuelve una colección de referencias de conjuntos de estantes poco profundos.
getShelvesetWorkItems(string)	Obtener elementos de trabajo asociados a un conjunto de estantes.
getTfvcStatistics(string, string)	Proporciona recuento de archivos y bytes sin comprimir para una colección o proyecto en un ámbito determinado para TFVC.

Detalles del constructor

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createChangeset(TfvcChangeset, string)

Cree un nuevo conjunto de cambios.

function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>

Parámetros

changeset

TfvcChangeset

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Devuelve conjuntos de cambios para una lista determinada de identificadores del conjunto de cambios.

function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>

Parámetros

changesetsRequestData

TfvcChangesetsRequestData

Lista de identificadores de conjunto de cambios.

Devoluciones

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Obtenga una única jerarquía de rama en la ruta de acceso especificada con elementos primarios o secundarios según se especifique.

function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>

Parámetros

path

string

Ruta de acceso completa a la rama. Valor predeterminado: $/ Ejemplos: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Id. de proyecto o nombre del proyecto

includeParent

boolean

Devuelve la rama primaria, si hay una. Valor predeterminado: False

includeChildren

boolean

Devuelve ramas secundarias, si hay alguna. Valor predeterminado: False

Devoluciones

Promise<TfvcBranch>

getBranches(string, boolean, boolean, boolean, boolean)

Obtenga una colección de raíces de rama: elementos secundarios de primer nivel, ramas sin elementos primarios.

function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

includeParent

boolean

Devuelve la rama primaria, si hay una. Valor predeterminado: False

includeChildren

boolean

Devuelve las ramas secundarias de cada rama raíz. Valor predeterminado: False

includeDeleted

boolean

Devuelve ramas eliminadas. Valor predeterminado: False

includeLinks

boolean

Devuelve vínculos. Valor predeterminado: False

Devoluciones

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Obtención de jerarquías de rama debajo del scopePath especificado

function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>

Parámetros

scopePath

string

Ruta de acceso completa a la rama. Valor predeterminado: $/ Ejemplos: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Id. de proyecto o nombre del proyecto

includeDeleted

boolean

Devuelve ramas eliminadas. Valor predeterminado: False

includeLinks

boolean

Devuelve vínculos. Valor predeterminado: False

Devoluciones

Promise<TfvcBranchRef[]>

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Recuperar un conjunto de cambios de Tfvc

function getChangeset(id: number, project?: string, maxChangeCount?: number, includeDetails?: boolean, includeWorkItems?: boolean, maxCommentLength?: number, includeSourceRename?: boolean, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangeset>

Parámetros

id

number

Identificador del conjunto de cambios que se va a recuperar.

project

string

Id. de proyecto o nombre del proyecto

maxChangeCount

number

Número de cambios que se van a devolver (máximo 100 cambios) Valor predeterminado: 0

includeDetails

boolean

Incluya los detalles de la directiva y las notas de registro en la respuesta. Valor predeterminado: false

includeWorkItems

boolean

Incluya workitems. Valor predeterminado: false

maxCommentLength

number

Incluya detalles sobre los elementos de trabajo asociados en la respuesta. Valor predeterminado: null

includeSourceRename

boolean

Incluya los nombres. Valor predeterminado: false

skip

number

Número de resultados que se van a omitir. Valor predeterminado: null

top

number

El número máximo de resultados que se devolverán. Valor predeterminado: null

orderby

string

Los resultados se ordenan por identificador en orden descendente de forma predeterminada. Use id asc para ordenar por identificador en orden ascendente.

searchCriteria

TfvcChangesetSearchCriteria

Criterios siguientes disponibles (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Valor predeterminado: null

Devoluciones

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Recupera los cambios de Tfvc para un conjunto de cambios determinado.

function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>

Parámetros

id

number

Id. del conjunto de cambios. Valor predeterminado: null

skip

number

Número de resultados que se van a omitir. Valor predeterminado: null

top

number

El número máximo de resultados que se devolverán. Valor predeterminado: null

Devoluciones

Promise<PagedList<TfvcChange>>

getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)

Recuperación de conjuntos de cambios de Tfvc

function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

maxCommentLength

number

Incluya detalles sobre los elementos de trabajo asociados en la respuesta. Valor predeterminado: null

skip

number

Número de resultados que se van a omitir. Valor predeterminado: null

top

number

El número máximo de resultados que se devolverán. Valor predeterminado: null

orderby

string

Los resultados se ordenan por identificador en orden descendente de forma predeterminada. Use id asc para ordenar por identificador en orden ascendente.

searchCriteria

TfvcChangesetSearchCriteria

Criterios siguientes disponibles (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Valor predeterminado: null

Devoluciones

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Recupera los elementos de trabajo asociados a un conjunto de cambios determinado.

function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

Parámetros

id

number

Id. del conjunto de cambios.

Devoluciones

Promise<AssociatedWorkItem[]>

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>

Parámetros

path

string

Ruta de acceso de control de versiones de un elemento individual que se va a devolver.

project

string

Id. de proyecto o nombre del proyecto

fileName

string

nombre de archivo del elemento devuelto.

download

boolean

Si es true, cree un archivo adjunto descargable.

scopePath

string

Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.

recursionLevel

VersionControlRecursionType

Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).

versionDescriptor

TfvcVersionDescriptor

Descriptor de versión. El valor predeterminado es null.

includeContent

boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es False.

Devoluciones

Promise<TfvcItem>

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parámetros

path

string

Ruta de acceso de control de versiones de un elemento individual que se va a devolver.

project

string

Id. de proyecto o nombre del proyecto

fileName

string

nombre de archivo del elemento devuelto.

download

boolean

Si es true, cree un archivo adjunto descargable.

scopePath

string

Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.

recursionLevel

VersionControlRecursionType

Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).

versionDescriptor

TfvcVersionDescriptor

Descriptor de versión. El valor predeterminado es null.

includeContent

boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es False.

Devoluciones

Promise<ArrayBuffer>

getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)

Obtener una lista de elementos de Tfvc

function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

scopePath

string

Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.

recursionLevel

VersionControlRecursionType

Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).

includeLinks

boolean

True para incluir vínculos.

versionDescriptor

TfvcVersionDescriptor

Devoluciones

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Publicar para recuperar un conjunto de elementos dada una lista de rutas de acceso o una ruta de acceso larga. Permite especificar los descriptores recursionLevel y version para cada ruta de acceso.

function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>

Parámetros

itemRequestData

TfvcItemRequestData

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Publicar para recuperar un conjunto de elementos dada una lista de rutas de acceso o una ruta de acceso larga. Permite especificar los descriptores recursionLevel y version para cada ruta de acceso.

function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>

Parámetros

itemRequestData

TfvcItemRequestData

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ArrayBuffer>

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>

Parámetros

path

string

Ruta de acceso de control de versiones de un elemento individual que se va a devolver.

project

string

Id. de proyecto o nombre del proyecto

fileName

string

nombre de archivo del elemento devuelto.

download

boolean

Si es true, cree un archivo adjunto descargable.

scopePath

string

Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.

recursionLevel

VersionControlRecursionType

Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).

versionDescriptor

TfvcVersionDescriptor

Descriptor de versión. El valor predeterminado es null.

includeContent

boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es False.

Devoluciones

Promise<string>

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parámetros

path

string

Ruta de acceso de control de versiones de un elemento individual que se va a devolver.

project

string

Id. de proyecto o nombre del proyecto

fileName

string

nombre de archivo del elemento devuelto.

download

boolean

Si es true, cree un archivo adjunto descargable.

scopePath

string

Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.

recursionLevel

VersionControlRecursionType

Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).

versionDescriptor

TfvcVersionDescriptor

Descriptor de versión. El valor predeterminado es null.

includeContent

boolean

Establézcalo en true para incluir contenido de elemento al solicitar json. El valor predeterminado es False.

Devoluciones

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Obtenga una sola etiqueta profunda.

function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>

Parámetros

labelId

string

Identificador único de etiqueta

requestData

TfvcLabelRequestData

maxItemCount

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<TfvcLabel>

getLabelItems(string, number, number)

Obtener elementos debajo de una etiqueta.

function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

Parámetros

labelId

string

Identificador único de etiqueta

top

number

Número máximo de elementos que se van a devolver

skip

number

Número de elementos que se van a omitir

Devoluciones

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Obtiene una colección de referencias de etiqueta superficial.

function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>

Parámetros

requestData

TfvcLabelRequestData

labelScope, name, owner y itemLabelFilter

project

string

Id. de proyecto o nombre del proyecto

top

number

Número máximo de etiquetas que se van a devolver, el valor predeterminado es 100 cuando no está definido.

skip

number

Número de etiquetas que se van a omitir

Devoluciones

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Obtenga un único conjunto de estantes profundos.

function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>

Parámetros

shelvesetId

string

Identificador único del conjunto de estantes

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount y maxCommentLength

Devoluciones

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Obtiene los cambios incluidos en un conjunto de estantes.

function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>

Parámetros

shelvesetId

string

Identificador único del conjunto de estantes

top

number

Número máximo de cambios que se van a devolver

skip

number

Número de cambios que se omitirán

Devoluciones

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Devuelve una colección de referencias de conjuntos de estantes poco profundos.

function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>

Parámetros

requestData

TfvcShelvesetRequestData

name, owner y maxCommentLength

top

number

Número máximo de conjuntos de estantes que se van a devolver

skip

number

Número de conjuntos de estantes que se van a omitir

Devoluciones

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Obtener elementos de trabajo asociados a un conjunto de estantes.

function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

Parámetros

shelvesetId

string

Identificador único del conjunto de estantes

Devoluciones

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Proporciona recuento de archivos y bytes sin comprimir para una colección o proyecto en un ámbito determinado para TFVC.

function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

scopePath

string

'$/' para la colección, '$/project' para un proyecto específico

Devoluciones

Promise<TfvcStatistics>