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
要在其中建立小組之小組專案的名稱或識別碼 (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
包含要刪除之小組專案的名稱或識別碼 (GUID) 。
- teamId
-
string
要刪除之小組的名稱或識別碼。
傳回
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)
依識別碼取得進程。
function getProcessById(processId: string): Promise<Process>參數
- processId
-
string
進程的識別碼。
傳回
Promise<Process>
getProcesses()
getProject(string, boolean, boolean)
取得具有指定識別碼或名稱的專案，選擇性地包含功能。
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>參數
- projectId
-
string
- includeCapabilities
-
boolean
在 team 專案結果中包含原始檔控制) 之類的 (功能， (預設值：false) 。
- includeHistory
-
boolean
在已重新命名的專案內搜尋過去) 中具有這類名稱的 (。
傳回
Promise<TeamProject>
getProjectCollection(string)
取得具有指定識別碼或名稱的專案集合。
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[])
取得 Team 專案屬性的集合。
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>參數
- projectId
-
string
小組專案識別碼。
- keys
-
string[]
Team 專案屬性名稱的逗號分隔字串。 支援萬用字元 (「？」 和 「*」) 。 如果未指定任何索引鍵，則會傳回所有屬性。
傳回
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
篩選特定 Team 專案狀態中的小組專案， (預設值：WellFormed) 。
- top
-
number
- skip
-
number
- continuationToken
-
number
顯示已擷取多少專案的指標。
- getDefaultTeamImageUrl
-
boolean
傳回
Promise<PagedList<TeamProjectReference>>
getProjectsProperties(string[], string[])
取得多個專案的 Team 專案屬性集合。
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>參數
- projectIds
-
string[]
Team 專案識別碼的逗號分隔字串
- properties
-
string[]
傳回
Promise<ProjectProperties[]>
getProjectTeamsByCategory(string, boolean, number, number)
取得專案中使用者可讀取小組的清單，而 teams 使用者是已從可讀取清單中排除 (成員) 。
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>參數
- projectId
-
string
包含要擷取之小組專案的名稱或識別碼) (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
包含小組之小組專案的名稱或識別碼 (GUID) 。
- teamId
-
string
小組名稱或識別碼 (GUID) 。
- expandIdentity
-
boolean
值，指出是否要在結果 WebApiTeam 物件中展開識別資訊。
傳回
Promise<WebApiTeam>
getTeamMembersWithExtendedProperties(string, string, number, number)
取得特定小組的成員清單。
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>參數
- projectId
-
string
小組所屬小組專案的名稱或識別碼 (GUID) 。
- teamId
-
string
小組 的名稱或識別碼 (GUID) 。
- 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
要刪除之專案的專案識別碼。
傳回
Promise<OperationReference>
removeProjectAvatar(string)
移除專案的虛擬人偶。
function removeProjectAvatar(projectId: string): Promise<void>參數
- projectId
-
string
專案的識別碼或名稱。
傳回
Promise<void>
setProjectAvatar(ProjectAvatar, string)
設定專案的虛擬人偶。
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>參數
- avatarBlob
- ProjectAvatar
要上傳的虛擬人偶 Blob 資料物件。
- projectId
-
string
專案的識別碼或名稱。
傳回
Promise<void>
setProjectProperties(string, JsonPatchDocument)
建立、更新和刪除 Team 專案屬性。
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>參數
- projectId
-
string
小組專案識別碼。
- patchDocument
- JsonPatchDocument
JSON Patch 檔，表示屬性作業的陣列。 如需 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
要更新之專案的專案識別碼。
傳回
Promise<OperationReference>
updateTeam(WebApiTeam, string, string)
更新小組的名稱和/或描述。
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>參數
- teamData
- WebApiTeam
- projectId
-
string
包含要更新之小組專案的名稱或識別碼 (GUID) 。
- teamId
-
string
要更新之小組的識別碼名稱。
傳回
Promise<WebApiTeam>