WikiRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Wiki |
Свойства
| RESOURCE_AREA_ID |
Методы
| add |
Добавьте комментарий на вики-страницу. |
| add |
Добавьте реакцию на вики-страницу комментариев. |
| create |
Отправляет вложение на вики-страницу комментария. |
| create |
Создает ресурс статистики представления страницы или обновляет существующий ресурс статистики представления страниц. |
| create |
Создает вики-ресурс. |
| delete |
Удалите комментарий на вики-странице. |
| delete |
Удаление реакции на вики-страницы комментариев. |
| delete |
Удаляет вики-сайт, соответствующий указанному вики-идентификатору или вики-имени. |
| get |
Получает все вики-сайты в проекте или коллекции. |
| get |
Загружает вложение на вики-страницу комментария. |
| get |
Возвращает комментарий, связанный с вики-страницей. |
| get |
Получает список пользователей, которые отреагировали на данный вики-комментарий с заданным типом реакции. Поддерживает разбиение по страницам с размером страниц по умолчанию 100 пользователей за раз. |
| get |
Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка |
| get |
Возвращает метаданные или содержимое вики-страницы для предоставленного идентификатора страницы. Согласование содержимого выполняется на основе заголовка |
| get |
Возвращает сведения о странице, соответствующие идентификатору страницы. |
| get |
Возвращает список страниц, доступный для страниц вики-страниц |
| get |
Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка |
| get |
Возвращает метаданные или содержимое вики-страницы для предоставленного пути. Согласование содержимого выполняется на основе заголовка |
| get |
Возвращает вики-сайт, соответствующий указанному вики-идентификатору или вики-имени. |
| list |
Возвращает список примечаний, доступных для страниц. |
| update |
Обновите комментарий на вики-странице. |
| update |
Обновляет вики-сайт, соответствующий вики-идентификатору или вики-имени, предоставленному с помощью параметров обновления. |
Сведения о конструкторе
WikiRestClient(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>