GalleryRestClient class

Referencia

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni

Extends: RestClientBase

Konstruktorok

GalleryRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

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)	Létrehoz egy új kérdést egy bővítményhez.
createResponse(Response, string, string, number)	Új választ hoz létre egy adott kérdésre egy bővítményhez.
createReview(Review, string, string)	Új felülvizsgálat létrehozása bővítményhez
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Közzétevői eszköz törlése, például embléma
deleteQuestion(string, string, number)	Töröl egy meglévő kérdést és annak összes kapcsolódó válaszát egy bővítményhez. (helyreállítható törlés)
deleteResponse(string, string, number, number)	Egy bővítmény válaszának törlése. (helyreállítható törlés)
deleteReview(string, string, number)	Felülvizsgálat törlése
extensionValidator(AzureRestApiRequestModel)	Rest end point annak ellenőrzéséhez, hogy egy Azure-közzétevő rendelkezik-e külső kereskedelmi forgatókönyvhöz tartozó bővítménysel. Az Azure csak a POST műveleteket támogatja, és a fenti aláírás nem jellemző a REST-műveletekre. 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)
getContentVerificationLog(string, string)
getExtension(string, string, string, ExtensionQueryFlags, string, String)
getExtensionById(string, string, ExtensionQueryFlags)
getExtensionDailyStats(string, string, number, Daily, Date)
getExtensionDailyStatsAnonymous(string, string, string)	Ez az útvonal-/helyazonosító csak névtelenül támogatja a HTTP POST-ot, így az oldalnézet napi statisztikája növelhető a Marketplace-ügyfélről. Ha megpróbáljuk meghívni a GET-t ezen az útvonalon, kivételt kell eredményeznie. Ezen explicit megvalósítás nélkül a GET meghívása ezen a nyilvános útvonalon meghívja a fenti GET-implementációt GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Bővítmény telepítési/eltávolítási eseményeinek lekérése. Ha a count és az afterDate paraméterek is meg vannak adva, a darabszám elsőbbséget élvez.
getExtensionReports(string, string, number, number, Date)	Bővítményjelentéseket ad vissza
getGalleryUserSettings(string, string)	Az adott felhasználó/minden felhasználó hatókör összes beállítási bejegyzésének lekérése
getPackage(string, string, string, string, boolean, String)	Ezt a végpontot akkor éri el a rendszer, ha letölt egy VSTS-bővítményt a webes felhasználói felületről
getPublisher(string, number)
getPublisherAsset(string, string)	Közzétevői eszköz, például embléma lekérése streamként
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	A bővítményhez társított válaszokkal kapcsolatos kérdések listáját adja vissza.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	A bővítményhez társított vélemények listáját adja vissza
getReviewsSummary(string, string, Date, Date)	A vélemények összegzését adja vissza
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	A bővítményhez társított napi statisztika növekménye
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	API-végpont bővítménytelepítési/eltávolítási események közzétételéhez. Ezt az EMS csak a bővítmény telepítésével/eltávolításával kapcsolatos adatok küldéséhez hívja meg.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Aggodalomra ad okot egy meglévő, bővítményre vonatkozó kérdéssel kapcsolatban.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Értesítés küldése
setGalleryUserSettings({[key: string]: any}, string)	Az adott felhasználó/minden felhasználó hatókör összes beállítási bejegyzésének beállítása
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-végpont egy bővítmény frissítéséhez.
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)	Frissítse a közzétevői objektumot, például az emblémát. Oktet streamként fogadja el az objektumfájlt, és a fájlnév a fejlécértékekben lesz átadva.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Közzétevői tagság hozzáadásához/módosításához szükséges végpont. Jelenleg csak 1 felhasználó hozzáadását/módosítását támogatja egyszerre, csak ugyanazon bérlő tagjainak hozzáadására használható.
updateQuestion(Question, string, string, number)	Frissítések egy meglévő bővítményre vonatkozó kérdést.
updateResponse(Response, string, string, number, number)	Frissítések egy meglévő választ egy adott kérdésre egy bővítményre vonatkozóan.
updateReview(ReviewPatch, string, string, number)	vélemény Frissítések vagy megjelölése
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Konstruktor adatai

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

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

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

Paraméterek

content: string

Feltöltendő tartalom

publisherName: string

extensionName: string

draftId: string

assetType: string

Válaszok

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Paraméterek

content: string

Feltöltendő tartalom

publisherName: string

draftId: string

assetType: string

Válaszok

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Paraméterek

publisherName: string

azurePublisherId: string

Válaszok

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Paraméterek

category: ExtensionCategory

Válaszok

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Paraméterek

publisherName: string

extensionName: string

Válaszok

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

product: String

Fejléc a hasznos adatfájl terméktípusának átadásához

fileName: String

Fejléc a feltöltött adatok fájlnevének átadásához

Válaszok

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Paraméterek

content: any

Feltöltendő tartalom

extensionType: string

reCaptchaToken: string

Válaszok

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

extensionType: string

reCaptchaToken: string

Válaszok

Promise<PublishedExtension>

createPublisher(Publisher)

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

Paraméterek

publisher: Publisher

Válaszok

Promise<Publisher>

createQuestion(Question, string, string)

Létrehoz egy új kérdést egy bővítményhez.

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

Paraméterek

question: Question

A bővítményhez létrehozandó kérdés.

publisherName: string

A bővítményt közzétevő közzétevő neve.

extensionName: string

A bővítmény neve.

Válaszok

Promise<Question>

createResponse(Response, string, string, number)

Új választ hoz létre egy adott kérdésre egy bővítményhez.

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

Paraméterek

response: Response

A bővítményhez létrehozandó válasz.

publisherName: string

A bővítményt közzétevő közzétevő neve.

extensionName: string

A bővítmény neve.

questionId: number

Annak a kérdésnek az azonosítója, amelyre a bővítményhez választ kell létrehozni.

Válaszok

Promise<Response>

createReview(Review, string, string)

Új felülvizsgálat létrehozása bővítményhez

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

Paraméterek

review: Review

A bővítményhez létrehozandó felülvizsgálat

pubName: string

A bővítményt közzétevő neve

extName: string

A bővítmény neve

Válaszok

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Paraméterek

customerSupportRequest: CustomerSupportRequest

Válaszok

Promise<void>

deleteExtension(string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

version: string

Válaszok

Promise<void>

deleteExtensionById(string, string)

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

Paraméterek

extensionId: string

version: string

Válaszok

Promise<void>

deletePublisher(string)

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

Paraméterek

publisherName: string

Válaszok

Promise<void>

deletePublisherAsset(string, string)

Közzétevői eszköz törlése, például embléma

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

Paraméterek

publisherName: string

A közzétevő belső neve

assetType: string

Az eszköz típusa. Az alapértelmezett érték az "embléma".

Válaszok

Promise<void>

deleteQuestion(string, string, number)

Töröl egy meglévő kérdést és annak összes kapcsolódó válaszát egy bővítményhez. (helyreállítható törlés)

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

Paraméterek

publisherName: string

A bővítményt közzétevő közzétevő neve.

extensionName: string

A bővítmény neve.

questionId: number

A bővítményhez törölni kívánt kérdés azonosítója.

Válaszok

Promise<void>

deleteResponse(string, string, number, number)

Egy bővítmény válaszának törlése. (helyreállítható törlés)

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

Paraméterek

publisherName: string

A bővítményt közzétevő közzétevő neve.

extensionName: string

A bővítmény neve.

questionId: number

Azonosítja azt a kérdést, amelynek a válaszát törölni kell.

responseId: number

Azonosítja a törölni kívánt választ.

Válaszok

Promise<void>

deleteReview(string, string, number)

Felülvizsgálat törlése

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

Paraméterek

pubName: string

A bővítményt közzétevő neve

extName: string

A bővítmény neve

reviewId: number

A frissíteni kívánt felülvizsgálat azonosítója

Válaszok

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Rest end point annak ellenőrzéséhez, hogy egy Azure-közzétevő rendelkezik-e külső kereskedelmi forgatókönyvhöz tartozó bővítménysel. Az Azure csak a POST műveleteket támogatja, és a fenti aláírás nem jellemző a REST-műveletekre. 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>

Paraméterek

azureRestApiRequestModel: AzureRestApiRequestModel

A rendszer az összes paramétert elküldi a kérelem törzsében

Válaszok

Promise<void>

fetchDomainToken(string)

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

Paraméterek

publisherName: string

Válaszok

Promise<string>

generateKey(string, number)

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

Paraméterek

keyType: string

expireCurrentSeconds: number

Válaszok

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Paraméterek

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Válaszok

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>

Paraméterek

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

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>

Paraméterek

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

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>

Paraméterek

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Paraméterek

publisherName: string

draftId: string

assetType: string

extensionName: string

Válaszok

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Paraméterek

publisherName: string

draftId: string

assetType: string

Válaszok

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>

Paraméterek

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

Promise<ArrayBuffer>

getCategories(string)

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

Paraméterek

languages: string

Válaszok

Promise<string[]>

getCategoryDetails(string, string, string)

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

Paraméterek

categoryName: string

languages: string

product: string

Válaszok

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>

Paraméterek

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Válaszok

Promise<ProductCategory>

getCertificate(string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

version: string

Válaszok

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

function getContentVerificationLog(publisherName: string, extensionName: string): Promise<ArrayBuffer>

Paraméterek

publisherName: string

extensionName: string

Válaszok

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>

Paraméterek

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Paraméterek

extensionId: string

version: string

flags: ExtensionQueryFlags

Válaszok

Promise<PublishedExtension>

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

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

Paraméterek

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Válaszok

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Ez az útvonal-/helyazonosító csak névtelenül támogatja a HTTP POST-ot, így az oldalnézet napi statisztikája növelhető a Marketplace-ügyfélről. Ha megpróbáljuk meghívni a GET-t ezen az útvonalon, kivételt kell eredményeznie. Ezen explicit megvalósítás nélkül a GET meghívása ezen a nyilvános útvonalon meghívja a fenti GET-implementációt GetExtensionDailyStats.

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

Paraméterek

publisherName: string

A közzétevő neve

extensionName: string

A bővítmény neve

version: string

A bővítmény verziója

Válaszok

Promise<ExtensionDailyStats>

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

Bővítmény telepítési/eltávolítási eseményeinek lekérése. Ha a count és az afterDate paraméterek is meg vannak adva, a darabszám elsőbbséget élvez.

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

Paraméterek

publisherName: string

A közzétevő neve

extensionName: string

A bővítmény neve

count: number

A beolvasandó események száma az egyes eseménytípusokra vonatkozik.

afterDate: Date

Ezen a napon vagy azt követően történt események beolvasása

include: string

Szűrési beállítások. Támogatott értékek: telepítés, eltávolítás, felülvizsgálat, beszerzés, értékesítés. Az alapértelmezett érték az összes típusú esemény lekérése

includeProperty: string

A belefoglalandó eseménytulajdonságok. Jelenleg csak a "lastContactDetails" támogatott az eltávolítási eseményekhez

Válaszok

Promise<ExtensionEvents>

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

Bővítményjelentéseket ad vissza

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

Paraméterek

publisherName: string

A bővítményt közzétevő neve

extensionName: string

A bővítmény neve

days: number

Az elmúlt n napos jelentés. Ha az afterDate és a days paraméter meg van adva, a napok elsőbbséget élveznek

count: number

A visszaadandó események száma

afterDate: Date

Akkor használja, ha a megadott dátumnál újabb eseményeket szeretne beolvasni

Válaszok

Promise<any>

getGalleryUserSettings(string, string)

Az adott felhasználó/minden felhasználó hatókör összes beállítási bejegyzésének lekérése

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

Paraméterek

userScope: string

User-Scope az érték lekéréséhez. Az aktuális felhasználónak "én" vagy "gazdagépnek" kell lennie az összes felhasználó esetében.

key: string

Nem kötelező kulcs, amely alatt az összes bejegyzést szűrni szeretné

Válaszok

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

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

Ezt a végpontot akkor éri el a rendszer, ha letölt egy VSTS-bővítményt a webes felhasználói felületről

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

Paraméterek

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

Promise<ArrayBuffer>

getPublisher(string, number)

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

Paraméterek

publisherName: string

flags: number

Válaszok

Promise<Publisher>

getPublisherAsset(string, string)

Közzétevői eszköz, például embléma lekérése streamként

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

Paraméterek

publisherName: string

A közzétevő belső neve

assetType: string

Az eszköz típusa. Az alapértelmezett érték az "embléma".

Válaszok

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Paraméterek

publisherName: string

Válaszok

Promise<Publisher>

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

A bővítményhez társított válaszokkal kapcsolatos kérdések listáját adja vissza.

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

Paraméterek

publisherName: string

A bővítményt közzétevő közzétevő neve.

extensionName: string

A bővítmény neve.

count: number

A lekérendő kérdések száma (alapértelmezés szerint 10).

page: number

Oldalszám, amelyből kérdéseket szeretne lekérni.

afterDate: Date

Ha meg van adva, a rendszer visszaadja az eredményekkel kapcsolatos kérdéseket, amelyeket a dátum után tettek közzé

Válaszok

Promise<QuestionsResult>

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

A bővítményhez társított vélemények listáját adja vissza

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

Paraméterek

publisherName: string

A bővítményt közzétevő neve

extensionName: string

A bővítmény neve

count: number

Lekérendő vélemények száma (alapértelmezés szerint 5)

filterOptions: ReviewFilterOptions

FilterOptions az üres vélemények kiszűréséhez stb.

beforeDate: Date

Ha a megadott dátumnál régebbi véleményeket szeretne lekérni, alapértelmezés szerint null értékű

afterDate: Date

Ha a megadott dátumnál újabb véleményeket szeretne beolvasni, az alapértelmezett érték null

Válaszok

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

A vélemények összegzését adja vissza

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

Paraméterek

pubName: string

A bővítményt közzétevő neve

extName: string

A bővítmény neve

beforeDate: Date

Ha a megadott dátumnál régebbi felülvizsgálatok összegzését szeretné lekérni, alapértelmezés szerint null értékű

afterDate: Date

Ha a megadott dátumnál újabb felülvizsgálatok összegzését szeretné lekérni, az alapértelmezett érték null

Válaszok

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>

Paraméterek

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Válaszok

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Paraméterek

keyType: string

Válaszok

Promise<string>

getVerificationLog(string, string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

version: string

targetPlatform: string

Válaszok

Promise<ArrayBuffer>

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

A bővítményhez társított napi statisztika növekménye

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

Paraméterek

publisherName: string

A közzétevő neve

extensionName: string

A bővítmény neve

version: string

A bővítmény verziója

statType: string

A statisztikának a növekményes típusa

targetPlatform: string

Válaszok

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Paraméterek

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Válaszok

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Paraméterek

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Válaszok

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

API-végpont bővítménytelepítési/eltávolítási események közzétételéhez. Ezt az EMS csak a bővítmény telepítésével/eltávolításával kapcsolatos adatok küldéséhez hívja meg.

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

Paraméterek

extensionEvents: ExtensionEvents[]

Válaszok

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>

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Válaszok

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Paraméterek

publisherName: string

Válaszok

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Paraméterek

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Fejléc a fiók jogkivonatának átadásához

Válaszok

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Paraméterek

publisherQuery: PublisherQuery

Válaszok

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Aggodalomra ad okot egy meglévő, bővítményre vonatkozó kérdéssel kapcsolatban.

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

Paraméterek

concern: Concern

A felhasználó aggodalmát jelentette a bővítményre vonatkozó kérdés miatt.

pubName: string

A bővítményt közzétevő közzétevő neve.

extName: string

A bővítmény neve.

questionId: number

A bővítményhez frissítendő kérdés azonosítója.

Válaszok

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Paraméterek

acquisitionRequest: ExtensionAcquisitionRequest

Válaszok

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Értesítés küldése

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

Paraméterek

notificationData: NotificationsData

Az értesítés küldéséhez szükséges adatok jelölése

Válaszok

Promise<void>

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

Az adott felhasználó/minden felhasználó hatókör összes beállítási bejegyzésének beállítása

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

Paraméterek

entries: {[key: string]: any}

Az összes beállítás kulcs-érték párja, amelyet be kell állítani

userScope: string

User-Scope az érték lekéréséhez. Az aktuális felhasználónak "én" vagy "gazdagépnek" kell lennie az összes felhasználó esetében.

Válaszok

Promise<void>

shareExtension(string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

accountName: string

Válaszok

Promise<void>

shareExtensionById(string, string)

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

Paraméterek

extensionId: string

accountName: string

Válaszok

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

hostType: string

hostName: string

Válaszok

Promise<void>

unshareExtension(string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

accountName: string

Válaszok

Promise<void>

unshareExtensionById(string, string)

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

Paraméterek

extensionId: string

accountName: string

Válaszok

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Paraméterek

publisherName: string

extensionName: string

hostType: string

hostName: string

Válaszok

Promise<void>

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

REST-végpont egy bővítmény frissítéséhez.

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

A közzétevő neve

extensionName: string

A bővítmény neve

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Ez a paraméter dönti el, hogy a hatókör-módosítási ellenőrzést meg kell-e hívni vagy sem

Válaszok

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Paraméterek

extensionId: string

reCaptchaToken: string

Válaszok

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Paraméterek

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Válaszok

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Paraméterek

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Válaszok

Promise<void>

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

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

extensionName: string

draftId: string

fileName: String

Fejléc a feltöltött adatok fájlnevének átadásához

Válaszok

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

draftId: string

fileName: String

Fejléc a feltöltött adatok fájlnevének átadásához

Válaszok

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Paraméterek

publisher: Publisher

publisherName: string

Válaszok

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Frissítse a közzétevői objektumot, például az emblémát. Oktet streamként fogadja el az objektumfájlt, és a fájlnév a fejlécértékekben lesz átadva.

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

Paraméterek

content: any

Feltöltendő tartalom

publisherName: string

A közzétevő belső neve

assetType: string

Az objektum típusa. Az alapértelmezett érték az "embléma".

fileName: String

Fejléc a feltöltött adatok fájlnevének átadásához

Válaszok

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Közzétevői tagság hozzáadásához/módosításához szükséges végpont. Jelenleg csak 1 felhasználó hozzáadását/módosítását támogatja egyszerre, csak ugyanazon bérlő tagjainak hozzáadására használható.

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

Paraméterek

roleAssignments: PublisherUserRoleAssignmentRef[]

A hozzáadandó felhasználói azonosítók (e-mail-cím) és szerepkörök listája. Jelenleg csak egy bejegyzés támogatott.

publisherName: string

Annak a közzétevőnek a neve/azonosítója, amelyhez hozzá kell adni a felhasználókat

limitToCallerIdentityDomain: boolean

A bérlők közötti bővítmények engedélyezése vagy tiltása.

Válaszok

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Frissítések egy meglévő bővítményre vonatkozó kérdést.

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

Paraméterek

question: Question

Frissítve van a bővítményhez beállítandó kérdés.

publisherName: string

Annak a közzétevőnek a neve, aki közzétette a bővítményt.

extensionName: string

A bővítmény neve.

questionId: number

A bővítményhez frissítendő kérdés azonosítója.

Válaszok

Promise<Question>

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

Frissítések egy meglévő választ egy adott kérdésre egy bővítményre vonatkozóan.

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

Paraméterek

response: Response

A bővítményhez beállított frissített válasz.

publisherName: string

Annak a közzétevőnek a neve, aki közzétette a bővítményt.

extensionName: string

A bővítmény neve.

questionId: number

Annak a kérdésnek az azonosítója, amelyre a bővítmény válaszát frissíteni kell.

responseId: number

A frissíteni kívánt válasz azonosítója.

Válaszok

Promise<Response>

updateReview(ReviewPatch, string, string, number)

vélemény Frissítések vagy megjelölése

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

Paraméterek

reviewPatch: ReviewPatch

ReviewPatch objektum, amely a felülvizsgálatra alkalmazandó módosításokat tartalmazza

pubName: string

Annak a közzétevőnek a neve, aki közzétette a bővítményt

extName: string

A bővítmény neve

reviewId: number

A frissíteni kívánt felülvizsgálat azonosítója

Válaszok

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Paraméterek

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Válaszok

Promise<void>

verifyDomainToken(string)

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

Paraméterek

publisherName: string

Válaszok

Promise<void>

Megosztás a következőn keresztül:

GalleryRestClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

GalleryRestClient(IVssRestClientOptions)

Paraméterek

Tulajdonság adatai

RESOURCE_AREA_ID

Tulajdonság értéke

Metódus adatai

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

Paraméterek

Válaszok

addAssetForNewExtensionDraft(string, string, string, string)

Paraméterek

Válaszok

associateAzurePublisher(string, string)

Paraméterek

Válaszok

createCategory(ExtensionCategory)

Paraméterek

Válaszok

createDraftForEditExtension(string, string)

Paraméterek

Válaszok

createDraftForNewExtension(any, string, String, String)

Paraméterek

Válaszok

createExtension(any, string, string)

Paraméterek

Válaszok

createExtensionWithPublisher(any, string, string, string)

Paraméterek

Válaszok

createPublisher(Publisher)

Paraméterek

Válaszok

createQuestion(Question, string, string)

Paraméterek

Válaszok

createResponse(Response, string, string, number)

Paraméterek

Válaszok

createReview(Review, string, string)

Paraméterek

Válaszok

createSupportRequest(CustomerSupportRequest)

Paraméterek

Válaszok

deleteExtension(string, string, string)

Paraméterek

Válaszok

deleteExtensionById(string, string)

Paraméterek

Válaszok

deletePublisher(string)

Paraméterek

Válaszok

deletePublisherAsset(string, string)

Paraméterek

Válaszok

deleteQuestion(string, string, number)

Paraméterek

Válaszok

deleteResponse(string, string, number, number)

Paraméterek

Válaszok

deleteReview(string, string, number)

Paraméterek

Válaszok

extensionValidator(AzureRestApiRequestModel)

Paraméterek

Válaszok

fetchDomainToken(string)

Paraméterek

Válaszok

generateKey(string, number)

Paraméterek