WikiRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

WikiRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

addComment(CommentCreateParameters, string, string, number)	Tambahkan komentar di halaman wiki.
addCommentReaction(string, string, number, number, CommentReactionType)	Tambahkan reaksi pada komentar halaman wiki.
createCommentAttachment(any, string, string, number)	Mengunggah lampiran pada komentar di halaman wiki.
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)	Membuat sumber daya statistik tampilan halaman baru atau memperbarui sumber daya statistik tampilan halaman yang sudah ada.
createWiki(WikiCreateParametersV2, string)	Membuat sumber daya wiki.
deleteComment(string, string, number, number)	Menghapus komentar di halaman wiki.
deleteCommentReaction(string, string, number, number, CommentReactionType)	Hapus reaksi pada komentar halaman wiki.
deleteWiki(string, string)	Menghapus wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan.
getAllWikis(string)	Mendapatkan semua wiki dalam proyek atau koleksi.
getAttachmentContent(string, string, number, string)	Mengunduh lampiran pada komentar di halaman wiki.
getComment(string, string, number, number, boolean, CommentExpandOptions)	Mengembalikan komentar yang terkait dengan Halaman Wiki.
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)	Mendapatkan daftar pengguna yang telah bereaksi untuk komentar wiki yang diberikan dengan jenis reaksi tertentu. Mendukung halaman, dengan ukuran halaman default 100 pengguna pada satu waktu.
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)	Mendapatkan metadata atau konten halaman wiki untuk id halaman yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)	Mendapatkan metadata atau konten halaman wiki untuk id halaman yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.
getPageData(string, string, number, number)	Mengembalikan detail halaman yang terkait dengan ID Halaman.
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)	Mengembalikan daftar halaman Halaman Wiki
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Mendapatkan metadata atau konten halaman wiki untuk jalur yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Mendapatkan metadata atau konten halaman wiki untuk jalur yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.
getWiki(string, string)	Mendapatkan wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan.
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)	Mengembalikan daftar komentar yang dapat di-pageable.
updateComment(CommentUpdateParameters, string, string, number, number)	Perbarui komentar di halaman wiki.
updateWiki(WikiUpdateParameters, string, string)	Memperbarui wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan menggunakan parameter pembaruan.

Detail Konstruktor

WikiRestClient(IVssRestClientOptions)

new WikiRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addComment(CommentCreateParameters, string, string, number)

Tambahkan komentar di halaman wiki.

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

Parameter

request

CommentCreateParameters

Permintaan buat komentar.

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

Mengembalikan

Promise<Comment>

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

Tambahkan reaksi pada komentar halaman wiki.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki

pageId

number

ID halaman Wiki

commentId

number

ID komentar terkait

type

CommentReactionType

Jenis reaksi yang ditambahkan

Mengembalikan

Promise<CommentReaction>

createCommentAttachment(any, string, string, number)

Mengunggah lampiran pada komentar di halaman wiki.

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

Parameter

content

any

Konten yang akan diunggah

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

Mengembalikan

Promise<CommentAttachment>

createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)

Membuat sumber daya statistik tampilan halaman baru atau memperbarui sumber daya statistik tampilan halaman yang sudah ada.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

wikiVersion

GitVersionDescriptor

Versi Wiki.

path

string

Jalur halaman Wiki.

oldPath

string

Jalur halaman lama. Ini bersifat opsional dan diperlukan untuk mengganti nama jalur dalam statistik tampilan halaman yang ada.

Mengembalikan

Promise<WikiPageViewStats>

createWiki(WikiCreateParametersV2, string)

Membuat sumber daya wiki.

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

Parameter

wikiCreateParams

WikiCreateParametersV2

Parameter untuk pembuatan wiki.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WikiV2>

deleteComment(string, string, number, number)

Menghapus komentar di halaman wiki.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID atau nama Wiki.

pageId

number

ID halaman Wiki.

id

number

ID Komentar.

Mengembalikan

Promise<void>

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

Hapus reaksi pada komentar halaman wiki.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID atau nama Wiki

pageId

number

ID halaman Wiki

commentId

number

ID komentar terkait

type

CommentReactionType

Jenis reaksi yang dihapus

Mengembalikan

Promise<CommentReaction>

deleteWiki(string, string)

Menghapus wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan.

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

Parameter

wikiIdentifier

string

ID Wiki atau nama wiki.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WikiV2>

getAllWikis(string)

Mendapatkan semua wiki dalam proyek atau koleksi.

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WikiV2[]>

getAttachmentContent(string, string, number, string)

Mengunduh lampiran pada komentar di halaman wiki.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

attachmentId

string

ID Lampiran.

Mengembalikan

Promise<ArrayBuffer>

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

Mengembalikan komentar yang terkait dengan Halaman Wiki.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

id

number

ID komentar yang akan dikembalikan.

excludeDeleted

boolean

Tentukan apakah komentar yang dihapus harus dilewati.

expand

CommentExpandOptions

Menentukan opsi pengambilan data tambahan untuk komentar.

Mengembalikan

Promise<Comment>

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

Mendapatkan daftar pengguna yang telah bereaksi untuk komentar wiki yang diberikan dengan jenis reaksi tertentu. Mendukung halaman, dengan ukuran halaman default 100 pengguna pada satu waktu.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

commentId

number

ID komentar terkait

type

CommentReactionType

Jenis reaksi yang diminta oleh pengguna yang terlibat

top

number

Jumlah pengguna yang disandikan yang akan dikembalikan di halaman tertentu. Opsional, default ke 100

skip

number

Jumlah pengguna yang terlibat yang akan dilewati ke halaman kumpulan pengguna yang terlibat berikutnya, default ke 0

Mengembalikan

Promise<IdentityRef[]>

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

Mendapatkan metadata atau konten halaman wiki untuk id halaman yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki..

id

number

ID halaman Wiki.

recursionLevel

VersionControlRecursionType

Tingkat rekursi untuk pengambilan sub-halaman. Default ke None (Opsional).

includeContent

boolean

True untuk menyertakan konten halaman dalam respons untuk jenis konten Json. Default ke false (Opsional)

Mengembalikan

Promise<string>

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

Mendapatkan metadata atau konten halaman wiki untuk id halaman yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki..

id

number

ID halaman Wiki.

recursionLevel

VersionControlRecursionType

Tingkat rekursi untuk pengambilan sub-halaman. Default ke None (Opsional).

includeContent

boolean

True untuk menyertakan konten halaman dalam respons untuk jenis konten Json. Default ke false (Opsional)

Mengembalikan

Promise<ArrayBuffer>

getPageData(string, string, number, number)

Mengembalikan detail halaman yang terkait dengan ID Halaman.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

pageViewsForDays

number

N hari terakhir dari hari saat ini di mana tampilan halaman akan dikembalikan. Ini termasuk hari saat ini.

Mengembalikan

Promise<WikiPageDetail>

getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)

Mengembalikan daftar halaman Halaman Wiki

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

Parameter

pagesBatchRequest

WikiPagesBatchRequest

Permintaan halaman batch Wiki.

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor untuk halaman tersebut. (Opsional dalam kasus ProjectWiki).

Mengembalikan

Promise<PagedList<WikiPageDetail>>

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

Mendapatkan metadata atau konten halaman wiki untuk jalur yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

path

string

Jalur halaman Wiki.

recursionLevel

VersionControlRecursionType

Tingkat rekursi untuk pengambilan sub-halaman. Default ke None (Opsional).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor untuk halaman tersebut. Default ke cabang default (Opsional).

includeContent

boolean

True untuk menyertakan konten halaman dalam respons untuk jenis konten Json. Default ke false (Opsional)

Mengembalikan

Promise<string>

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

Mendapatkan metadata atau konten halaman wiki untuk jalur yang disediakan. Negosiasi konten dilakukan berdasarkan header yang Accept dikirim dalam permintaan.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

path

string

Jalur halaman Wiki.

recursionLevel

VersionControlRecursionType

Tingkat rekursi untuk pengambilan sub-halaman. Default ke None (Opsional).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor untuk halaman tersebut. Default ke cabang default (Opsional).

includeContent

boolean

True untuk menyertakan konten halaman dalam respons untuk jenis konten Json. Default ke false (Opsional)

Mengembalikan

Promise<ArrayBuffer>

getWiki(string, string)

Mendapatkan wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan.

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

Parameter

wikiIdentifier

string

ID Wiki atau nama wiki.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WikiV2>

listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)

Mengembalikan daftar komentar yang dapat di-pageable.

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

Parameter

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

top

number

Jumlah maksimum komentar yang akan dikembalikan.

continuationToken

string

Digunakan untuk mengkueri halaman komentar berikutnya.

excludeDeleted

boolean

Tentukan apakah komentar yang dihapus harus dilewati.

expand

CommentExpandOptions

Menentukan opsi pengambilan data tambahan untuk komentar.

order

CommentSortOrder

Urutan di mana komentar harus dikembalikan.

parentId

number

CommentId komentar induk.

Mengembalikan

Promise<CommentList>

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

Perbarui komentar di halaman wiki.

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

Parameter

comment

CommentUpdateParameters

Permintaan pembaruan komentar.

project

string

ID proyek atau nama proyek

wikiIdentifier

string

ID Wiki atau nama wiki.

pageId

number

ID halaman Wiki.

id

number

ID Komentar.

Mengembalikan

Promise<Comment>

updateWiki(WikiUpdateParameters, string, string)

Memperbarui wiki yang sesuai dengan ID wiki atau nama wiki yang disediakan menggunakan parameter pembaruan.

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

Parameter

updateParameters

WikiUpdateParameters

Perbarui parameter.

wikiIdentifier

string

ID Wiki atau nama wiki.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WikiV2>