GalleryRestClient class

Paket:: azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends: RestClientBase

Konstruktoren

GalleryRestClient(IVssRestClientOptions)

Eigenschaften

Methoden

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)	Erstellt eine neue Frage für eine Erweiterung.
createResponse(Response, string, string, number)	Erstellt eine neue Antwort für eine bestimmte Frage für eine Erweiterung.
createReview(Review, string, string)	Erstellt eine neue Überprüfung für eine Erweiterung
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Herausgeberobjekt wie Logo löschen
deleteQuestion(string, string, number)	Löscht eine vorhandene Frage und alle zugehörigen Antworten für eine Erweiterung. (vorläufiges Löschen)
deleteResponse(string, string, number, number)	Löscht eine Antwort für eine Erweiterung. (vorläufiges Löschen)
deleteReview(string, string, number)	Löscht eine Rezension.
extensionValidator(AzureRestApiRequestModel)	Rest-Endpunkt, um zu überprüfen, ob ein Azure-Herausgeber eine Erweiterung für das 3-Drittanbieter-Commerce-Szenario besitzt. Azure unterstützt nur POST-Vorgänge, und die oben genannte Signatur ist nicht typisch für rest-Vorgänge. 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)	Diese Routen-/Standort-ID unterstützt http POST nur anonym, sodass die Tägliche Seitenansicht vom Marketplace-Client erhöht werden kann. Der Versuch, GET auf dieser Route aufzurufen, sollte zu einer Ausnahme führen. Ohne diese explizite Implementierung ruft das Aufrufen von GET auf dieser öffentlichen Route die oben genannte GET-Implementierung GetExtensionDailyStats auf.
getExtensionEvents(string, string, number, Date, string, string)	Abrufen von Installations-/Deinstallationsereignissen einer Erweiterung. Wenn sowohl die Parameter "Count" als auch "afterDate" angegeben werden, hat die Anzahl Vorrang.
getExtensionReports(string, string, number, number, Date)	Gibt Erweiterungsberichte zurück.
getGalleryUserSettings(string, string)	Abrufen aller Einstellungseinträge für den angegebenen Benutzer/alle Benutzerbereich
getPackage(string, string, string, string, boolean, String)	Dieser Endpunkt wird erreicht, wenn Sie eine VSTS-Erweiterung aus der Web-Benutzeroberfläche herunterladen.
getPublisher(string, number)
getPublisherAsset(string, string)	Abrufen von Herausgeberobjekten wie Logo als Stream
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Gibt eine Liste von Fragen mit ihren Antworten zurück, die einer Erweiterung zugeordnet sind.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Gibt eine Liste der Rezensionen zurück, die einer Erweiterung zugeordnet sind.
getReviewsSummary(string, string, Date, Date)	Gibt eine Zusammenfassung der Rezensionen zurück.
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
getVSCodeExtensionLatestVersion(string, string)	Endpunkt zum Abrufen der neuesten Version(en) einer VS Code-Erweiterung.
incrementExtensionDailyStat(string, string, string, string, string)	Erhöht eine tägliche Statistik, die der Erweiterung zugeordnet ist
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	API-Endpunkt zum Veröffentlichen von Installations-/Deinstallationsereignissen der Erweiterung. Dies soll von EMS nur zum Senden von Daten im Zusammenhang mit der Installation/Deinstallation einer Erweiterung aufgerufen werden.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Kennzeichnet ein Problem mit einer bestehenden Frage für eine Erweiterung.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Benachrichtigung senden
setGalleryUserSettings({[key: string]: any}, string)	Festlegen aller Einstellungseinträge für den angegebenen Benutzer/alle Benutzerbereich
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-Endpunkt zum Aktualisieren einer Erweiterung.
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)	Aktualisieren Sie die Herausgeberressource wie das Logo. Die Objektdatei wird als Oktettdatenstrom akzeptiert, und der Dateiname wird in Headerwerten übergeben.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Endpunkt zum Hinzufügen/Ändern der Herausgebermitgliedschaft. Unterstützt derzeit nur das Hinzufügen/Ändern von 1 Benutzern gleichzeitig funktioniert nur für das Hinzufügen von Mitgliedern desselben Mandanten.
updateQuestion(Question, string, string, number)	Aktualisiert eine vorhandene Frage für eine Erweiterung.
updateResponse(Response, string, string, number, number)	Aktualisiert eine vorhandene Antwort für eine bestimmte Frage für eine Erweiterung.
updateReview(ReviewPatch, string, string, number)	Aktualisiert oder kennzeichnet eine Rezension
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Details zum Konstruktor

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

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

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

Parameter

content: string

Hochzuladende Inhalte

publisherName: string

extensionName: string

draftId: string

assetType: string

Gibt zurück

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parameter

content: string

Hochzuladende Inhalte

publisherName: string

draftId: string

assetType: string

Gibt zurück

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parameter

publisherName: string

azurePublisherId: string

Gibt zurück

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parameter

category: ExtensionCategory

Gibt zurück

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parameter

publisherName: string

extensionName: string

Gibt zurück

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parameter

content: any

Hochzuladende Inhalte

publisherName: string

product: String

Header zum Übergeben des Produkttyps der Nutzlastdatei

fileName: String

Kopfzeile, um den Dateinamen der hochgeladenen Daten zu übergeben

Gibt zurück

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parameter

content: any

Hochzuladende Inhalte

extensionType: string

reCaptchaToken: string

Gibt zurück

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parameter

content: any

Hochzuladende Inhalte

publisherName: string

extensionType: string

reCaptchaToken: string

Gibt zurück

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parameter

publisher: Publisher

Gibt zurück

Promise<Publisher>

createQuestion(Question, string, string)

Erstellt eine neue Frage für eine Erweiterung.

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

Parameter

question: Question

Frage, die für die Erweiterung erstellt werden soll.

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

Gibt zurück

Promise<Question>

createResponse(Response, string, string, number)

Erstellt eine neue Antwort für eine bestimmte Frage für eine Erweiterung.

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

Parameter

response: Response

Antwort, die für die Erweiterung erstellt werden soll.

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

questionId: number

Bezeichner der Frage, für welche Antwort für die Erweiterung erstellt werden soll.

Gibt zurück

Promise<Response>

createReview(Review, string, string)

Erstellt eine neue Überprüfung für eine Erweiterung

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

Parameter

review: Review

Überprüfen, die für die Erweiterung erstellt werden soll

pubName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extName: string

Name der Erweiterung

Gibt zurück

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parameter

customerSupportRequest: CustomerSupportRequest

Gibt zurück

Promise<void>

deleteExtension(string, string, string)

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

Parameter

publisherName: string

extensionName: string

version: string

Gibt zurück

Promise<void>

deleteExtensionById(string, string)

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

Parameter

extensionId: string

version: string

Gibt zurück

Promise<void>

deletePublisher(string)

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

Parameter

publisherName: string

Gibt zurück

Promise<void>

deletePublisherAsset(string, string)

Herausgeberobjekt wie Logo löschen

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

Parameter

publisherName: string

Interner Name des Herausgebers

assetType: string

Typ der Ressource. Der Standardwert ist "logo".

Gibt zurück

Promise<void>

deleteQuestion(string, string, number)

Löscht eine vorhandene Frage und alle zugehörigen Antworten für eine Erweiterung. (vorläufiges Löschen)

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

Parameter

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

questionId: number

Bezeichner der Frage, die für die Erweiterung gelöscht werden soll.

Gibt zurück

Promise<void>

deleteResponse(string, string, number, number)

Löscht eine Antwort für eine Erweiterung. (vorläufiges Löschen)

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

Parameter

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

questionId: number

Gibt die Frage an, deren Antwort gelöscht werden soll.

responseId: number

Gibt die zu löschende Antwort an.

Gibt zurück

Promise<void>

deleteReview(string, string, number)

Löscht eine Rezension.

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

Parameter

pubName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extName: string

Name der Erweiterung

reviewId: number

ID der Überprüfung, die aktualisiert werden muss

Gibt zurück

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Rest-Endpunkt, um zu überprüfen, ob ein Azure-Herausgeber eine Erweiterung für das 3-Drittanbieter-Commerce-Szenario besitzt. Azure unterstützt nur POST-Vorgänge, und die oben genannte Signatur ist nicht typisch für rest-Vorgänge. 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

Alle Parameter werden im Anforderungstext gesendet.

Gibt zurück

Promise<void>

fetchDomainToken(string)

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

Parameter

publisherName: string

Gibt zurück

Promise<string>

generateKey(string, number)

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

Parameter

keyType: string

expireCurrentSeconds: number

Gibt zurück

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

Gibt zurück

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>

Parameter

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Header zum Übergeben des Kontotokens

Gibt zurück

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 zum Übergeben des Kontotokens

Gibt zurück

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 zum Übergeben des Kontotokens

Gibt zurück

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

Gibt zurück

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parameter

publisherName: string

draftId: string

assetType: string

Gibt zurück

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 zum Übergeben des Kontotokens

Gibt zurück

Promise<ArrayBuffer>

getCategories(string)

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

Parameter

languages: string

Gibt zurück

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parameter

categoryName: string

languages: string

product: string

Gibt zurück

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

Gibt zurück

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parameter

publisherName: string

extensionName: string

version: string

Gibt zurück

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

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Header zum Übergeben des Kontotokens

Gibt zurück

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parameter

extensionId: string

version: string

flags: ExtensionQueryFlags

Gibt zurück

Promise<PublishedExtension>

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

Gibt zurück

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Diese Routen-/Standort-ID unterstützt http POST nur anonym, sodass die Tägliche Seitenansicht vom Marketplace-Client erhöht werden kann. Der Versuch, GET auf dieser Route aufzurufen, sollte zu einer Ausnahme führen. Ohne diese explizite Implementierung ruft das Aufrufen von GET auf dieser öffentlichen Route die oben genannte GET-Implementierung GetExtensionDailyStats auf.

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

Parameter

publisherName: string

Name des Herausgebers

extensionName: string

Name der Erweiterung

version: string

Version der Erweiterung

Gibt zurück

Promise<ExtensionDailyStats>

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

Abrufen von Installations-/Deinstallationsereignissen einer Erweiterung. Wenn sowohl die Parameter "Count" als auch "afterDate" angegeben werden, hat die Anzahl Vorrang.

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

Parameter

publisherName: string

Name des Herausgebers

extensionName: string

Name der Erweiterung

count: number

Die Anzahl der abzurufenden Ereignisse gilt für jeden Ereignistyp.

afterDate: Date

Abrufen von Ereignissen, die an oder nach diesem Datum aufgetreten sind

include: string

Filteroptionen. Unterstützte Werte: Installieren, Deinstallieren, Überprüfen, Erwerb, Vertrieb. Standardmäßig werden alle Ereignistypen abgerufen.

includeProperty: string

Einzuschließende Ereigniseigenschaften. Derzeit wird nur "lastContactDetails" für Deinstallationsereignisse unterstützt.

Gibt zurück

Promise<ExtensionEvents>

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

Gibt Erweiterungsberichte zurück.

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

Parameter

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extensionName: string

Name der Erweiterung

days: number

Bericht über letzte n Tage. Wenn "AfterDate" und "Days" angegeben sind, werden Tage prioritätsstufe

count: number

Anzahl der ereignisse, die zurückgegeben werden sollen

afterDate: Date

Verwenden Sie diese Vorgehensweise, wenn Ereignisse neuer als das angegebene Datum abgerufen werden sollen.

Gibt zurück

Promise<any>

getGalleryUserSettings(string, string)

Abrufen aller Einstellungseinträge für den angegebenen Benutzer/alle Benutzerbereich

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

Parameter

userScope: string

User-Scope, bei dem der Wert abgerufen werden soll. Sollte für den aktuellen Benutzer oder "Host" für alle Benutzer "ich" sein.

key: string

Optionaler Schlüssel, unter dem alle Einträge gefiltert werden sollen

Gibt zurück

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

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

Dieser Endpunkt wird erreicht, wenn Sie eine VSTS-Erweiterung aus der Web-Benutzeroberfläche herunterladen.

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 zum Übergeben des Kontotokens

Gibt zurück

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parameter

publisherName: string

flags: number

Gibt zurück

Promise<Publisher>

getPublisherAsset(string, string)

Abrufen von Herausgeberobjekten wie Logo als Stream

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

Parameter

publisherName: string

Interner Name des Herausgebers

assetType: string

Typ der Ressource. Der Standardwert ist "logo".

Gibt zurück

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parameter

publisherName: string

Gibt zurück

Promise<Publisher>

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

Gibt eine Liste von Fragen mit ihren Antworten zurück, die einer Erweiterung zugeordnet sind.

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

Parameter

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

count: number

Anzahl der abzurufenden Fragen (Standardwert 10).

page: number

Seitenzahl, aus der eine Reihe von Fragen abgerufen werden soll.

afterDate: Date

Wenn angegeben, werden Ergebnisfragen zurückgegeben, die nach diesem Datum veröffentlicht wurden

Gibt zurück

Promise<QuestionsResult>

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

Gibt eine Liste der Rezensionen zurück, die einer Erweiterung zugeordnet sind.

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

Parameter

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extensionName: string

Name der Erweiterung

count: number

Anzahl der abzurufenden Rezensionen (Standardwert 5)

filterOptions: ReviewFilterOptions

FilterOptions, um leere Rezensionen usw. herauszufiltern, standardmäßig keine

beforeDate: Date

Verwenden Sie diese Vorgehensweise, wenn Sie Rezensionen abrufen möchten, die älter als das angegebene Datum sind, standardmäßig null

afterDate: Date

Verwenden Sie diesen Wert, wenn Sie Rezensionen neuer als das angegebene Datum abrufen möchten. Standardwert ist null.

Gibt zurück

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Gibt eine Zusammenfassung der Rezensionen zurück.

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

Parameter

pubName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extName: string

Name der Erweiterung

beforeDate: Date

Verwenden Sie diese Vorgehensweise, wenn Sie eine Zusammenfassung der Rezensionen abrufen möchten, die älter als das angegebene Datum sind, standardmäßig null

afterDate: Date

Wird verwendet, wenn Sie eine Zusammenfassung der Rezensionen abrufen möchten, die neuer als das angegebene Datum sind, wird standardmäßig auf NULL festgelegt.

Gibt zurück

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

Gibt zurück

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parameter

keyType: string

Gibt zurück

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

Gibt zurück

Promise<ArrayBuffer>

getVSCodeExtensionLatestVersion(string, string)

Endpunkt zum Abrufen der neuesten Version(en) einer VS Code-Erweiterung.

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

Parameter

publisherName: string

Der Name des Herausgebers der angeforderten VS Code-Erweiterung.

extensionName: string

Der Erweiterungsname.

Gibt zurück

Promise<PublishedExtension>

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

Erhöht eine tägliche Statistik, die der Erweiterung zugeordnet ist

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

Parameter

publisherName: string

Name des Herausgebers

extensionName: string

Name der Erweiterung

version: string

Version der Erweiterung

statType: string

Typ des zu erhöhenden Status

targetPlatform: string

Gibt zurück

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

Gibt zurück

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parameter

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Gibt zurück

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

API-Endpunkt zum Veröffentlichen von Installations-/Deinstallationsereignissen der Erweiterung. Dies soll von EMS nur zum Senden von Daten im Zusammenhang mit der Installation/Deinstallation einer Erweiterung aufgerufen werden.

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

Parameter

extensionEvents: ExtensionEvents[]

Gibt zurück

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

Hochzuladende Inhalte

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Gibt zurück

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parameter

publisherName: string

Gibt zurück

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parameter

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Header zum Übergeben des Kontotokens

Gibt zurück

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parameter

publisherQuery: PublisherQuery

Gibt zurück

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Kennzeichnet ein Problem mit einer bestehenden Frage für eine Erweiterung.

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

Parameter

concern: Concern

Der Benutzer meldete Bedenken bezüglich einer Frage für die Erweiterung.

pubName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extName: string

Name der Erweiterung.

questionId: number

Bezeichner der Frage, die für die Erweiterung aktualisiert werden soll.

Gibt zurück

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parameter

acquisitionRequest: ExtensionAcquisitionRequest

Gibt zurück

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Benachrichtigung senden

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

Parameter

notificationData: NotificationsData

Kennzeichnen der daten, die zum Senden von Benachrichtigungen erforderlich sind

Gibt zurück

Promise<void>

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

Festlegen aller Einstellungseinträge für den angegebenen Benutzer/alle Benutzerbereich

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

Parameter

entries: {[key: string]: any}

Ein Schlüssel-Wert-Paar aller Einstellungen, die festgelegt werden müssen

userScope: string

User-Scope, bei dem der Wert abgerufen werden soll. Sollte für den aktuellen Benutzer oder "Host" für alle Benutzer "ich" sein.

Gibt zurück

Promise<void>

shareExtension(string, string, string)

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

Parameter

publisherName: string

extensionName: string

accountName: string

Gibt zurück

Promise<void>

shareExtensionById(string, string)

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

Parameter

extensionId: string

accountName: string

Gibt zurück

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

Gibt zurück

Promise<void>

unshareExtension(string, string, string)

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

Parameter

publisherName: string

extensionName: string

accountName: string

Gibt zurück

Promise<void>

unshareExtensionById(string, string)

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

Parameter

extensionId: string

accountName: string

Gibt zurück

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

Gibt zurück

Promise<void>

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

REST-Endpunkt zum Aktualisieren einer Erweiterung.

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

Parameter

content: any

Hochzuladende Inhalte

publisherName: string

Name des Herausgebers

extensionName: string

Name der Erweiterung

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Dieser Parameter entscheidet, ob die Bereichsänderungsprüfung aufgerufen werden muss oder nicht.

Gibt zurück

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parameter

extensionId: string

reCaptchaToken: string

Gibt zurück

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parameter

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Gibt zurück

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parameter

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Gibt zurück

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

Hochzuladende Inhalte

publisherName: string

extensionName: string

draftId: string

fileName: String

Kopfzeile, um den Dateinamen der hochgeladenen Daten zu übergeben

Gibt zurück

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parameter

content: any

Hochzuladende Inhalte

publisherName: string

draftId: string

fileName: String

Kopfzeile, um den Dateinamen der hochgeladenen Daten zu übergeben

Gibt zurück

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parameter

publisher: Publisher

publisherName: string

Gibt zurück

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Aktualisieren Sie die Herausgeberressource wie das Logo. Die Objektdatei wird als Oktettdatenstrom akzeptiert, und der Dateiname wird in Headerwerten übergeben.

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

Parameter

content: any

Hochzuladende Inhalte

publisherName: string

Interner Name des Herausgebers

assetType: string

Typ der Ressource. Der Standardwert ist "logo".

fileName: String

Kopfzeile, um den Dateinamen der hochgeladenen Daten zu übergeben

Gibt zurück

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Endpunkt zum Hinzufügen/Ändern der Herausgebermitgliedschaft. Unterstützt derzeit nur das Hinzufügen/Ändern von 1 Benutzern gleichzeitig funktioniert nur für das Hinzufügen von Mitgliedern desselben Mandanten.

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

Parameter

roleAssignments: PublisherUserRoleAssignmentRef[]

Liste der hinzuzufügenden Benutzer-IDs(E-Mail-Adresse) und Rolle. Derzeit wird nur ein Eintrag unterstützt.

publisherName: string

Der Name/die ID des Herausgebers, dem Benutzer hinzugefügt werden müssen

limitToCallerIdentityDomain: boolean

Sollten mandantenübergreifende Addtionen zulässig sein oder nicht.

Gibt zurück

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Aktualisiert eine vorhandene Frage für eine Erweiterung.

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

Parameter

question: Question

Aktualisierte Frage, die für die Erweiterung festgelegt werden soll.

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

questionId: number

Bezeichner der Frage, die für die Erweiterung aktualisiert werden soll.

Gibt zurück

Promise<Question>

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

Aktualisiert eine vorhandene Antwort für eine bestimmte Frage für eine Erweiterung.

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

Parameter

response: Response

Aktualisierte Antwort, die für die Erweiterung festgelegt werden soll.

publisherName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat.

extensionName: string

Name der Erweiterung.

questionId: number

Bezeichner der Frage, für welche Antwort für die Erweiterung aktualisiert werden soll.

responseId: number

Bezeichner der Antwort, die aktualisiert werden muss.

Gibt zurück

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Aktualisiert oder kennzeichnet eine Rezension

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

Parameter

reviewPatch: ReviewPatch

ReviewPatch-Objekt, das die Änderungen enthält, die auf die Überprüfung angewendet werden sollen

pubName: string

Name des Herausgebers, der die Erweiterung veröffentlicht hat

extName: string

Name der Erweiterung

reviewId: number

ID der Überprüfung, die aktualisiert werden muss

Gibt zurück

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parameter

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Gibt zurück

Promise<void>

verifyDomainToken(string)

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

Parameter

publisherName: string

Gibt zurück

Promise<void>

Feedback

War diese Seite hilfreich?

Freigeben über

GalleryRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

GalleryRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

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

Parameter

Gibt zurück

addAssetForNewExtensionDraft(string, string, string, string)

Parameter

Gibt zurück

associateAzurePublisher(string, string)

Parameter

Gibt zurück

createCategory(ExtensionCategory)

Parameter

Gibt zurück

createDraftForEditExtension(string, string)

Parameter

Gibt zurück

createDraftForNewExtension(any, string, String, String)

Parameter

Gibt zurück

createExtension(any, string, string)

Parameter

Gibt zurück

createExtensionWithPublisher(any, string, string, string)

Parameter

Gibt zurück

createPublisher(Publisher)

Parameter

Gibt zurück

createQuestion(Question, string, string)

Parameter

Gibt zurück

createResponse(Response, string, string, number)

Parameter

Gibt zurück

createReview(Review, string, string)

Parameter

Gibt zurück

createSupportRequest(CustomerSupportRequest)

Parameter

Gibt zurück

deleteExtension(string, string, string)

Parameter

Gibt zurück

deleteExtensionById(string, string)

Parameter

Gibt zurück

deletePublisher(string)

Parameter

Gibt zurück

deletePublisherAsset(string, string)

Parameter

Gibt zurück

deleteQuestion(string, string, number)

Parameter

Gibt zurück

deleteResponse(string, string, number, number)

Parameter

Gibt zurück

deleteReview(string, string, number)

Parameter

Gibt zurück

extensionValidator(AzureRestApiRequestModel)

Parameter

Gibt zurück

fetchDomainToken(string)

Parameter

Gibt zurück

generateKey(string, number)

Parameter