GalleryRestClient class

الحزمة:: azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد: RestClientBase

المنشئون

GalleryRestClient(IVssRestClientOptions)

الخصائص

الأساليب

addAssetForEditExtensionDraft(string, string, string, string, string)
addAssetForNewExtensionDraft(string, string, string, string)
associateAzurePublisher(string, string)
createCategory(ExtensionCategory)
createDraftForEditExtension(string, string)
createDraftForNewExtension(any, string, String, String)
createExtension(any, string, string)
createExtensionWithPublisher(any, string, string, string)
createPublisher(Publisher)
createQuestion(Question, string, string)	إنشاء سؤال جديد لملحق.
createResponse(Response, string, string, number)	إنشاء استجابة جديدة لسؤال معين لملحق.
createReview(Review, string, string)	إنشاء مراجعة جديدة لملحق
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	حذف أصل الناشر مثل الشعار
deleteQuestion(string, string, number)	حذف سؤال موجود وجميع الردود المقترنة به لملحق. (حذف مبدئي)
deleteResponse(string, string, number, number)	حذف استجابة لملحق. (حذف مبدئي)
deleteReview(string, string, number)	حذف مراجعة
extensionValidator(AzureRestApiRequestModel)	نقطة نهاية ثابتة للتحقق من صحة ما إذا كان ناشر Azure يمتلك ملحقا لسيناريو التجارة لجهة خارجية. يدعم Azure عمليات POST فقط والتوقيع أعلاه ليس نموذجيا لعمليات REST. http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}& file=Data%20Market%20Partner%20integration%20with%20Marketplace٪20service.docx&action=default
fetchDomainToken(string)
generateKey(string, number)
getAcquisitionOptions(string, string, boolean, boolean)
getAsset(string, string, string, string, boolean, String)
getAssetAuthenticated(string, string, string, string, string, String)
getAssetByName(string, string, string, string, string, boolean, String)
getAssetFromEditExtensionDraft(string, string, string, string)
getAssetFromNewExtensionDraft(string, string, string)
getAssetWithToken(string, string, string, string, string, string, boolean, String)
getCategories(string)
getCategoryDetails(string, string, string)
getCategoryTree(string, string, number, string, string, string, string, string)
getCertificate(string, string, string)
getExtension(string, string, string, ExtensionQueryFlags, string, String)
getExtensionById(string, string, ExtensionQueryFlags)
getExtensionDailyStats(string, string, number, Daily, Date)
getExtensionDailyStatsAnonymous(string, string, string)	يدعم معرف المسار/الموقع هذا HTTP POST بشكل مجهول فقط، بحيث يمكن زيادة الإحصائيات اليومية لعرض الصفحة من عميل Marketplace. يجب أن تؤدي محاولة استدعاء GET على هذا المسار إلى استثناء. دون هذا التنفيذ الصريح، استدعاء GET على هذا المسار العام يستدعي تنفيذ GET أعلاه GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	احصل على أحداث تثبيت/إلغاء تثبيت ملحق. إذا تم تحديد معلمات count و afterDate، فإن العد له الأسبقية.
getExtensionReports(string, string, number, number, Date)	إرجاع تقارير الملحقات
getGalleryUserSettings(string, string)	الحصول على جميع إدخالات الإعداد لنطاق المستخدم/جميع المستخدمين المحدد
getPackage(string, string, string, string, boolean, String)	يتم الوصول إلى نقطة النهاية هذه عند تنزيل ملحق VSTS من واجهة مستخدم الويب
getPublisher(string, number)
getPublisherAsset(string, string)	الحصول على أصل الناشر مثل الشعار كتدفق
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	إرجاع قائمة بالأسئلة مع إجاباتها المقترنة بملحق.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	إرجاع قائمة المراجعات المقترنة بملحق
getReviewsSummary(string, string, Date, Date)	إرجاع ملخص المراجعات
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
getVSCodeExtensionLatestVersion(string, string)	نقطة النهاية للحصول على أحدث إصدار (إصدارات) من ملحق VS Code.
incrementExtensionDailyStat(string, string, string, string, string)	زيادة إحصائية يومية مقترنة بالملحق
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	نقطة نهاية واجهة برمجة التطبيقات لنشر أحداث تثبيت/إلغاء تثبيت الملحق. من المفترض أن يتم استدعاء هذا بواسطة EMS فقط لإرسال البيانات المتعلقة بتثبيت/إلغاء تثبيت ملحق.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	وضع علامة على مصدر قلق بسؤال موجود لملحق.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	إرسال إعلام
setGalleryUserSettings({[key: string]: any}, string)	تعيين كافة إدخالات الإعداد لنطاق المستخدم/جميع المستخدمين المحدد
shareExtension(string, string, string)
shareExtensionById(string, string)
shareExtensionWithHost(string, string, string, string)
unshareExtension(string, string, string)
unshareExtensionById(string, string)
unshareExtensionWithHost(string, string, string, string)
updateExtension(any, string, string, string, string, boolean)	نقطة نهاية REST لتحديث ملحق.
updateExtensionById(string, string)
updateExtensionProperties(string, string, PublishedExtensionFlags)
updateExtensionStatistics(ExtensionStatisticUpdate, string, string)
updatePayloadInDraftForEditExtension(any, string, string, string, String)
updatePayloadInDraftForNewExtension(any, string, string, String)
updatePublisher(Publisher, string)
updatePublisherAsset(any, string, string, String)	تحديث أصل الناشر مثل الشعار. يقبل ملف الأصل كتدفق ثماني ويتم تمرير اسم الملف في قيم الرأس.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	نقطة النهاية لإضافة/تعديل عضوية الناشر. يدعم حاليا إضافة/تعديل مستخدم واحد فقط في كل مرة يعمل فقط لإضافة أعضاء من نفس المستأجر.
updateQuestion(Question, string, string, number)	يحدث سؤالا موجودا لملحق.
updateResponse(Response, string, string, number, number)	تحديث استجابة موجودة لسؤال معين لملحق.
updateReview(ReviewPatch, string, string, number)	التحديثات أو وضع علامة على مراجعة
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

تفاصيل المنشئ

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

تفاصيل الخاصية

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

تفاصيل الأسلوب

addAssetForEditExtensionDraft(string, string, string, string, string)

function addAssetForEditExtensionDraft(content: string, publisherName: string, extensionName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>

المعلمات

content: string

المحتوى المطلوب تحميله

publisherName: string

extensionName: string

draftId: string

assetType: string

المرتجعات

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

function addAssetForNewExtensionDraft(content: string, publisherName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>

المعلمات

content: string

المحتوى المطلوب تحميله

publisherName: string

draftId: string

assetType: string

المرتجعات

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

function associateAzurePublisher(publisherName: string, azurePublisherId: string): Promise<AzurePublisher>

المعلمات

publisherName: string

azurePublisherId: string

المرتجعات

Promise<AzurePublisher>

createCategory(ExtensionCategory)

function createCategory(category: ExtensionCategory): Promise<ExtensionCategory>

المعلمات

category: ExtensionCategory

المرتجعات

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

function createDraftForEditExtension(publisherName: string, extensionName: string): Promise<ExtensionDraft>

المعلمات

publisherName: string

extensionName: string

المرتجعات

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

function createDraftForNewExtension(content: any, publisherName: string, product: String, fileName?: String): Promise<ExtensionDraft>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

product: String

رأس لتمرير نوع المنتج لملف الحمولة

fileName: String

رأس لتمرير اسم ملف البيانات التي تم تحميلها

المرتجعات

Promise<ExtensionDraft>

createExtension(any, string, string)

function createExtension(content: any, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>

المعلمات

content: any

المحتوى المطلوب تحميله

extensionType: string

reCaptchaToken: string

المرتجعات

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

function createExtensionWithPublisher(content: any, publisherName: string, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

extensionType: string

reCaptchaToken: string

المرتجعات

Promise<PublishedExtension>

createPublisher(Publisher)

function createPublisher(publisher: Publisher): Promise<Publisher>

المعلمات

publisher: Publisher

المرتجعات

Promise<Publisher>

createQuestion(Question, string, string)

إنشاء سؤال جديد لملحق.

function createQuestion(question: Question, publisherName: string, extensionName: string): Promise<Question>

المعلمات

question: Question

السؤال الذي سيتم إنشاؤه للملحق.

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

المرتجعات

Promise<Question>

createResponse(Response, string, string, number)

إنشاء استجابة جديدة لسؤال معين لملحق.

function createResponse(response: Response, publisherName: string, extensionName: string, questionId: number): Promise<Response>

المعلمات

response: Response

الاستجابة التي سيتم إنشاؤها للملحق.

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

questionId: number

معرف السؤال الذي سيتم إنشاء الاستجابة له للملحق.

المرتجعات

Promise<Response>

createReview(Review, string, string)

إنشاء مراجعة جديدة لملحق

function createReview(review: Review, pubName: string, extName: string): Promise<Review>

المعلمات

review: Review

مراجعة ليتم إنشاؤها للملحق

pubName: string

اسم الناشر الذي نشر الملحق

extName: string

اسم الملحق

المرتجعات

Promise<Review>

createSupportRequest(CustomerSupportRequest)

function createSupportRequest(customerSupportRequest: CustomerSupportRequest): Promise<void>

المعلمات

customerSupportRequest: CustomerSupportRequest

المرتجعات

Promise<void>

deleteExtension(string, string, string)

function deleteExtension(publisherName: string, extensionName: string, version?: string): Promise<void>

المعلمات

publisherName: string

extensionName: string

version: string

المرتجعات

Promise<void>

deleteExtensionById(string, string)

function deleteExtensionById(extensionId: string, version?: string): Promise<void>

المعلمات

extensionId: string

version: string

المرتجعات

Promise<void>

deletePublisher(string)

function deletePublisher(publisherName: string): Promise<void>

المعلمات

publisherName: string

المرتجعات

Promise<void>

deletePublisherAsset(string, string)

حذف أصل الناشر مثل الشعار

function deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>

المعلمات

publisherName: string

الاسم الداخلي للناشر

assetType: string

نوع الأصل. القيمة الافتراضية هي "الشعار".

المرتجعات

Promise<void>

deleteQuestion(string, string, number)

حذف سؤال موجود وجميع الردود المقترنة به لملحق. (حذف مبدئي)

function deleteQuestion(publisherName: string, extensionName: string, questionId: number): Promise<void>

المعلمات

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

questionId: number

معرف السؤال المراد حذفه للملحق.

المرتجعات

Promise<void>

deleteResponse(string, string, number, number)

حذف استجابة لملحق. (حذف مبدئي)

function deleteResponse(publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<void>

المعلمات

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

questionId: number

يحدد السؤال الذي سيتم حذف رده.

responseId: number

يحدد الاستجابة المراد حذفها.

المرتجعات

Promise<void>

deleteReview(string, string, number)

حذف مراجعة

function deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>

المعلمات

pubName: string

اسم الناشر الذي نشر الملحق

extName: string

اسم الملحق

reviewId: number

معرف المراجعة الذي يحتاج إلى تحديث

المرتجعات

Promise<void>

extensionValidator(AzureRestApiRequestModel)

نقطة نهاية ثابتة للتحقق من صحة ما إذا كان ناشر Azure يمتلك ملحقا لسيناريو التجارة لجهة خارجية. يدعم Azure عمليات POST فقط والتوقيع أعلاه ليس نموذجيا لعمليات REST. http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}& file=Data%20Market%20Partner%20integration%20with%20Marketplace٪20service.docx&action=default

function extensionValidator(azureRestApiRequestModel: AzureRestApiRequestModel): Promise<void>

المعلمات

azureRestApiRequestModel: AzureRestApiRequestModel

يتم إرسال جميع المعلمات في نص الطلب

المرتجعات

Promise<void>

fetchDomainToken(string)

function fetchDomainToken(publisherName: string): Promise<string>

المعلمات

publisherName: string

المرتجعات

Promise<string>

generateKey(string, number)

function generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>

المعلمات

keyType: string

expireCurrentSeconds: number

المرتجعات

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

function getAcquisitionOptions(itemId: string, installationTarget: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean): Promise<AcquisitionOptions>

المعلمات

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

المرتجعات

Promise<AcquisitionOptions>

getAsset(string, string, string, string, boolean, String)

function getAsset(extensionId: string, version: string, assetType: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

المعلمات

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ArrayBuffer>

getAssetAuthenticated(string, string, string, string, string, String)

function getAssetAuthenticated(publisherName: string, extensionName: string, version: string, assetType: string, accountToken?: string, accountTokenHeader?: String): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ArrayBuffer>

getAssetByName(string, string, string, string, string, boolean, String)

function getAssetByName(publisherName: string, extensionName: string, version: string, assetType: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

function getAssetFromEditExtensionDraft(publisherName: string, draftId: string, assetType: string, extensionName: string): Promise<ArrayBuffer>

المعلمات

publisherName: string

draftId: string

assetType: string

extensionName: string

المرتجعات

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

function getAssetFromNewExtensionDraft(publisherName: string, draftId: string, assetType: string): Promise<ArrayBuffer>

المعلمات

publisherName: string

draftId: string

assetType: string

المرتجعات

Promise<ArrayBuffer>

getAssetWithToken(string, string, string, string, string, string, boolean, String)

function getAssetWithToken(publisherName: string, extensionName: string, version: string, assetType: string, assetToken?: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ArrayBuffer>

getCategories(string)

function getCategories(languages?: string): Promise<string[]>

المعلمات

languages: string

المرتجعات

Promise<string[]>

getCategoryDetails(string, string, string)

function getCategoryDetails(categoryName: string, languages?: string, product?: string): Promise<CategoriesResult>

المعلمات

categoryName: string

languages: string

product: string

المرتجعات

Promise<CategoriesResult>

getCategoryTree(string, string, number, string, string, string, string, string)

function getCategoryTree(product: string, categoryId: string, lcid?: number, source?: string, productVersion?: string, skus?: string, subSkus?: string, productArchitecture?: string): Promise<ProductCategory>

المعلمات

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

المرتجعات

Promise<ProductCategory>

getCertificate(string, string, string)

function getCertificate(publisherName: string, extensionName: string, version?: string): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

المرتجعات

Promise<ArrayBuffer>

getExtension(string, string, string, ExtensionQueryFlags, string, String)

function getExtension(publisherName: string, extensionName: string, version?: string, flags?: ExtensionQueryFlags, accountToken?: string, accountTokenHeader?: String): Promise<PublishedExtension>

المعلمات

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

function getExtensionById(extensionId: string, version?: string, flags?: ExtensionQueryFlags): Promise<PublishedExtension>

المعلمات

extensionId: string

version: string

flags: ExtensionQueryFlags

المرتجعات

Promise<PublishedExtension>

getExtensionDailyStats(string, string, number, Daily, Date)

function getExtensionDailyStats(publisherName: string, extensionName: string, days?: number, aggregate?: Daily, afterDate?: Date): Promise<ExtensionDailyStats>

المعلمات

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

المرتجعات

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

يدعم معرف المسار/الموقع هذا HTTP POST بشكل مجهول فقط، بحيث يمكن زيادة الإحصائيات اليومية لعرض الصفحة من عميل Marketplace. يجب أن تؤدي محاولة استدعاء GET على هذا المسار إلى استثناء. دون هذا التنفيذ الصريح، استدعاء GET على هذا المسار العام يستدعي تنفيذ GET أعلاه GetExtensionDailyStats.

function getExtensionDailyStatsAnonymous(publisherName: string, extensionName: string, version: string): Promise<ExtensionDailyStats>

المعلمات

publisherName: string

اسم الناشر

extensionName: string

اسم الملحق

version: string

إصدار الملحق

المرتجعات

Promise<ExtensionDailyStats>

getExtensionEvents(string, string, number, Date, string, string)

احصل على أحداث تثبيت/إلغاء تثبيت ملحق. إذا تم تحديد معلمات count و afterDate، فإن العد له الأسبقية.

function getExtensionEvents(publisherName: string, extensionName: string, count?: number, afterDate?: Date, include?: string, includeProperty?: string): Promise<ExtensionEvents>

المعلمات

publisherName: string

اسم الناشر

extensionName: string

اسم الملحق

count: number

عدد الأحداث التي يجب إحضارها، ينطبق على كل نوع حدث.

afterDate: Date

إحضار الأحداث التي حدثت في هذا التاريخ أو بعده

include: string

خيارات التصفية. القيم المدعومة: التثبيت، وإلغاء التثبيت، والمراجعة، والاستحواذ، والمبيعات. الافتراضي هو جلب جميع أنواع الأحداث

includeProperty: string

خصائص الحدث المراد تضمينها. حاليا يتم دعم "lastContactDetails" فقط لإلغاء تثبيت الأحداث

المرتجعات

Promise<ExtensionEvents>

getExtensionReports(string, string, number, number, Date)

إرجاع تقارير الملحقات

function getExtensionReports(publisherName: string, extensionName: string, days?: number, count?: number, afterDate?: Date): Promise<any>

المعلمات

publisherName: string

اسم الناشر الذي نشر الملحق

extensionName: string

اسم الملحق

days: number

آخر n أيام التقرير. إذا تم تحديد afterDate والأيام، فستأخذ الأيام الأولوية

count: number

عدد الأحداث التي سيتم إرجاعها

afterDate: Date

استخدم إذا كنت تريد إحضار أحداث أحدث من التاريخ المحدد

المرتجعات

Promise<any>

getGalleryUserSettings(string, string)

الحصول على جميع إدخالات الإعداد لنطاق المستخدم/جميع المستخدمين المحدد

function getGalleryUserSettings(userScope: string, key?: string): Promise<{[key: string]: any}>

المعلمات

userScope: string

User-Scope للحصول على القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "المضيف" لجميع المستخدمين.

key: string

المفتاح الاختياري الذي يتم بموجبه تصفية جميع الإدخالات

المرتجعات

Promise<{[key: string]: any}>

getPackage(string, string, string, string, boolean, String)

يتم الوصول إلى نقطة النهاية هذه عند تنزيل ملحق VSTS من واجهة مستخدم الويب

function getPackage(publisherName: string, extensionName: string, version: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ArrayBuffer>

getPublisher(string, number)

function getPublisher(publisherName: string, flags?: number): Promise<Publisher>

المعلمات

publisherName: string

flags: number

المرتجعات

Promise<Publisher>

getPublisherAsset(string, string)

الحصول على أصل الناشر مثل الشعار كتدفق

function getPublisherAsset(publisherName: string, assetType?: string): Promise<ArrayBuffer>

المعلمات

publisherName: string

الاسم الداخلي للناشر

assetType: string

نوع الأصل. القيمة الافتراضية هي "الشعار".

المرتجعات

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

function getPublisherWithoutToken(publisherName: string): Promise<Publisher>

المعلمات

publisherName: string

المرتجعات

Promise<Publisher>

getQuestions(string, string, number, number, Date)

إرجاع قائمة بالأسئلة مع إجاباتها المقترنة بملحق.

function getQuestions(publisherName: string, extensionName: string, count?: number, page?: number, afterDate?: Date): Promise<QuestionsResult>

المعلمات

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

count: number

عدد الأسئلة المراد استردادها (الافتراضيات إلى 10).

page: number

رقم الصفحة التي سيتم استرداد مجموعة الأسئلة منها.

afterDate: Date

إذا تم توفيرها، يتم إرجاع أسئلة النتائج التي تم نشرها بعد هذا التاريخ

المرتجعات

Promise<QuestionsResult>

getReviews(string, string, number, ReviewFilterOptions, Date, Date)

إرجاع قائمة المراجعات المقترنة بملحق

function getReviews(publisherName: string, extensionName: string, count?: number, filterOptions?: ReviewFilterOptions, beforeDate?: Date, afterDate?: Date): Promise<ReviewsResult>

المعلمات

publisherName: string

اسم الناشر الذي نشر الملحق

extensionName: string

اسم الملحق

count: number

عدد المراجعات المراد استردادها (الافتراضيات إلى 5)

filterOptions: ReviewFilterOptions

FilterOptions لتصفية المراجعات الفارغة وما إلى ذلك، الإعدادات الافتراضية إلى لا شيء

beforeDate: Date

استخدم إذا كنت تريد إحضار مراجعات أقدم من التاريخ المحدد، يتم تعيينها افتراضيا إلى قيمة خالية

afterDate: Date

استخدم إذا كنت تريد إحضار مراجعات أحدث من التاريخ المحدد، تعيين القيمة الافتراضية إلى قيمة خالية

المرتجعات

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

إرجاع ملخص المراجعات

function getReviewsSummary(pubName: string, extName: string, beforeDate?: Date, afterDate?: Date): Promise<ReviewSummary>

المعلمات

pubName: string

اسم الناشر الذي نشر الملحق

extName: string

اسم الملحق

beforeDate: Date

استخدم إذا كنت تريد إحضار ملخص المراجعات الأقدم من التاريخ المحدد، يتم تعيين القيمة الافتراضية إلى قيمة خالية

afterDate: Date

استخدم إذا كنت تريد إحضار ملخص المراجعات الأحدث من التاريخ المحدد، تعيين القيمة الافتراضية إلى قيمة خالية

المرتجعات

Promise<ReviewSummary>

getRootCategories(string, number, string, string, string, string)

function getRootCategories(product: string, lcid?: number, source?: string, productVersion?: string, skus?: string, subSkus?: string): Promise<ProductCategoriesResult>

المعلمات

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

المرتجعات

Promise<ProductCategoriesResult>

getSigningKey(string)

function getSigningKey(keyType: string): Promise<string>

المعلمات

keyType: string

المرتجعات

Promise<string>

getVerificationLog(string, string, string, string)

function getVerificationLog(publisherName: string, extensionName: string, version: string, targetPlatform?: string): Promise<ArrayBuffer>

المعلمات

publisherName: string

extensionName: string

version: string

targetPlatform: string

المرتجعات

Promise<ArrayBuffer>

getVSCodeExtensionLatestVersion(string, string)

نقطة النهاية للحصول على أحدث إصدار (إصدارات) من ملحق VS Code.

function getVSCodeExtensionLatestVersion(publisherName: string, extensionName: string): Promise<PublishedExtension>

المعلمات

publisherName: string

اسم ناشر ملحق VS Code المطلوب.

extensionName: string

اسم الملحق.

المرتجعات

Promise<PublishedExtension>

incrementExtensionDailyStat(string, string, string, string, string)

زيادة إحصائية يومية مقترنة بالملحق

function incrementExtensionDailyStat(publisherName: string, extensionName: string, version: string, statType: string, targetPlatform?: string): Promise<void>

المعلمات

publisherName: string

اسم الناشر

extensionName: string

اسم الملحق

version: string

إصدار الملحق

statType: string

نوع الإحصائيات المراد زيادتها

targetPlatform: string

المرتجعات

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

function performEditExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, extensionName: string, draftId: string): Promise<ExtensionDraft>

المعلمات

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

المرتجعات

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

function performNewExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, draftId: string): Promise<ExtensionDraft>

المعلمات

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

المرتجعات

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

نقطة نهاية واجهة برمجة التطبيقات لنشر أحداث تثبيت/إلغاء تثبيت الملحق. من المفترض أن يتم استدعاء هذا بواسطة EMS فقط لإرسال البيانات المتعلقة بتثبيت/إلغاء تثبيت ملحق.

function publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>

المعلمات

extensionEvents: ExtensionEvents[]

المرتجعات

Promise<void>

publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)

function publishExtensionWithPublisherSignature(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

المرتجعات

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

function queryAssociatedAzurePublisher(publisherName: string): Promise<AzurePublisher>

المعلمات

publisherName: string

المرتجعات

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

function queryExtensions(extensionQuery: ExtensionQuery, accountToken?: string, accountTokenHeader?: String): Promise<ExtensionQueryResult>

المعلمات

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

رأس لتمرير الرمز المميز للحساب

المرتجعات

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

function queryPublishers(publisherQuery: PublisherQuery): Promise<PublisherQueryResult>

المعلمات

publisherQuery: PublisherQuery

المرتجعات

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

وضع علامة على مصدر قلق بسؤال موجود لملحق.

function reportQuestion(concern: Concern, pubName: string, extName: string, questionId: number): Promise<Concern>

المعلمات

concern: Concern

أبلغ المستخدم عن قلقه بشأن سؤال للملحق.

pubName: string

اسم الناشر الذي نشر الملحق.

extName: string

اسم الملحق.

questionId: number

معرف السؤال الذي سيتم تحديثه للملحق.

المرتجعات

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>

المعلمات

acquisitionRequest: ExtensionAcquisitionRequest

المرتجعات

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

إرسال إعلام

function sendNotifications(notificationData: NotificationsData): Promise<void>

المعلمات

notificationData: NotificationsData

يشير إلى البيانات اللازمة لإرسال الإعلام

المرتجعات

Promise<void>

setGalleryUserSettings({[key: string]: any}, string)

تعيين كافة إدخالات الإعداد لنطاق المستخدم/جميع المستخدمين المحدد

function setGalleryUserSettings(entries: {[key: string]: any}, userScope: string): Promise<void>

المعلمات

entries: {[key: string]: any}

زوج قيم المفاتيح لجميع الإعدادات التي يجب تعيينها

userScope: string

User-Scope للحصول على القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "المضيف" لجميع المستخدمين.

المرتجعات

Promise<void>

shareExtension(string, string, string)

function shareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>

المعلمات

publisherName: string

extensionName: string

accountName: string

المرتجعات

Promise<void>

shareExtensionById(string, string)

function shareExtensionById(extensionId: string, accountName: string): Promise<void>

المعلمات

extensionId: string

accountName: string

المرتجعات

Promise<void>

shareExtensionWithHost(string, string, string, string)

function shareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>

المعلمات

publisherName: string

extensionName: string

hostType: string

hostName: string

المرتجعات

Promise<void>

unshareExtension(string, string, string)

function unshareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>

المعلمات

publisherName: string

extensionName: string

accountName: string

المرتجعات

Promise<void>

unshareExtensionById(string, string)

function unshareExtensionById(extensionId: string, accountName: string): Promise<void>

المعلمات

extensionId: string

accountName: string

المرتجعات

Promise<void>

unshareExtensionWithHost(string, string, string, string)

function unshareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>

المعلمات

publisherName: string

extensionName: string

hostType: string

hostName: string

المرتجعات

Promise<void>

updateExtension(any, string, string, string, string, boolean)

نقطة نهاية REST لتحديث ملحق.

function updateExtension(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

اسم الناشر

extensionName: string

اسم الملحق

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

تحدد هذه المعلمة ما إذا كان يجب استدعاء التحقق من تغيير النطاق أم لا

المرتجعات

Promise<PublishedExtension>

updateExtensionById(string, string)

function updateExtensionById(extensionId: string, reCaptchaToken?: string): Promise<PublishedExtension>

المعلمات

extensionId: string

reCaptchaToken: string

المرتجعات

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

function updateExtensionProperties(publisherName: string, extensionName: string, flags: PublishedExtensionFlags): Promise<PublishedExtension>

المعلمات

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

المرتجعات

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

function updateExtensionStatistics(extensionStatisticsUpdate: ExtensionStatisticUpdate, publisherName: string, extensionName: string): Promise<void>

المعلمات

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

المرتجعات

Promise<void>

updatePayloadInDraftForEditExtension(any, string, string, string, String)

function updatePayloadInDraftForEditExtension(content: any, publisherName: string, extensionName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

extensionName: string

draftId: string

fileName: String

رأس لتمرير اسم ملف البيانات التي تم تحميلها

المرتجعات

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

function updatePayloadInDraftForNewExtension(content: any, publisherName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

draftId: string

fileName: String

رأس لتمرير اسم ملف البيانات التي تم تحميلها

المرتجعات

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

function updatePublisher(publisher: Publisher, publisherName: string): Promise<Publisher>

المعلمات

publisher: Publisher

publisherName: string

المرتجعات

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

تحديث أصل الناشر مثل الشعار. يقبل ملف الأصل كتدفق ثماني ويتم تمرير اسم الملف في قيم الرأس.

function updatePublisherAsset(content: any, publisherName: string, assetType?: string, fileName?: String): Promise<{[key: string]: string}>

المعلمات

content: any

المحتوى المطلوب تحميله

publisherName: string

الاسم الداخلي للناشر

assetType: string

نوع الأصل. القيمة الافتراضية هي "الشعار".

fileName: String

رأس لتمرير اسم ملف البيانات التي تم تحميلها

المرتجعات

Promise<{[key: string]: string}>

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

نقطة النهاية لإضافة/تعديل عضوية الناشر. يدعم حاليا إضافة/تعديل مستخدم واحد فقط في كل مرة يعمل فقط لإضافة أعضاء من نفس المستأجر.

function updatePublisherMembers(roleAssignments: PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<PublisherRoleAssignment[]>

المعلمات

roleAssignments: PublisherUserRoleAssignmentRef[]

قائمة معرفات المستخدم (عنوان البريد الإلكتروني) والدور الذي ستتم إضافته. يتم حاليا دعم إدخال واحد فقط.

publisherName: string

اسم/معرف الناشر الذي يجب إضافة المستخدمين إليه

limitToCallerIdentityDomain: boolean

يجب السماح بالوظائف الإضافية عبر المستأجرين أم لا.

المرتجعات

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

يحدث سؤالا موجودا لملحق.

function updateQuestion(question: Question, publisherName: string, extensionName: string, questionId: number): Promise<Question>

المعلمات

question: Question

السؤال المحدث الذي سيتم تعيينه للملحق.

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

questionId: number

معرف السؤال الذي سيتم تحديثه للملحق.

المرتجعات

Promise<Question>

updateResponse(Response, string, string, number, number)

تحديث استجابة موجودة لسؤال معين لملحق.

function updateResponse(response: Response, publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<Response>

المعلمات

response: Response

استجابة محدثة ليتم تعيينها للملحق.

publisherName: string

اسم الناشر الذي نشر الملحق.

extensionName: string

اسم الملحق.

questionId: number

معرف السؤال الذي سيتم تحديث الاستجابة له للملحق.

responseId: number

معرف الاستجابة التي يجب تحديثها.

المرتجعات

Promise<Response>

updateReview(ReviewPatch, string, string, number)

التحديثات أو وضع علامة على مراجعة

function updateReview(reviewPatch: ReviewPatch, pubName: string, extName: string, reviewId: number): Promise<ReviewPatch>

المعلمات

reviewPatch: ReviewPatch

كائن ReviewPatch الذي يحتوي على التغييرات التي سيتم تطبيقها على المراجعة

pubName: string

اسم الناشر الذي نشر الملحق

extName: string

اسم الملحق

reviewId: number

معرف المراجعة الذي يحتاج إلى تحديث

المرتجعات

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

function updateVSCodeWebExtensionStatistics(itemName: string, version: string, statType: VSCodeWebExtensionStatisicsType): Promise<void>

المعلمات

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

المرتجعات

Promise<void>

verifyDomainToken(string)

function verifyDomainToken(publisherName: string): Promise<void>

المعلمات

publisherName: string

المرتجعات

Promise<void>

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

GalleryRestClient class

المنشئون

الخصائص

الأساليب

تفاصيل المنشئ

GalleryRestClient(IVssRestClientOptions)

المعلمات

تفاصيل الخاصية

RESOURCE_AREA_ID

قيمة الخاصية

تفاصيل الأسلوب

addAssetForEditExtensionDraft(string, string, string, string, string)

المعلمات

المرتجعات

addAssetForNewExtensionDraft(string, string, string, string)

المعلمات

المرتجعات

associateAzurePublisher(string, string)

المعلمات

المرتجعات

createCategory(ExtensionCategory)

المعلمات

المرتجعات

createDraftForEditExtension(string, string)

المعلمات

المرتجعات

createDraftForNewExtension(any, string, String, String)

المعلمات

المرتجعات

createExtension(any, string, string)

المعلمات

المرتجعات

createExtensionWithPublisher(any, string, string, string)

المعلمات

المرتجعات

createPublisher(Publisher)

المعلمات

المرتجعات

createQuestion(Question, string, string)

المعلمات

المرتجعات

createResponse(Response, string, string, number)

المعلمات

المرتجعات

createReview(Review, string, string)

المعلمات

المرتجعات

createSupportRequest(CustomerSupportRequest)

المعلمات

المرتجعات

deleteExtension(string, string, string)

المعلمات

المرتجعات

deleteExtensionById(string, string)

المعلمات

المرتجعات

deletePublisher(string)

المعلمات

المرتجعات

deletePublisherAsset(string, string)

المعلمات

المرتجعات

deleteQuestion(string, string, number)

المعلمات

المرتجعات

deleteResponse(string, string, number, number)

المعلمات

المرتجعات

deleteReview(string, string, number)

المعلمات

المرتجعات

extensionValidator(AzureRestApiRequestModel)

المعلمات

المرتجعات

fetchDomainToken(string)

المعلمات

المرتجعات

generateKey(string, number)

المعلمات