Bagikan melalui


GalleryRestClient class

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

Memperluas

Konstruktor

GalleryRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

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)

Membuat pertanyaan baru untuk ekstensi.

createResponse(Response, string, string, number)

Membuat respons baru untuk pertanyaan tertentu untuk ekstensi.

createReview(Review, string, string)

Membuat tinjauan baru untuk ekstensi

createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)

Menghapus aset penerbit seperti logo

deleteQuestion(string, string, number)

Menghapus pertanyaan yang ada dan semua respons terkait untuk ekstensi. (penghapusan sementara)

deleteResponse(string, string, number, number)

Menghapus respons untuk ekstensi. (penghapusan sementara)

deleteReview(string, string, number)

Menghapus tinjauan

extensionValidator(AzureRestApiRequestModel)

Titik akhir rest untuk memvalidasi apakah penerbit Azure memiliki ekstensi untuk skenario perdagangan pihak ke-3. Azure hanya mendukung operasi POST dan tanda tangan di atas tidak khas dari operasi 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)

Id rute/lokasi ini hanya mendukung HTTP POST secara anonim, sehingga statistik harian tampilan halaman dapat ditambahkan dari klien Marketplace. Mencoba memanggil GET pada rute ini akan menghasilkan pengecualian. Tanpa implementasi eksplisit ini, memanggil GET pada rute publik ini memanggil implementasi GET di atas GetExtensionDailyStats.

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

Dapatkan peristiwa instal/hapus instalan ekstensi. Jika parameter count dan afterDate ditentukan, hitungan lebih diutamakan.

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

Mengembalikan laporan ekstensi

getGalleryUserSettings(string, string)

Mendapatkan semua entri pengaturan untuk cakupan pengguna/semua pengguna yang diberikan

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

Titik akhir ini terpukul saat Anda mengunduh ekstensi VSTS dari Antarmuka Pengguna Web

getPublisher(string, number)
getPublisherAsset(string, string)

Mendapatkan aset penerbit seperti logo sebagai aliran

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

Mengembalikan daftar pertanyaan dengan respons mereka yang terkait dengan ekstensi.

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

Mengembalikan daftar tinjauan yang terkait dengan ekstensi

getReviewsSummary(string, string, Date, Date)

Mengembalikan ringkasan tinjauan

getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
getVSCodeExtensionLatestVersion(string, string)

Titik akhir untuk mendapatkan versi terbaru ekstensi Visual Studio Code.

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

Menaikkan statistik harian yang terkait dengan ekstensi

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])

Titik akhir API untuk menerbitkan peristiwa penginstalan/penghapusan instalan ekstensi. Ini dimaksudkan untuk dipanggil oleh EMS hanya untuk mengirimi kami data yang terkait dengan penginstalan/penghapusan instalan ekstensi.

publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)

Menandai kekhawatiran dengan pertanyaan yang ada untuk ekstensi.

requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)

Kirim Pemberitahuan

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

Mengatur semua entri pengaturan untuk cakupan pengguna/semua pengguna yang diberikan

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)

Titik akhir REST untuk memperbarui ekstensi.

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)

Perbarui aset penerbit seperti logo. Ini menerima file aset sebagai aliran oktet dan nama file diteruskan dalam nilai header.

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Titik akhir untuk menambahkan/mengubah keanggotaan penerbit. Saat ini Hanya Mendukung penambahan/modifikasi 1 pengguna pada satu waktu Hanya berfungsi untuk menambahkan anggota penyewa yang sama.

updateQuestion(Question, string, string, number)

Memperbarui pertanyaan yang ada untuk ekstensi.

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

Memperbarui respons yang ada untuk pertanyaan tertentu untuk ekstensi.

updateReview(ReviewPatch, string, string, number)

Memperbarui atau Menandai ulasan

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Detail Konstruktor

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

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

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

Parameter

content

string

Konten yang akan diunggah

publisherName

string

extensionName

string

draftId

string

assetType

string

Mengembalikan

addAssetForNewExtensionDraft(string, string, string, string)

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

Parameter

content

string

Konten yang akan diunggah

publisherName

string

draftId

string

assetType

string

Mengembalikan

associateAzurePublisher(string, string)

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

Parameter

publisherName

string

azurePublisherId

string

Mengembalikan

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parameter

Mengembalikan

createDraftForEditExtension(string, string)

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

Parameter

publisherName

string

extensionName

string

Mengembalikan

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

product

String

Header untuk meneruskan jenis produk file payload

fileName

String

Header untuk meneruskan nama file data yang diunggah

Mengembalikan

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parameter

content

any

Konten yang akan diunggah

extensionType

string

reCaptchaToken

string

Mengembalikan

createExtensionWithPublisher(any, string, string, string)

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

extensionType

string

reCaptchaToken

string

Mengembalikan

createPublisher(Publisher)

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

Parameter

publisher
Publisher

Mengembalikan

Promise<Publisher>

createQuestion(Question, string, string)

Membuat pertanyaan baru untuk ekstensi.

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

Parameter

question
Question

Pertanyaan yang akan dibuat untuk ekstensi.

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

Mengembalikan

Promise<Question>

createResponse(Response, string, string, number)

Membuat respons baru untuk pertanyaan tertentu untuk ekstensi.

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

Parameter

response
Response

Respons yang akan dibuat untuk ekstensi.

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

questionId

number

Pengidentifikasi pertanyaan yang responsnya akan dibuat untuk ekstensi.

Mengembalikan

Promise<Response>

createReview(Review, string, string)

Membuat tinjauan baru untuk ekstensi

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

Parameter

review
Review

Tinjauan yang akan dibuat untuk ekstensi

pubName

string

Nama penerbit yang menerbitkan ekstensi

extName

string

Nama ekstensi

Mengembalikan

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parameter

customerSupportRequest
CustomerSupportRequest

Mengembalikan

Promise<void>

deleteExtension(string, string, string)

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

Parameter

publisherName

string

extensionName

string

version

string

Mengembalikan

Promise<void>

deleteExtensionById(string, string)

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

Parameter

extensionId

string

version

string

Mengembalikan

Promise<void>

deletePublisher(string)

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

Parameter

publisherName

string

Mengembalikan

Promise<void>

deletePublisherAsset(string, string)

Menghapus aset penerbit seperti logo

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

Parameter

publisherName

string

Nama internal penerbit

assetType

string

Jenis aset. Nilai defaultnya adalah 'logo'.

Mengembalikan

Promise<void>

deleteQuestion(string, string, number)

Menghapus pertanyaan yang ada dan semua respons terkait untuk ekstensi. (penghapusan sementara)

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

Parameter

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

questionId

number

Pengidentifikasi pertanyaan yang akan dihapus untuk ekstensi.

Mengembalikan

Promise<void>

deleteResponse(string, string, number, number)

Menghapus respons untuk ekstensi. (penghapusan sementara)

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

Parameter

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

questionId

number

Mengidentifikasi pertanyaan yang responsnya akan dihapus.

responseId

number

Mengidentifikasi respons yang akan dihapus.

Mengembalikan

Promise<void>

deleteReview(string, string, number)

Menghapus tinjauan

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

Parameter

pubName

string

Nama penerbit yang menerbitkan ekstensi

extName

string

Nama ekstensi

reviewId

number

Id tinjauan yang perlu diperbarui

Mengembalikan

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Titik akhir rest untuk memvalidasi apakah penerbit Azure memiliki ekstensi untuk skenario perdagangan pihak ke-3. Azure hanya mendukung operasi POST dan tanda tangan di atas tidak khas dari operasi 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>

Parameter

azureRestApiRequestModel
AzureRestApiRequestModel

Semua parameter dikirim dalam isi permintaan

Mengembalikan

Promise<void>

fetchDomainToken(string)

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

Parameter

publisherName

string

Mengembalikan

Promise<string>

generateKey(string, number)

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

Parameter

keyType

string

expireCurrentSeconds

number

Mengembalikan

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parameter

itemId

string

installationTarget

string

testCommerce

boolean

isFreeOrTrialInstall

boolean

Mengembalikan

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

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

Parameter

extensionId

string

version

string

assetType

string

accountToken

string

acceptDefault

boolean

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

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>

Parameter

publisherName

string

extensionName

string

version

string

assetType

string

accountToken

string

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

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>

Parameter

publisherName

string

extensionName

string

version

string

assetType

string

accountToken

string

acceptDefault

boolean

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parameter

publisherName

string

draftId

string

assetType

string

extensionName

string

Mengembalikan

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parameter

publisherName

string

draftId

string

assetType

string

Mengembalikan

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>

Parameter

publisherName

string

extensionName

string

version

string

assetType

string

assetToken

string

accountToken

string

acceptDefault

boolean

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

Promise<ArrayBuffer>

getCategories(string)

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

Parameter

languages

string

Mengembalikan

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parameter

categoryName

string

languages

string

product

string

Mengembalikan

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>

Parameter

product

string

categoryId

string

lcid

number

source

string

productVersion

string

skus

string

subSkus

string

productArchitecture

string

Mengembalikan

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parameter

publisherName

string

extensionName

string

version

string

Mengembalikan

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>

Parameter

publisherName

string

extensionName

string

version

string

accountToken

string

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

getExtensionById(string, string, ExtensionQueryFlags)

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

Parameter

extensionId

string

version

string

Mengembalikan

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

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

Parameter

publisherName

string

extensionName

string

days

number

aggregate
Daily
afterDate

Date

Mengembalikan

getExtensionDailyStatsAnonymous(string, string, string)

Id rute/lokasi ini hanya mendukung HTTP POST secara anonim, sehingga statistik harian tampilan halaman dapat ditambahkan dari klien Marketplace. Mencoba memanggil GET pada rute ini akan menghasilkan pengecualian. Tanpa implementasi eksplisit ini, memanggil GET pada rute publik ini memanggil implementasi GET di atas GetExtensionDailyStats.

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

Parameter

publisherName

string

Nama penerbit

extensionName

string

Nama ekstensi

version

string

Versi ekstensi

Mengembalikan

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

Dapatkan peristiwa instal/hapus instalan ekstensi. Jika parameter count dan afterDate ditentukan, hitungan lebih diutamakan.

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

Parameter

publisherName

string

Nama penerbit

extensionName

string

Nama ekstensi

count

number

Jumlah peristiwa yang akan diambil, berlaku untuk setiap jenis peristiwa.

afterDate

Date

Ambil peristiwa yang terjadi pada atau setelah tanggal ini

include

string

Opsi filter. Nilai yang didukung: instal, hapus instalan, tinjauan, akuisisi, penjualan. Defaultnya adalah mengambil semua jenis peristiwa

includeProperty

string

Properti peristiwa yang akan disertakan. Saat ini hanya 'lastContactDetails' yang didukung untuk menghapus instalan peristiwa

Mengembalikan

Promise<ExtensionEvents>

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

Mengembalikan laporan ekstensi

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

Parameter

publisherName

string

Nama penerbit yang menerbitkan ekstensi

extensionName

string

Nama ekstensi

days

number

Laporan n hari terakhir. Jika afterDate dan hari ditentukan, hari akan diprioritaskan

count

number

Jumlah peristiwa yang akan dikembalikan

afterDate

Date

Gunakan jika Anda ingin mengambil peristiwa yang lebih baru dari tanggal yang ditentukan

Mengembalikan

Promise<any>

getGalleryUserSettings(string, string)

Mendapatkan semua entri pengaturan untuk cakupan pengguna/semua pengguna yang diberikan

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

Parameter

userScope

string

User-Scope untuk mendapatkan nilainya. Harus "saya" untuk pengguna saat ini atau "host" untuk semua pengguna.

key

string

Kunci opsional untuk memfilter semua entri

Mengembalikan

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

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

Titik akhir ini terpukul saat Anda mengunduh ekstensi VSTS dari Antarmuka Pengguna Web

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

Parameter

publisherName

string

extensionName

string

version

string

accountToken

string

acceptDefault

boolean

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parameter

publisherName

string

flags

number

Mengembalikan

Promise<Publisher>

getPublisherAsset(string, string)

Mendapatkan aset penerbit seperti logo sebagai aliran

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

Parameter

publisherName

string

Nama internal penerbit

assetType

string

Jenis aset. Nilai defaultnya adalah 'logo'.

Mengembalikan

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parameter

publisherName

string

Mengembalikan

Promise<Publisher>

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

Mengembalikan daftar pertanyaan dengan respons mereka yang terkait dengan ekstensi.

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

Parameter

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

count

number

Jumlah pertanyaan yang akan diambil (default ke 10).

page

number

Nomor halaman dari set pertanyaan mana yang akan diambil.

afterDate

Date

Jika disediakan, pertanyaan hasil dikembalikan yang diposting setelah tanggal ini

Mengembalikan

Promise<QuestionsResult>

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

Mengembalikan daftar tinjauan yang terkait dengan ekstensi

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

Parameter

publisherName

string

Nama penerbit yang menerbitkan ekstensi

extensionName

string

Nama ekstensi

count

number

Jumlah tinjauan yang akan diambil (default ke 5)

filterOptions
ReviewFilterOptions

FilterOptions untuk memfilter tinjauan kosong etcetera, default ke tidak ada

beforeDate

Date

Gunakan jika Anda ingin mengambil tinjauan yang lebih lama dari tanggal yang ditentukan, default ke null

afterDate

Date

Gunakan jika Anda ingin mengambil tinjauan yang lebih baru dari tanggal yang ditentukan, default ke null

Mengembalikan

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Mengembalikan ringkasan tinjauan

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

Parameter

pubName

string

Nama penerbit yang menerbitkan ekstensi

extName

string

Nama ekstensi

beforeDate

Date

Gunakan jika Anda ingin mengambil ringkasan tinjauan yang lebih lama dari tanggal yang ditentukan, default ke null

afterDate

Date

Gunakan jika Anda ingin mengambil ringkasan tinjauan yang lebih baru dari tanggal yang ditentukan, default ke null

Mengembalikan

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>

Parameter

product

string

lcid

number

source

string

productVersion

string

skus

string

subSkus

string

Mengembalikan

getSigningKey(string)

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

Parameter

keyType

string

Mengembalikan

Promise<string>

getVerificationLog(string, string, string, string)

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

Parameter

publisherName

string

extensionName

string

version

string

targetPlatform

string

Mengembalikan

Promise<ArrayBuffer>

getVSCodeExtensionLatestVersion(string, string)

Titik akhir untuk mendapatkan versi terbaru ekstensi Visual Studio Code.

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

Parameter

publisherName

string

Nama penerbit ekstensi VISUAL Code yang diminta.

extensionName

string

Nama ekstensi.

Mengembalikan

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

Menaikkan statistik harian yang terkait dengan ekstensi

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

Parameter

publisherName

string

Nama penerbit

extensionName

string

Nama ekstensi

version

string

Versi ekstensi

statType

string

Jenis stat ke kenaikan

targetPlatform

string

Mengembalikan

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parameter

draftPatch
ExtensionDraftPatch
publisherName

string

extensionName

string

draftId

string

Mengembalikan

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parameter

draftPatch
ExtensionDraftPatch
publisherName

string

draftId

string

Mengembalikan

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Titik akhir API untuk menerbitkan peristiwa penginstalan/penghapusan instalan ekstensi. Ini dimaksudkan untuk dipanggil oleh EMS hanya untuk mengirimi kami data yang terkait dengan penginstalan/penghapusan instalan ekstensi.

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

Parameter

extensionEvents

ExtensionEvents[]

Mengembalikan

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>

Parameter

content

any

Konten yang akan diunggah

publisherName

string

extensionName

string

extensionType

string

reCaptchaToken

string

bypassScopeCheck

boolean

Mengembalikan

queryAssociatedAzurePublisher(string)

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

Parameter

publisherName

string

Mengembalikan

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parameter

extensionQuery
ExtensionQuery
accountToken

string

accountTokenHeader

String

Header untuk meneruskan token akun

Mengembalikan

queryPublishers(PublisherQuery)

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

Parameter

publisherQuery
PublisherQuery

Mengembalikan

reportQuestion(Concern, string, string, number)

Menandai kekhawatiran dengan pertanyaan yang ada untuk ekstensi.

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

Parameter

concern
Concern

Pengguna melaporkan kekhawatiran dengan pertanyaan untuk ekstensi.

pubName

string

Nama penerbit yang menerbitkan ekstensi.

extName

string

Nama ekstensi.

questionId

number

Pengidentifikasi pertanyaan yang akan diperbarui untuk ekstensi.

Mengembalikan

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parameter

acquisitionRequest
ExtensionAcquisitionRequest

Mengembalikan

sendNotifications(NotificationsData)

Kirim Pemberitahuan

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

Parameter

notificationData
NotificationsData

Menunjukkan data yang diperlukan untuk mengirim pemberitahuan

Mengembalikan

Promise<void>

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

Mengatur semua entri pengaturan untuk cakupan pengguna/semua pengguna yang diberikan

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

Parameter

entries

{[key: string]: any}

Pasangan kunci-nilai dari semua pengaturan yang perlu diatur

userScope

string

User-Scope untuk mendapatkan nilainya. Harus "saya" untuk pengguna saat ini atau "host" untuk semua pengguna.

Mengembalikan

Promise<void>

shareExtension(string, string, string)

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

Parameter

publisherName

string

extensionName

string

accountName

string

Mengembalikan

Promise<void>

shareExtensionById(string, string)

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

Parameter

extensionId

string

accountName

string

Mengembalikan

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parameter

publisherName

string

extensionName

string

hostType

string

hostName

string

Mengembalikan

Promise<void>

unshareExtension(string, string, string)

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

Parameter

publisherName

string

extensionName

string

accountName

string

Mengembalikan

Promise<void>

unshareExtensionById(string, string)

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

Parameter

extensionId

string

accountName

string

Mengembalikan

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parameter

publisherName

string

extensionName

string

hostType

string

hostName

string

Mengembalikan

Promise<void>

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

Titik akhir REST untuk memperbarui ekstensi.

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

Nama penerbit

extensionName

string

Nama ekstensi

extensionType

string

reCaptchaToken

string

bypassScopeCheck

boolean

Parameter ini memutuskan apakah pemeriksaan perubahan cakupan perlu dipanggil atau tidak

Mengembalikan

updateExtensionById(string, string)

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

Parameter

extensionId

string

reCaptchaToken

string

Mengembalikan

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parameter

publisherName

string

extensionName

string

Mengembalikan

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parameter

extensionStatisticsUpdate
ExtensionStatisticUpdate
publisherName

string

extensionName

string

Mengembalikan

Promise<void>

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

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

extensionName

string

draftId

string

fileName

String

Header untuk meneruskan nama file data yang diunggah

Mengembalikan

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

draftId

string

fileName

String

Header untuk meneruskan nama file data yang diunggah

Mengembalikan

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parameter

publisher
Publisher
publisherName

string

Mengembalikan

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Perbarui aset penerbit seperti logo. Ini menerima file aset sebagai aliran oktet dan nama file diteruskan dalam nilai header.

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

Parameter

content

any

Konten yang akan diunggah

publisherName

string

Nama internal penerbit

assetType

string

Jenis aset. Nilai defaultnya adalah 'logo'.

fileName

String

Header untuk meneruskan nama file data yang diunggah

Mengembalikan

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Titik akhir untuk menambahkan/mengubah keanggotaan penerbit. Saat ini Hanya Mendukung penambahan/modifikasi 1 pengguna pada satu waktu Hanya berfungsi untuk menambahkan anggota penyewa yang sama.

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

Parameter

roleAssignments

PublisherUserRoleAssignmentRef[]

Daftar pengidentifikasi pengguna (alamat email) dan peran yang akan ditambahkan. Saat ini hanya satu entri yang didukung.

publisherName

string

Nama/id penerbit tempat pengguna harus ditambahkan

limitToCallerIdentityDomain

boolean

Haruskah addtion lintas penyewa diizinkan atau tidak.

Mengembalikan

updateQuestion(Question, string, string, number)

Memperbarui pertanyaan yang ada untuk ekstensi.

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

Parameter

question
Question

Pertanyaan yang diperbarui untuk diatur untuk ekstensi.

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

questionId

number

Pengidentifikasi pertanyaan yang akan diperbarui untuk ekstensi.

Mengembalikan

Promise<Question>

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

Memperbarui respons yang ada untuk pertanyaan tertentu untuk ekstensi.

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

Parameter

response
Response

Respons yang diperbarui akan diatur untuk ekstensi.

publisherName

string

Nama penerbit yang menerbitkan ekstensi.

extensionName

string

Nama ekstensi.

questionId

number

Pengidentifikasi pertanyaan yang responsnya akan diperbarui untuk ekstensi.

responseId

number

Pengidentifikasi respons yang harus diperbarui.

Mengembalikan

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Memperbarui atau Menandai ulasan

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

Parameter

reviewPatch
ReviewPatch

Objek ReviewPatch yang berisi perubahan yang akan diterapkan pada tinjauan

pubName

string

Nama penerbit yang menerbitkan ekstensi

extName

string

Nama ekstensi

reviewId

number

Id tinjauan yang perlu diperbarui

Mengembalikan

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parameter

itemName

string

version

string

Mengembalikan

Promise<void>

verifyDomainToken(string)

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

Parameter

publisherName

string

Mengembalikan

Promise<void>