CoreRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Core |
Propriedades
| RESOURCE_AREA_ID |
Métodos
| create |
|
| create |
|
| create |
|
| create |
Crie uma equipe em um projeto de equipe. |
| delete |
|
| delete |
|
| delete |
Excluir uma equipe. |
| get |
Obtenha uma lista de todas as equipes. |
| get |
|
| get |
|
| get |
|
| get |
Obter um processo por ID. |
| get |
Obtenha uma lista de processos. |
| get |
Obtenha o projeto com a ID ou o nome especificados, incluindo, opcionalmente, recursos. |
| get |
Obtenha a coleção de projetos com a ID ou o nome especificados. |
| get |
Obtenha referências de coleção de projetos para este aplicativo. |
| get |
Obtém o histórico de alterações no projeto. |
| get |
Obtenha uma coleção de propriedades do projeto de equipe. |
| get |
Obtenha todos os projetos na organização aos quais o usuário autenticado tem acesso. |
| get |
Obtenha uma coleção de propriedades de projeto de equipe para vários projetos. |
| get |
Obtém a lista de equipes legíveis pelo usuário em um projeto e o usuário do Teams é membro (excluído da lista legível). |
| get |
|
| get |
Obtenha uma equipe específica. |
| get |
Obtenha uma lista de membros para uma equipe específica. |
| get |
Obtenha uma lista de equipes. |
| queue |
Enfileira um projeto a ser criado. Use GetOperation para marcar periodicamente para criar status de projeto. |
| queue |
Enfileira um projeto a ser excluído. Use GetOperation para marcar periodicamente para excluir status de projeto. |
| remove |
Remove o avatar do projeto. |
| set |
Define o avatar do projeto. |
| set |
Criar, atualizar e excluir propriedades do projeto de equipe. |
| update |
|
| update |
Atualize o nome, a abreviação, a descrição ou a restauração de um projeto existente. |
| update |
Atualize o nome e/ou a descrição de uma equipe. |
Detalhes do construtor
CoreRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do método
createConnectedService(WebApiConnectedServiceDetails, string)
function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>Parâmetros
- connectedServiceCreationData
- WebApiConnectedServiceDetails
- projectId
-
string
Retornos
Promise<WebApiConnectedService>
createIdentityMru(IdentityData, string)
function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parâmetros
- mruData
- IdentityData
- mruName
-
string
Retornos
Promise<void>
createOrUpdateProxy(Proxy)
function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>Parâmetros
- proxy
- Proxy
Retornos
Promise<Proxy>
createTeam(WebApiTeam, string)
Crie uma equipe em um projeto de equipe.
function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>Parâmetros
- team
- WebApiTeam
Os dados da equipe usados para criar a equipe.
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe no qual criar a equipe.
Retornos
Promise<WebApiTeam>
deleteIdentityMru(IdentityData, string)
function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parâmetros
- mruData
- IdentityData
- mruName
-
string
Retornos
Promise<void>
deleteProxy(string, string)
function deleteProxy(proxyUrl: string, site?: string): Promise<void>Parâmetros
- proxyUrl
-
string
- site
-
string
Retornos
Promise<void>
deleteTeam(string, string)
Excluir uma equipe.
function deleteTeam(projectId: string, teamId: string): Promise<void>Parâmetros
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe que contém a equipe a ser excluída.
- teamId
-
string
O nome ou a ID da equipe a ser excluída.
Retornos
Promise<void>
getAllTeams(boolean, number, number, boolean)
Obtenha uma lista de todas as equipes.
function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parâmetros
- mine
-
boolean
Se for true, retorne todas as equipes solicitando que o usuário seja membro. Caso contrário, retorne que todos os usuários do Teams tenham acesso de leitura.
- top
-
number
Número máximo de equipes a serem retornadas.
- skip
-
number
Número de equipes a serem ignoradas.
- expandIdentity
-
boolean
Um valor que indica se as informações de identidade devem ou não ser expandidas no objeto WebApiTeam resultante.
Retornos
Promise<WebApiTeam[]>
getConnectedServiceDetails(string, string)
function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>Parâmetros
- projectId
-
string
- name
-
string
Retornos
Promise<WebApiConnectedServiceDetails>
getConnectedServices(string, ConnectedServiceKind)
function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>Parâmetros
- projectId
-
string
- kind
- ConnectedServiceKind
Retornos
Promise<WebApiConnectedService[]>
getIdentityMru(string)
function getIdentityMru(mruName: string): Promise<IdentityRef[]>Parâmetros
- mruName
-
string
Retornos
Promise<IdentityRef[]>
getProcessById(string)
Obter um processo por ID.
function getProcessById(processId: string): Promise<Process>Parâmetros
- processId
-
string
ID de um processo.
Retornos
Promise<Process>
getProcesses()
Obtenha uma lista de processos.
function getProcesses(): Promise<Process[]>Retornos
Promise<Process[]>
getProject(string, boolean, boolean)
Obtenha o projeto com a ID ou o nome especificados, incluindo, opcionalmente, recursos.
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>Parâmetros
- projectId
-
string
- includeCapabilities
-
boolean
Inclua recursos (como controle do código-fonte) no resultado do projeto de equipe (padrão: false).
- includeHistory
-
boolean
Pesquise em projetos renomeado (que tinham esse nome no passado).
Retornos
Promise<TeamProject>
getProjectCollection(string)
Obtenha a coleção de projetos com a ID ou o nome especificados.
function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>Parâmetros
- collectionId
-
string
Retornos
Promise<TeamProjectCollection>
getProjectCollections(number, number)
Obtenha referências de coleção de projetos para este aplicativo.
function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>Parâmetros
- top
-
number
- skip
-
number
Retornos
Promise<TeamProjectCollectionReference[]>
getProjectHistoryEntries(number)
Obtém o histórico de alterações no projeto.
function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>Parâmetros
- minRevision
-
number
O número mínimo de revisão a ser retornado no histórico.
Retornos
Promise<ProjectInfo[]>
getProjectProperties(string, string[])
Obtenha uma coleção de propriedades do projeto de equipe.
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>Parâmetros
- projectId
-
string
A ID do projeto de equipe.
- keys
-
string[]
Uma cadeia de caracteres delimitada por vírgulas de nomes de propriedade do projeto de equipe. Há suporte para caracteres curinga ("?" e "*"). Se nenhuma chave for especificada, todas as propriedades serão retornadas.
Retornos
Promise<ProjectProperty[]>
getProjects(any, number, number, number, boolean)
Obtenha todos os projetos na organização aos quais o usuário autenticado tem acesso.
function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>Parâmetros
- stateFilter
-
any
Filtrar projetos de equipe em um estado de projeto de equipe específico (padrão: WellFormed).
- top
-
number
- skip
-
number
- continuationToken
-
number
Ponteiro que mostra quantos projetos já foram buscados.
- getDefaultTeamImageUrl
-
boolean
Retornos
Promise<PagedList<TeamProjectReference>>
getProjectsProperties(string[], string[])
Obtenha uma coleção de propriedades de projeto de equipe para vários projetos.
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>Parâmetros
- projectIds
-
string[]
Uma cadeia de caracteres delimitada por vírgulas de IDs de projeto de equipe
- properties
-
string[]
Retornos
Promise<ProjectProperties[]>
getProjectTeamsByCategory(string, boolean, number, number)
Obtém a lista de equipes legíveis pelo usuário em um projeto e o usuário do Teams é membro (excluído da lista legível).
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>Parâmetros
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe que contém as equipes a serem recuperadas.
- expandIdentity
-
boolean
Um valor que indica se as informações de identidade devem ou não ser expandidas no objeto WebApiTeam resultante.
- top
-
number
Número máximo de equipes a serem retornadas.
- skip
-
number
Número de equipes a serem ignoradas.
Retornos
Promise<CategorizedWebApiTeams>
getProxies(string)
function getProxies(proxyUrl?: string): Promise<Proxy[]>Parâmetros
- proxyUrl
-
string
Retornos
Promise<Proxy[]>
getTeam(string, string, boolean)
Obtenha uma equipe específica.
function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>Parâmetros
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe que contém a equipe.
- teamId
-
string
O nome ou a ID (GUID) da equipe.
- expandIdentity
-
boolean
Um valor que indica se as informações de identidade devem ou não ser expandidas no objeto WebApiTeam resultante.
Retornos
Promise<WebApiTeam>
getTeamMembersWithExtendedProperties(string, string, number, number)
Obtenha uma lista de membros para uma equipe específica.
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>Parâmetros
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe ao qual a equipe pertence.
- teamId
-
string
O nome ou a ID (GUID) da equipe .
- top
-
number
- skip
-
number
Retornos
Promise<TeamMember[]>
getTeams(string, boolean, number, number, boolean)
Obtenha uma lista de equipes.
function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parâmetros
- projectId
-
string
- mine
-
boolean
Se true retornar todas as equipes que solicitam que o usuário seja membro, caso contrário, retorne que todos os usuários das equipes tenham acesso de leitura.
- top
-
number
Número máximo de equipes a serem retornadas.
- skip
-
number
Número de equipes a serem ignoradas.
- expandIdentity
-
boolean
Um valor que indica se as informações de identidade devem ou não ser expandidas no objeto WebApiTeam resultante.
Retornos
Promise<WebApiTeam[]>
queueCreateProject(TeamProject)
Enfileira um projeto a ser criado. Use GetOperation para marcar periodicamente para criar status de projeto.
function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>Parâmetros
- projectToCreate
- TeamProject
O projeto a ser criado.
Retornos
Promise<OperationReference>
queueDeleteProject(string)
Enfileira um projeto a ser excluído. Use GetOperation para marcar periodicamente para excluir status de projeto.
function queueDeleteProject(projectId: string): Promise<OperationReference>Parâmetros
- projectId
-
string
A ID do projeto a ser excluído.
Retornos
Promise<OperationReference>
removeProjectAvatar(string)
Remove o avatar do projeto.
function removeProjectAvatar(projectId: string): Promise<void>Parâmetros
- projectId
-
string
A ID ou o nome do projeto.
Retornos
Promise<void>
setProjectAvatar(ProjectAvatar, string)
Define o avatar do projeto.
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>Parâmetros
- avatarBlob
- ProjectAvatar
O objeto de dados de blob de avatar a ser carregado.
- projectId
-
string
A ID ou o nome do projeto.
Retornos
Promise<void>
setProjectProperties(string, JsonPatchDocument)
Criar, atualizar e excluir propriedades do projeto de equipe.
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>Parâmetros
- projectId
-
string
A ID do projeto de equipe.
- patchDocument
- JsonPatchDocument
Um documento de patch JSON que representa uma matriz de operações de propriedade. Consulte RFC 6902 para obter mais detalhes sobre o Patch JSON. Os verbos de operação aceitos são Adicionar e Remover, em que Add é usado para criar e atualizar propriedades. O caminho consiste em uma barra e um nome de propriedade.
Retornos
Promise<void>
updateIdentityMru(IdentityData, string)
function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parâmetros
- mruData
- IdentityData
- mruName
-
string
Retornos
Promise<void>
updateProject(TeamProject, string)
Atualize o nome, a abreviação, a descrição ou a restauração de um projeto existente.
function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>Parâmetros
- projectUpdate
- TeamProject
As atualizações do projeto. O estado deve ser definido como wellFormed para restaurar o projeto.
- projectId
-
string
A ID do projeto a ser atualizado.
Retornos
Promise<OperationReference>
updateTeam(WebApiTeam, string, string)
Atualize o nome e/ou a descrição de uma equipe.
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>Parâmetros
- teamData
- WebApiTeam
- projectId
-
string
O nome ou a ID (GUID) do projeto de equipe que contém a equipe a ser atualizada.
- teamId
-
string
O nome da ID da equipe a ser atualizada.
Retornos
Promise<WebApiTeam>
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