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>