WikiRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

WikiRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addComment(CommentCreateParameters, string, string, number)	Добавление комментария на вики-страницу.
addCommentReaction(string, string, number, number, CommentReactionType)	Добавление реакции на комментарий вики-страницы.
createCommentAttachment(any, string, string, number)	Загружает вложение в комментарий на вики-странице.
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)	Создает новый ресурс статистики представления страницы или обновляет существующий ресурс статистики представления страницы.
createWiki(WikiCreateParametersV2, string)	Создает вики-ресурс.
deleteComment(string, string, number, number)	Удаление комментария на вики-странице.
deleteCommentReaction(string, string, number, number, CommentReactionType)	Удаление реакции на комментарий вики-страницы.
deleteWiki(string, string)	Удаляет вики-сайт, соответствующий указанному идентификатору вики-сайта или имени вики-сайта.
getAllWikis(string)	Возвращает все вики-сайты в проекте или коллекции.
getAttachmentContent(string, string, number, string)	Скачивает вложение в комментарий на вики-странице.
getComment(string, string, number, number, boolean, CommentExpandOptions)	Возвращает комментарий, связанный с вики-страницей.
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)	Возвращает список пользователей, которые отреагировали на данный комментарий вики-сайта с заданным типом реакции. Поддерживает разбиение по страницам, размер страницы по умолчанию — 100 пользователей за раз.
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)	Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)	Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.
getPageData(string, string, number, number)	Возвращает сведения о странице, соответствующие идентификатору страницы.
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)	Возвращает список страничных страниц вики-страниц
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.
getWiki(string, string)	Возвращает вики-сайт, соответствующий указанному идентификатору вики-сайта или имени вики-сайта.
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)	Возвращает список примечаний, доступный для страницы.
updateComment(CommentUpdateParameters, string, string, number, number)	Обновление комментария на вики-странице.
updateWiki(WikiUpdateParameters, string, string)	Обновления вики-сайт, соответствующий идентификатору вики-сайта или имени вики-сайта, указанному с помощью параметров обновления.

Сведения о конструкторе

WikiRestClient(IVssRestClientOptions)

new WikiRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addComment(CommentCreateParameters, string, string, number)

Добавление комментария на вики-страницу.

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

Параметры

request

CommentCreateParameters

Запрос на создание комментария.

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

Возвращаемое значение

Promise<Comment>

addCommentReaction(string, string, number, number, CommentReactionType)

Добавление реакции на комментарий вики-страницы.

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

Параметры

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта

pageId

number

Идентификатор вики-страницы

commentId

number

Идентификатор связанного комментария

type

CommentReactionType

Тип добавляемой реакции

Возвращаемое значение

Promise<CommentReaction>

createCommentAttachment(any, string, string, number)

Загружает вложение в комментарий на вики-странице.

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

Параметры

content

any

Содержимое для отправки

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

Возвращаемое значение

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

Идентификатор или имя вики-сайта.

wikiVersion

GitVersionDescriptor

Вики-версия.

path

string

Путь к вики-странице.

oldPath

string

Старый путь к странице. Это необязательный параметр, который требуется для переименования пути в существующей статистике представления страницы.

Возвращаемое значение

Promise<WikiPageViewStats>

createWiki(WikiCreateParametersV2, string)

Создает вики-ресурс.

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

Параметры

wikiCreateParams

WikiCreateParametersV2

Параметры для создания вики-сайта.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<WikiV2>

deleteComment(string, string, number, number)

Удаление комментария на вики-странице.

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

Параметры

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

id

number

Идентификатор комментария.

Возвращаемое значение

Promise<void>

deleteCommentReaction(string, string, number, number, CommentReactionType)

Удаление реакции на комментарий вики-страницы.

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

Параметры

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта

pageId

number

Идентификатор вики-страницы

commentId

number

Идентификатор связанного комментария

type

CommentReactionType

Тип удаляемой реакции

Возвращаемое значение

Promise<CommentReaction>

deleteWiki(string, string)

Удаляет вики-сайт, соответствующий указанному идентификатору вики-сайта или имени вики-сайта.

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

Параметры

wikiIdentifier

string

Идентификатор или имя вики-сайта.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<WikiV2>

getAllWikis(string)

Возвращает все вики-сайты в проекте или коллекции.

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<WikiV2[]>

getAttachmentContent(string, string, number, string)

Скачивает вложение в комментарий на вики-странице.

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

Параметры

project

string

Идентификатор проекта или имя проекта

wikiIdentifier

string

Идентификатор или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

attachmentId

string

Идентификатор вложения.

Возвращаемое значение

Promise<ArrayBuffer>

getComment(string, string, number, number, boolean, CommentExpandOptions)

Возвращает комментарий, связанный с вики-страницей.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

id

number

Идентификатор возвращаемого комментария.

excludeDeleted

boolean

Укажите, следует ли пропускать удаленный комментарий.

expand

CommentExpandOptions

Указывает дополнительные параметры получения данных для комментариев.

Возвращаемое значение

Promise<Comment>

getEngagedUsers(string, string, number, number, CommentReactionType, number, number)

Возвращает список пользователей, которые отреагировали на данный комментарий вики-сайта с заданным типом реакции. Поддерживает разбиение по страницам, размер страницы по умолчанию — 100 пользователей за раз.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

commentId

number

Идентификатор связанного комментария

type

CommentReactionType

Тип реакции, для которой запрашиваются задействованные пользователи

top

number

Количество пользователей, которые будут возвращены на заданной странице. Необязательно, по умолчанию — 100

skip

number

Число задействованных пользователей, которые будут пропущены на страницу следующего набора задействованных пользователей, по умолчанию — 0

Возвращаемое значение

Promise<IdentityRef[]>

getPageByIdText(string, string, number, VersionControlRecursionType, boolean)

Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

id

number

Идентификатор вики-страницы.

recursionLevel

VersionControlRecursionType

Уровень рекурсии для получения вложенных страниц. Значение по None умолчанию — (необязательно).

includeContent

boolean

Значение true, чтобы включить содержимое страницы в ответ для типа контента Json. Значение по умолчанию — false (необязательно)

Возвращаемое значение

Promise<string>

getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)

Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

id

number

Идентификатор вики-страницы.

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

Идентификатор вики-сайта или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

pageViewsForDays

number

последние N дней с текущего дня, для которого должны быть возвращены представления страниц. Он включает текущий день.

Возвращаемое значение

Promise<WikiPageDetail>

getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)

Возвращает список страничных страниц вики-страниц

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

Параметры

pagesBatchRequest

WikiPagesBatchRequest

Запрос пакетной вики-страницы.

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor для страницы. (Необязательно в случае ProjectWiki.

Возвращаемое значение

Promise<PagedList<WikiPageDetail>>

getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)

Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

path

string

Путь к вики-странице.

recursionLevel

VersionControlRecursionType

Уровень рекурсии для получения вложенных страниц. Значение по None умолчанию — (необязательно).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor для страницы. По умолчанию используется ветвь по умолчанию (необязательно).

includeContent

boolean

Значение true, чтобы включить содержимое страницы в ответ для типа контента Json. Значение по умолчанию — false (необязательно)

Возвращаемое значение

Promise<string>

getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)

Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка, Accept отправленного в запросе.

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

Параметры

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

path

string

Путь к вики-странице.

recursionLevel

VersionControlRecursionType

Уровень рекурсии для получения вложенных страниц. Значение по None умолчанию — (необязательно).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor для страницы. По умолчанию используется ветвь по умолчанию (необязательно).

includeContent

boolean

Значение true, чтобы включить содержимое страницы в ответ для типа контента Json. Значение по умолчанию — false (необязательно)

Возвращаемое значение

Promise<ArrayBuffer>

getWiki(string, string)

Возвращает вики-сайт, соответствующий указанному идентификатору вики-сайта или имени вики-сайта.

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

Параметры

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

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

Идентификатор вики-сайта или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

top

number

Максимальное количество возвращаемых комментариев.

continuationToken

string

Используется для запроса следующей страницы комментариев.

excludeDeleted

boolean

Укажите, следует ли пропускать удаленные комментарии.

expand

CommentExpandOptions

Указывает дополнительные параметры получения данных для комментариев.

order

CommentSortOrder

Порядок возврата комментариев.

parentId

number

CommentId родительского комментария.

Возвращаемое значение

Promise<CommentList>

updateComment(CommentUpdateParameters, string, string, number, number)

Обновление комментария на вики-странице.

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

Параметры

comment

CommentUpdateParameters

Запрос на обновление комментариев.

project

string

Идентификатор или имя проекта

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

pageId

number

Идентификатор вики-страницы.

id

number

Идентификатор комментария.

Возвращаемое значение

Promise<Comment>

updateWiki(WikiUpdateParameters, string, string)

Обновления вики-сайт, соответствующий идентификатору вики-сайта или имени вики-сайта, указанному с помощью параметров обновления.

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

Параметры

updateParameters

WikiUpdateParameters

Обновление параметров.

wikiIdentifier

string

Идентификатор вики-сайта или имя вики-сайта.

project

string

Идентификатор или имя проекта

Возвращаемое значение

Promise<WikiV2>