TfvcRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Tfvc |
Propriedades
| RESOURCE_AREA_ID |
Métodos
| create |
Crie um novo conjunto de alterações. |
| get |
Retorna conjuntos de alterações para uma determinada lista de IDs do conjunto de alterações. |
| get |
Obtenha uma única hierarquia de ramificação no caminho fornecido com pais ou filhos, conforme especificado. |
| get |
Obtenha uma coleção de raízes de filiais, crianças de primeiro nível, galhos sem pais. |
| get |
Obter hierarquias de ramificação abaixo do scopePath especificado |
| get |
Recuperar um conjunto de alterações do Tfvc |
| get |
Recupere as alterações do Tfvc para um determinado conjunto de alterações. |
| get |
Recuperar conjuntos de alterações do Tfvc |
| get |
Recupera os itens de trabalho associados a um conjunto de alterações específico. |
| get |
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download. |
| get |
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download. |
| get |
Obter uma lista de itens Tfvc |
| get |
Poste para recuperar um conjunto de itens com uma lista de caminhos ou um caminho longo. Permite especificar os descritores recursionLevel e version para cada caminho. |
| get |
Poste para recuperar um conjunto de itens com uma lista de caminhos ou um caminho longo. Permite especificar os descritores recursionLevel e version para cada caminho. |
| get |
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download. |
| get |
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download. |
| get |
Obtenha um único rótulo profundo. |
| get |
Obter itens sob um rótulo. |
| get |
Obtenha uma coleção de referências de rótulo superficial. |
| get |
Obtenha um único conjunto de prateleiras profundas. |
| get |
Obtenha as alterações incluídas em um conjunto de prateleiras. |
| get |
Retornar uma coleção de referências de conjunto de prateleiras superficial. |
| get |
Obter itens de trabalho associados a um conjunto de prateleiras. |
| get |
Fornece contagem de arquivos e bytes não compactados para uma coleção/projeto em um escopo específico para TFVC. |
Detalhes do construtor
TfvcRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do método
createChangeset(TfvcChangeset, string)
Crie um novo conjunto de alterações.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Parâmetros
- changeset
- TfvcChangeset
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
Retorna conjuntos de alterações para uma determinada lista de IDs do conjunto de alterações.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parâmetros
- changesetsRequestData
- TfvcChangesetsRequestData
Lista de IDs do conjunto de alterações.
Retornos
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Obtenha uma única hierarquia de ramificação no caminho fornecido com pais ou filhos, conforme especificado.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parâmetros
- path
-
string
Caminho completo para o branch. Padrão: $/ Exemplos: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
ID do projeto ou nome do projeto
- includeParent
-
boolean
Retorne o branch pai, se houver um. Padrão: False
- includeChildren
-
boolean
Retornar ramificações filho, se houver algum. Padrão: False
Retornos
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Obtenha uma coleção de raízes de filiais, crianças de primeiro nível, galhos sem pais.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- includeParent
-
boolean
Retorne o branch pai, se houver um. Padrão: False
- includeChildren
-
boolean
Retornar os branches filho para cada branch raiz. Padrão: False
- includeDeleted
-
boolean
Retornar branches excluídos. Padrão: False
- includeLinks
-
boolean
Retornar links. Padrão: False
Retornos
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Obter hierarquias de ramificação abaixo do scopePath especificado
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parâmetros
- scopePath
-
string
Caminho completo para o branch. Padrão: $/ Exemplos: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
ID do projeto ou nome do projeto
- includeDeleted
-
boolean
Retornar branches excluídos. Padrão: False
- includeLinks
-
boolean
Retornar links. Padrão: False
Retornos
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Recuperar um conjunto de alterações do 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
ID do conjunto de alterações a ser recuperada.
- project
-
string
ID do projeto ou nome do projeto
- maxChangeCount
-
number
Número de alterações a serem retornadas (máximo de 100 alterações) Padrão: 0
- includeDetails
-
boolean
Inclua detalhes da política e marcar anotações na resposta. Padrão: false
- includeWorkItems
-
boolean
Inclua workitems. Padrão: false
- maxCommentLength
-
number
Inclua detalhes sobre itens de trabalho associados na resposta. Padrão: nulo
- includeSourceRename
-
boolean
Inclua renomeações. Padrão: false
- skip
-
number
Número de resultados a serem ignoradas. Padrão: nulo
- top
-
number
O número máximo de resultados a serem retornados. Padrão: nulo
- orderby
-
string
Os resultados são classificados por ID em ordem decrescente por padrão. Use id asc para classificar por ID em ordem crescente.
- searchCriteria
- TfvcChangesetSearchCriteria
Critérios a seguir disponíveis (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Padrão: nulo
Retornos
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Recupere as alterações do Tfvc para um determinado conjunto de alterações.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parâmetros
- id
-
number
ID do conjunto de alterações. Padrão: nulo
- skip
-
number
Número de resultados a serem ignoradas. Padrão: nulo
- top
-
number
O número máximo de resultados a serem retornados. Padrão: nulo
Retornos
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Recuperar conjuntos de alterações do Tfvc
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- maxCommentLength
-
number
Inclua detalhes sobre itens de trabalho associados na resposta. Padrão: nulo
- skip
-
number
Número de resultados a serem ignoradas. Padrão: nulo
- top
-
number
O número máximo de resultados a serem retornados. Padrão: nulo
- orderby
-
string
Os resultados são classificados por ID em ordem decrescente por padrão. Use id asc para classificar por ID em ordem crescente.
- searchCriteria
- TfvcChangesetSearchCriteria
Critérios a seguir disponíveis (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Padrão: nulo
Retornos
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Recupera os itens de trabalho associados a um conjunto de alterações específico.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parâmetros
- id
-
number
ID do conjunto de alterações.
Retornos
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Parâmetros
- path
-
string
Caminho de controle de versão de um item individual a ser retornado.
- project
-
string
ID do projeto ou nome do projeto
- fileName
-
string
nome do arquivo do item retornado.
- download
-
boolean
Se for true, crie um anexo baixável.
- scopePath
-
string
Caminho de controle de versão de uma pasta para retornar vários itens.
- recursionLevel
- VersionControlRecursionType
Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
- versionDescriptor
- TfvcVersionDescriptor
Descritor de versão. O padrão é nulo.
- includeContent
-
boolean
Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
Retornos
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parâmetros
- path
-
string
Caminho de controle de versão de um item individual a ser retornado.
- project
-
string
ID do projeto ou nome do projeto
- fileName
-
string
nome do arquivo do item retornado.
- download
-
boolean
Se for true, crie um anexo baixável.
- scopePath
-
string
Caminho de controle de versão de uma pasta para retornar vários itens.
- recursionLevel
- VersionControlRecursionType
Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
- versionDescriptor
- TfvcVersionDescriptor
Descritor de versão. O padrão é nulo.
- includeContent
-
boolean
Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
Retornos
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Obter uma lista de itens Tfvc
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- scopePath
-
string
Caminho de controle de versão de uma pasta para retornar vários itens.
- recursionLevel
- VersionControlRecursionType
Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
- includeLinks
-
boolean
True para incluir links.
- versionDescriptor
- TfvcVersionDescriptor
Retornos
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Poste para recuperar um conjunto de itens com uma lista de caminhos ou um caminho longo. Permite especificar os descritores recursionLevel e version para cada caminho.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Parâmetros
- itemRequestData
- TfvcItemRequestData
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Poste para recuperar um conjunto de itens com uma lista de caminhos ou um caminho longo. Permite especificar os descritores recursionLevel e version para cada caminho.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Parâmetros
- itemRequestData
- TfvcItemRequestData
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Parâmetros
- path
-
string
Caminho de controle de versão de um item individual a ser retornado.
- project
-
string
ID do projeto ou nome do projeto
- fileName
-
string
nome do arquivo do item retornado.
- download
-
boolean
Se for true, crie um anexo baixável.
- scopePath
-
string
Caminho de controle de versão de uma pasta para retornar vários itens.
- recursionLevel
- VersionControlRecursionType
Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
- versionDescriptor
- TfvcVersionDescriptor
Descritor de versão. O padrão é nulo.
- includeContent
-
boolean
Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
Retornos
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Obter Metadados de Item e/ou Conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parâmetros
- path
-
string
Caminho de controle de versão de um item individual a ser retornado.
- project
-
string
ID do projeto ou nome do projeto
- fileName
-
string
nome do arquivo do item retornado.
- download
-
boolean
Se for true, crie um anexo baixável.
- scopePath
-
string
Caminho de controle de versão de uma pasta para retornar vários itens.
- recursionLevel
- VersionControlRecursionType
Nenhum (apenas o item) ou OneLevel (conteúdo de uma pasta).
- versionDescriptor
- TfvcVersionDescriptor
Descritor de versão. O padrão é nulo.
- includeContent
-
boolean
Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
Retornos
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Obtenha um único rótulo profundo.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parâmetros
- labelId
-
string
Identificador exclusivo do rótulo
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<TfvcLabel>
getLabelItems(string, number, number)
Obter itens sob um rótulo.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parâmetros
- labelId
-
string
Identificador exclusivo do rótulo
- top
-
number
Número máximo de itens a serem retornados
- skip
-
number
Número de itens a serem pulados
Retornos
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Obtenha uma coleção de referências de rótulo superficial.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parâmetros
- requestData
- TfvcLabelRequestData
labelScope, name, owner e itemLabelFilter
- project
-
string
ID do projeto ou nome do projeto
- top
-
number
Número máximo de rótulos a serem retornados, o padrão é 100 quando indefinido
- skip
-
number
Número de rótulos a serem ignoradas
Retornos
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Obtenha um único conjunto de prateleiras profundas.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parâmetros
- shelvesetId
-
string
ID exclusiva do Shelveset
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount e maxCommentLength
Retornos
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Obtenha as alterações incluídas em um conjunto de prateleiras.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parâmetros
- shelvesetId
-
string
ID exclusiva do Shelveset
- top
-
number
Número máximo de alterações a serem retornadas
- skip
-
number
Número de alterações a serem ignoradas
Retornos
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Retornar uma coleção de referências de conjunto de prateleiras superficial.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parâmetros
- requestData
- TfvcShelvesetRequestData
name, owner e maxCommentLength
- top
-
number
Número máximo de conjuntos de prateleiras a serem retornados
- skip
-
number
Número de conjuntos de prateleiras a serem ignoradas
Retornos
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Obter itens de trabalho associados a um conjunto de prateleiras.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parâmetros
- shelvesetId
-
string
ID exclusiva do Shelveset
Retornos
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Fornece contagem de arquivos e bytes não compactados para uma coleção/projeto em um escopo específico para TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- scopePath
-
string
'$/' para coleção, '$/project' para um projeto específico
Retornos
Promise<TfvcStatistics>
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de