WikiRestClient class
應該使用 (衍生自) 的基類，向 VSS REST API 提出要求
- Extends
建構函式
| Wiki |
屬性
| RESOURCE_AREA_ID |
方法
建構函式詳細資料
WikiRestClient(IVssRestClientOptions)
屬性詳細資料
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string屬性值
string
方法詳細資料
addComment(CommentCreateParameters, string, string, number)
在 Wiki 頁面上新增批註。
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>參數
- request
- CommentCreateParameters
批註建立要求。
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
傳回
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
在 Wiki 頁面批註上新增反應。
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱
- pageId
-
number
Wiki 頁面識別碼
- commentId
-
number
相關聯批註的識別碼
- type
- CommentReactionType
要加入之反應的類型
傳回
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
在 Wiki 頁面上的批註上上傳附件。
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>參數
- content
-
any
要上傳的內容
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
傳回
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
建立新的頁面檢視統計資料資源，或更新現有的頁面檢視統計資料資源。
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- wikiVersion
- GitVersionDescriptor
Wiki 版本。
- path
-
string
Wiki 頁面路徑。
- oldPath
-
string
舊的頁面路徑。 這是選擇性的，需要重新命名現有頁面檢視統計資料中的路徑。
傳回
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
建立 Wiki 資源。
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>參數
- wikiCreateParams
- WikiCreateParametersV2
Wiki 建立的參數。
- project
-
string
專案識別碼或專案名稱
傳回
Promise<WikiV2>
deleteComment(string, string, number, number)
刪除 Wiki 頁面上的批註。
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或名稱。
- pageId
-
number
Wiki 頁面識別碼。
- id
-
number
批註識別碼。
傳回
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
刪除 Wiki 頁面批註上的反應。
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或名稱
- pageId
-
number
Wiki 頁面識別碼
- commentId
-
number
相關聯批註的識別碼
- type
- CommentReactionType
正在刪除之反應的類型
傳回
Promise<CommentReaction>
deleteWiki(string, string)
刪除與提供的 Wiki 識別碼或 Wiki 名稱對應的 Wiki。
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>參數
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- project
-
string
專案識別碼或專案名稱
傳回
Promise<WikiV2>
getAllWikis(string)
取得專案或集合中的所有 Wiki。
function getAllWikis(project?: string): Promise<WikiV2[]>參數
- project
-
string
專案識別碼或專案名稱
傳回
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
在 Wiki 頁面上的批註上下載附件。
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- attachmentId
-
string
附件識別碼。
傳回
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
傳回與 Wiki 頁面相關聯的批註。
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- id
-
number
要傳回之批註的識別碼。
- excludeDeleted
-
boolean
指定是否應該略過已刪除的批註。
- expand
- CommentExpandOptions
指定批註的其他資料擷取選項。
傳回
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
取得已針對具有指定反應類型之指定 Wiki 批註做出反應的使用者清單。 支援分頁，預設頁面大小一次為 100 位使用者。
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- commentId
-
number
相關聯批註的識別碼
- type
- CommentReactionType
要求參與使用者之反應的類型
- top
-
number
指定頁面中要傳回的編列使用者數目。 選擇性，預設值為 100
- skip
-
number
要略過下一組參與使用者分頁的參與使用者數目，預設為 0
傳回
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
取得所提供頁面識別碼之 Wiki 頁面的中繼資料或內容。內容交涉是根據要求中傳送的標頭來完成 Accept 。
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- id
-
number
Wiki 頁面識別碼。
- recursionLevel
- VersionControlRecursionType
子頁面擷取的遞迴層級。 預設為 None (選擇性) 。
- includeContent
-
boolean
True 是表示 在 Json 內容類型的回應中包含頁面的內容。 預設為 false (選擇性)
傳回
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
取得所提供頁面識別碼之 Wiki 頁面的中繼資料或內容。內容交涉是根據要求中傳送的標頭來完成 Accept 。
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- id
-
number
Wiki 頁面識別碼。
- recursionLevel
- VersionControlRecursionType
子頁面擷取的遞迴層級。 預設為 None (選擇性) 。
- includeContent
-
boolean
True 是表示 在 Json 內容類型的回應中包含頁面的內容。 預設為 false (選擇性)
傳回
Promise<ArrayBuffer>
getPageData(string, string, number, number)
傳回對應至頁面識別碼的頁面詳細資料。
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- pageViewsForDays
-
number
過去 N 天，要傳回頁面檢視的目前日期。 這包含目前日期。
傳回
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
傳回 Wiki 頁面的可分頁清單
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>參數
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki 批次頁面要求。
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- versionDescriptor
- GitVersionDescriptor
頁面的 GitVersionDescriptor。 (ProjectWiki) 時為選擇性。
傳回
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
取得所提供路徑之 Wiki 頁面的中繼資料或內容。 內容交涉是根據要求中傳送的標頭來完成 Accept 。
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- path
-
string
Wiki 頁面路徑。
- recursionLevel
- VersionControlRecursionType
子頁面擷取的遞迴層級。 預設為 None (選擇性) 。
- versionDescriptor
- GitVersionDescriptor
頁面的 GitVersionDescriptor。 預設為預設分支 (選擇性) 。
- includeContent
-
boolean
True 是表示 在 Json 內容類型的回應中包含頁面的內容。 預設為 false (選擇性)
傳回
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
取得所提供路徑之 Wiki 頁面的中繼資料或內容。 內容交涉是根據要求中傳送的標頭來完成 Accept 。
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- path
-
string
Wiki 頁面路徑。
- recursionLevel
- VersionControlRecursionType
子頁面擷取的遞迴層級。 預設為 None (選擇性) 。
- versionDescriptor
- GitVersionDescriptor
頁面的 GitVersionDescriptor。 預設為預設分支 (選擇性) 。
- includeContent
-
boolean
True 是表示 在 Json 內容類型的回應中包含頁面的內容。 預設為 false (選擇性)
傳回
Promise<ArrayBuffer>
getWiki(string, string)
取得與所提供 Wiki 識別碼或 Wiki 名稱對應的 Wiki。
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>參數
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- project
-
string
專案識別碼或專案名稱
傳回
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
傳回可分頁的批註清單。
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>參數
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- top
-
number
要傳回的批註數目上限。
- continuationToken
-
string
用來查詢下一頁的批註。
- excludeDeleted
-
boolean
指定是否應該略過已刪除的批註。
- expand
- CommentExpandOptions
指定批註的其他資料擷取選項。
- order
- CommentSortOrder
應該傳回批註的順序。
- parentId
-
number
父批註的 CommentId。
傳回
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
更新 Wiki 頁面上的批註。
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>參數
- comment
- CommentUpdateParameters
批註更新要求。
- project
-
string
專案識別碼或專案名稱
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- pageId
-
number
Wiki 頁面識別碼。
- id
-
number
批註識別碼。
傳回
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
更新與使用更新參數提供的 Wiki 識別碼或 Wiki 名稱相對應的 Wiki。
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>參數
- updateParameters
- WikiUpdateParameters
更新參數。
- wikiIdentifier
-
string
Wiki 識別碼或 Wiki 名稱。
- project
-
string
專案識別碼或專案名稱
傳回
Promise<WikiV2>