CoreRestClient class
应使用的基类 (派生自) 以向 VSS REST API 发出请求
- Extends
构造函数
| Core |
属性
| RESOURCE_AREA_ID |
方法
构造函数详细信息
CoreRestClient(IVssRestClientOptions)
属性详细信息
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string属性值
string
方法详细信息
createConnectedService(WebApiConnectedServiceDetails, string)
function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>参数
- connectedServiceCreationData
- WebApiConnectedServiceDetails
- projectId
-
string
返回
Promise<WebApiConnectedService>
createIdentityMru(IdentityData, string)
function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>参数
- mruData
- IdentityData
- mruName
-
string
返回
Promise<void>
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)
在团队项目中创建团队。
function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>参数
- team
- WebApiTeam
用于创建团队的团队数据。
- projectId
-
string
要在其中创建团队的团队项目的名称或 ID (GUID) 。
返回
Promise<WebApiTeam>
deleteIdentityMru(IdentityData, string)
function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>参数
- mruData
- IdentityData
- mruName
-
string
返回
Promise<void>
deleteProxy(string, string)
function deleteProxy(proxyUrl: string, site?: string): Promise<void>参数
- proxyUrl
-
string
- site
-
string
返回
Promise<void>
deleteTeam(string, string)
删除团队。
function deleteTeam(projectId: string, teamId: string): Promise<void>参数
- projectId
-
string
包含要删除的团队的团队项目的名称或 ID (GUID) 。
- teamId
-
string
要删除的团队的名称或 ID。
返回
Promise<void>
getAllTeams(boolean, number, number, boolean)
获取所有团队的列表。
function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>参数
- mine
-
boolean
如果为 true，则返回请求用户为成员的所有团队。 否则，返回所有 teams 用户具有读取访问权限。
- top
-
number
要返回的最大团队数。
- skip
-
number
要跳过的团队数。
- expandIdentity
-
boolean
一个 值，该值指示是否在结果 WebApiTeam 对象中展开标识信息。
返回
Promise<WebApiTeam[]>
getConnectedServiceDetails(string, string)
function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>参数
- projectId
-
string
- name
-
string
返回
Promise<WebApiConnectedServiceDetails>
getConnectedServices(string, ConnectedServiceKind)
function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>参数
- projectId
-
string
- kind
- ConnectedServiceKind
返回
Promise<WebApiConnectedService[]>
getIdentityMru(string)
function getIdentityMru(mruName: string): Promise<IdentityRef[]>参数
- mruName
-
string
返回
Promise<IdentityRef[]>
getProcessById(string)
按 ID 获取进程。
function getProcessById(processId: string): Promise<Process>参数
- processId
-
string
进程的 ID。
返回
Promise<Process>
getProcesses()
getProject(string, boolean, boolean)
获取具有指定 ID 或名称的项目，（可选）包括功能。
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>参数
- projectId
-
string
- includeCapabilities
-
boolean
将源代码管理) 等功能包含在团队项目结果 (默认 (：false) 。
- includeHistory
-
boolean
在重命名的项目中搜索 (，这些项目在过去) 中具有此类名称。
返回
Promise<TeamProject>
getProjectCollection(string)
获取具有指定 ID 或名称的项目集合。
function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>参数
- collectionId
-
string
返回
Promise<TeamProjectCollection>
getProjectCollections(number, number)
获取此应用程序的项目集合引用。
function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>参数
- top
-
number
- skip
-
number
返回
Promise<TeamProjectCollectionReference[]>
getProjectHistoryEntries(number)
获取项目更改的历史记录。
function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>参数
- minRevision
-
number
历史记录中要返回的最小修订号。
返回
Promise<ProjectInfo[]>
getProjectProperties(string, string[])
获取团队项目属性的集合。
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>参数
- projectId
-
string
团队项目 ID。
- keys
-
string[]
以逗号分隔的团队项目属性名称字符串。 支持通配符 (“？”和“*”) 。 如果未指定键，将返回所有属性。
返回
Promise<ProjectProperty[]>
getProjects(any, number, number, number, boolean)
获取组织中经过身份验证的用户有权访问的所有项目。
function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>参数
- stateFilter
-
any
筛选处于特定团队项目状态的团队项目 (默认值：WellFormed) 。
- top
-
number
- skip
-
number
- continuationToken
-
number
显示已提取的项目数的指针。
- getDefaultTeamImageUrl
-
boolean
返回
Promise<PagedList<TeamProjectReference>>
getProjectsProperties(string[], string[])
获取多个项目的团队项目属性集合。
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>参数
- projectIds
-
string[]
团队项目 ID 的逗号分隔字符串
- properties
-
string[]
返回
Promise<ProjectProperties[]>
getProjectTeamsByCategory(string, boolean, number, number)
获取项目中用户可读团队的列表，并且团队用户是 (从可读列表) 中排除的成员。
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>参数
- projectId
-
string
包含要检索的团队的团队项目的名称或 ID (GUID) 。
- expandIdentity
-
boolean
一个 值，该值指示是否在结果 WebApiTeam 对象中展开标识信息。
- top
-
number
要返回的最大团队数。
- skip
-
number
要跳过的团队数。
返回
Promise<CategorizedWebApiTeams>
getProxies(string)
getTeam(string, string, boolean)
获取特定团队。
function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>参数
- projectId
-
string
包含团队的团队项目的名称或 ID (GUID) 。
- teamId
-
string
团队的 GUID) (名称或 ID。
- expandIdentity
-
boolean
一个 值，该值指示是否在结果 WebApiTeam 对象中展开标识信息。
返回
Promise<WebApiTeam>
getTeamMembersWithExtendedProperties(string, string, number, number)
获取特定团队的成员列表。
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>参数
- projectId
-
string
团队所属团队项目的名称或 ID (GUID) 。
- teamId
-
string
团队 (GUID) 的名称或 ID。
- top
-
number
- skip
-
number
返回
Promise<TeamMember[]>
getTeams(string, boolean, number, number, boolean)
获取团队列表。
function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>参数
- projectId
-
string
- mine
-
boolean
如果为 true，则返回请求用户为成员的所有团队，否则返回所有团队用户具有读取访问权限。
- top
-
number
要返回的最大团队数。
- skip
-
number
要跳过的团队数。
- expandIdentity
-
boolean
一个值，该值指示是否在结果 WebApiTeam 对象中展开标识信息。
返回
Promise<WebApiTeam[]>
queueCreateProject(TeamProject)
对要创建的项目进行排队。 使用 GetOperation 定期检查创建项目状态。
function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>参数
- projectToCreate
- TeamProject
要创建的项目。
返回
Promise<OperationReference>
queueDeleteProject(string)
对要删除的项目进行排队。 使用 GetOperation 定期检查删除项目状态。
function queueDeleteProject(projectId: string): Promise<OperationReference>参数
- projectId
-
string
要删除的项目的项目 ID。
返回
Promise<OperationReference>
removeProjectAvatar(string)
删除项目的头像。
function removeProjectAvatar(projectId: string): Promise<void>参数
- projectId
-
string
项目的 ID 或名称。
返回
Promise<void>
setProjectAvatar(ProjectAvatar, string)
设置项目的头像。
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>参数
- avatarBlob
- ProjectAvatar
要上传的头像 Blob 数据对象。
- projectId
-
string
项目的 ID 或名称。
返回
Promise<void>
setProjectProperties(string, JsonPatchDocument)
创建、更新和删除团队项目属性。
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>参数
- projectId
-
string
团队项目 ID。
- patchDocument
- JsonPatchDocument
表示属性操作数组的 JSON 修补程序文档。 有关 JSON 修补程序的更多详细信息，请参阅 RFC 6902。 接受的操作谓词为 Add 和 Remove，其中 Add 用于创建和更新属性。 路径由正斜杠和属性名称组成。
返回
Promise<void>
updateIdentityMru(IdentityData, string)
function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>参数
- mruData
- IdentityData
- mruName
-
string
返回
Promise<void>
updateProject(TeamProject, string)
更新现有项目的名称、缩写、说明或还原项目。
function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>参数
- projectUpdate
- TeamProject
项目的更新。 状态必须设置为 wellFormed 才能还原项目。
- projectId
-
string
要更新的项目的项目 ID。
返回
Promise<OperationReference>
updateTeam(WebApiTeam, string, string)
更新团队的名称和/或说明。
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>参数
- teamData
- WebApiTeam
- projectId
-
string
包含要更新的团队的团队项目的名称或 ID (GUID) 。
- teamId
-
string
要更新的团队的 ID 的名称。
返回
Promise<WebApiTeam>