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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
返回
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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称
- pageId
-
number
Wiki 页面 ID
- commentId
-
number
关联注释的 ID
- 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
返回
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
创建新的页面视图统计信息资源或更新现有的页面视图统计信息资源。
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 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
项目 ID 或项目名称
返回
Promise<WikiV2>
deleteComment(string, string, number, number)
删除 Wiki 页面上的批注。
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或名称。
- pageId
-
number
Wiki 页面 ID。
- id
-
number
批注 ID。
返回
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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或名称
- pageId
-
number
Wiki 页面 ID
- commentId
-
number
关联注释的 ID
- type
- CommentReactionType
要删除的反应的类型
返回
Promise<CommentReaction>
deleteWiki(string, string)
删除与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>参数
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- project
-
string
项目 ID 或项目名称
返回
Promise<WikiV2>
getAllWikis(string)
获取项目或集合中的所有 Wiki。
function getAllWikis(project?: string): Promise<WikiV2[]>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
在 Wiki 页面上的批注中下载附件。
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- attachmentId
-
string
附件 ID。
返回
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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- id
-
number
要返回的注释的 ID。
- 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- commentId
-
number
关联注释的 ID
- type
- CommentReactionType
请求参与用户的反应类型
- top
-
number
在给定页面中返回的已加盖用户数。 可选，默认值为 100
- skip
-
number
要跳过到下一组参与用户页面的参与用户数，默认值为 0
返回
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
获取所提供页面 ID 的 Wiki 页面的元数据或内容。内容协商基于请求中发送的 Accept 标头完成。
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- id
-
number
Wiki 页面 ID。
- recursionLevel
- VersionControlRecursionType
子页检索的递归级别。 默认为 None (可选) 。
- includeContent
-
boolean
如果为 True，则 Json 内容类型的响应中包含页面内容。 默认为 false (可选)
返回
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
获取所提供页面 ID 的 Wiki 页面的元数据或内容。内容协商基于请求中发送的 Accept 标头完成。
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- id
-
number
Wiki 页面 ID。
- recursionLevel
- VersionControlRecursionType
子页检索的递归级别。 默认为 None (可选) 。
- includeContent
-
boolean
如果为 True，则 Json 内容类型的响应中包含页面内容。 默认为 false (可选)
返回
Promise<ArrayBuffer>
getPageData(string, string, number, number)
返回对应于页面 ID 的页面详细信息。
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>参数
- project
-
string
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- path
-
string
Wiki 页面路径。
- recursionLevel
- VersionControlRecursionType
子页检索的递归级别。 默认为 None (可选) 。
- versionDescriptor
- GitVersionDescriptor
页面的 GitVersionDescriptor。 默认为 默认分支 (可选) 。
- includeContent
-
boolean
如果为 True，则 Json 内容类型的响应中包含页面内容。 默认为 false (可选)
返回
Promise<ArrayBuffer>
getWiki(string, string)
获取与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>参数
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- project
-
string
项目 ID 或项目名称
返回
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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- 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
项目 ID 或项目名称
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- pageId
-
number
Wiki 页面 ID。
- id
-
number
注释 ID。
返回
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
汇报与使用更新参数提供的 Wiki ID 或 Wiki 名称对应的 Wiki。
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>参数
- updateParameters
- WikiUpdateParameters
更新参数。
- wikiIdentifier
-
string
Wiki ID 或 Wiki 名称。
- project
-
string
项目 ID 或项目名称
返回
Promise<WikiV2>