WikiRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الخصائص
| 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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
المرتجعات
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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki
- pageId
-
number
معرف صفحة Wiki
- commentId
-
number
معرف التعليق المقترن
- 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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
المرتجعات
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
معرف Wiki أو اسم 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
معرف المشروع أو اسم المشروع
المرتجعات
Promise<WikiV2>
deleteComment(string, string, number, number)
حذف تعليق على صفحة wiki.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو الاسم.
- pageId
-
number
معرف صفحة Wiki.
- id
-
number
معرف التعليق.
المرتجعات
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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو الاسم
- pageId
-
number
معرف صفحة Wiki
- commentId
-
number
معرف التعليق المقترن
- type
- CommentReactionType
نوع التفاعل الذي يتم حذفه
المرتجعات
Promise<CommentReaction>
deleteWiki(string, string)
حذف wiki المطابق لمعرف wiki أو اسم wiki المتوفر.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>المعلمات
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<WikiV2>
getAllWikis(string)
الحصول على كافة مواقع wiki في مشروع أو مجموعة.
function getAllWikis(project?: string): Promise<WikiV2[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
تنزيل مرفق على تعليق على صفحة wiki.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- attachmentId
-
string
معرف المرفق.
المرتجعات
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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- id
-
number
معرف التعليق المراد إرجاعه.
- 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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- commentId
-
number
معرف التعليق المقترن
- type
- CommentReactionType
نوع رد الفعل الذي يتم طلب المستخدمين المشاركين من أجله
- top
-
number
عدد المستخدمين المغلفين الذين سيتم إرجاعهم في صفحة معينة. اختياري، افتراضي إلى 100
- skip
-
number
عدد المستخدمين المشاركين الذين سيتم تخطيهم لصفحة المجموعة التالية من المستخدمين المتفاعلين، الافتراضيات إلى 0
المرتجعات
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
يحصل على بيانات التعريف أو محتوى صفحة wiki لمعرف الصفحة المتوفر. يتم التفاوض على المحتوى استنادا إلى عنوان Accept المرسل في الطلب.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- id
-
number
معرف صفحة Wiki.
- recursionLevel
- VersionControlRecursionType
مستوى الإعادة لاسترداد الصفحات الفرعية. الإعدادات الافتراضية None (اختياري).
- includeContent
-
boolean
صحيح لتضمين محتوى الصفحة في الاستجابة لنوع محتوى Json. الإعدادات الافتراضية للخطأ (اختياري)
المرتجعات
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
يحصل على بيانات التعريف أو محتوى صفحة wiki لمعرف الصفحة المتوفر. يتم التفاوض على المحتوى استنادا إلى عنوان Accept المرسل في الطلب.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- id
-
number
معرف صفحة Wiki.
- recursionLevel
- VersionControlRecursionType
مستوى الإعادة لاسترداد الصفحات الفرعية. الإعدادات الافتراضية None (اختياري).
- includeContent
-
boolean
صحيح لتضمين محتوى الصفحة في الاستجابة لنوع محتوى Json. الإعدادات الافتراضية للخطأ (اختياري)
المرتجعات
Promise<ArrayBuffer>
getPageData(string, string, number, number)
إرجاع تفاصيل الصفحة المطابقة لمعرف الصفحة.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- 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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم 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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- path
-
string
مسار صفحة Wiki.
- recursionLevel
- VersionControlRecursionType
مستوى الإعادة لاسترداد الصفحات الفرعية. الإعدادات الافتراضية None (اختياري).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor للصفحة. الإعدادات الافتراضية للفرع الافتراضي (اختياري).
- includeContent
-
boolean
صحيح لتضمين محتوى الصفحة في الاستجابة لنوع محتوى Json. الإعدادات الافتراضية للخطأ (اختياري)
المرتجعات
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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- path
-
string
مسار صفحة Wiki.
- recursionLevel
- VersionControlRecursionType
مستوى الإعادة لاسترداد الصفحات الفرعية. الإعدادات الافتراضية None (اختياري).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor للصفحة. الإعدادات الافتراضية للفرع الافتراضي (اختياري).
- includeContent
-
boolean
صحيح لتضمين محتوى الصفحة في الاستجابة لنوع محتوى Json. الإعدادات الافتراضية للخطأ (اختياري)
المرتجعات
Promise<ArrayBuffer>
getWiki(string, string)
الحصول على wiki المطابق لمعرف wiki أو اسم wiki المقدم.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>المعلمات
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- 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
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- top
-
number
الحد الأقصى لعدد التعليقات التي يجب إرجاعها.
- continuationToken
-
string
يستخدم للاستعلام عن الصفحة التالية من التعليقات.
- excludeDeleted
-
boolean
حدد ما إذا كان يجب تخطي التعليقات المحذوفة.
- expand
- CommentExpandOptions
تحديد خيارات استرداد البيانات الإضافية للتعليقات.
- order
- CommentSortOrder
الترتيب الذي يجب إرجاع التعليقات به.
- parentId
-
number
معرف التعليق الأصل.
المرتجعات
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
معرف المشروع أو اسم المشروع
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- pageId
-
number
معرف صفحة Wiki.
- id
-
number
معرف التعليق.
المرتجعات
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
يحدث wiki المطابق لمعرف wiki أو اسم wiki المتوفر باستخدام معلمات التحديث.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>المعلمات
- updateParameters
- WikiUpdateParameters
تحديث المعلمات.
- wikiIdentifier
-
string
معرف Wiki أو اسم wiki.
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<WikiV2>