WikiRestClient class

new WikiRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

在 Wiki 页面上添加注释。

function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>

参数

返回

在 Wiki 页面批注中添加反应。

function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>

参数

返回

在 Wiki 页面上的批注中上传附件。

function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>

参数

返回

创建新的页面视图统计信息资源或更新现有页面视图统计信息资源。

function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>

参数

返回

创建 Wiki 资源。

function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>

参数

返回

删除 Wiki 页面上的注释。

function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>

参数

返回

删除 Wiki 页面批注中的反应。

function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>

参数

返回

删除与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。

function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>

参数

返回

获取项目或集合中的所有 Wiki。

function getAllWikis(project?: string): Promise<WikiV2[]>

参数

返回

在 Wiki 页面上的批注中下载附件。

function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>

参数

返回

返回与 Wiki 页面关联的注释。

function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>

参数

返回

获取使用给定反应类型为给定 Wiki 注释做出反应的用户的列表。 支持分页，默认页面大小一次为 100 个用户。

function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>

参数

返回

获取所提供页面 ID 的 Wiki 页面的元数据或内容。内容协商是根据请求中发送的 Accept 标头完成的。

function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>

参数

返回

获取所提供页面 ID 的 Wiki 页面的元数据或内容。内容协商是根据请求中发送的 Accept 标头完成的。

function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>

参数

返回

返回对应于页面 ID 的页面详细信息。

function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>

参数

返回

返回 Wiki 页面的可分页列表

function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>

参数

返回

获取提供的路径的 Wiki 页面的元数据或内容。 内容协商是根据请求中发送的 Accept 标头完成的。

function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>

参数

返回

获取提供的路径的 Wiki 页面的元数据或内容。 内容协商是根据请求中发送的 Accept 标头完成的。

function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

参数

返回

获取与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。

function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>

参数

返回

返回可分页的批注列表。

function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>

参数

返回

更新 Wiki 页面上的注释。

function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>

参数

返回

更新与使用更新参数提供的 Wiki ID 或 Wiki 名称对应的 Wiki。

function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>

参数

返回