GalleryRestClient class
Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).
- Extends
Konstruktoren
Gallery |
Eigenschaften
RESOURCE_AREA_ID |
Methoden
Details zum Konstruktor
GalleryRestClient(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
Header zum Übergeben des Dateinamens der hochgeladenen Daten
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 die die 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üfung, die für die Erweiterung erstellt werden soll
- pubName
-
string
Name des Herausgebers, der die Erweiterung veröffentlicht hat
- extName
-
string
Der 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)
Löschen eines Verlegerobjekts wie das Logo
function deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>
Parameter
- publisherName
-
string
Interner Name des Herausgebers
- assetType
-
string
Art des Medienobjekts. 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 Überprüfung.
function deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>
Parameter
- pubName
-
string
Name des Herausgebers, der die Erweiterung veröffentlicht hat
- extName
-
string
Der Name der Erweiterung
- reviewId
-
number
ID der Überprüfung, die aktualisiert werden muss
Gibt zurück
Promise<void>
extensionValidator(AzureRestApiRequestModel)
Restendpunkt, um zu überprüfen, ob ein Azure-Herausgeber eine Erweiterung für das E-Commerce-Szenario eines Drittanbieters besitzt. Azure unterstützt nur POST-Vorgänge, und die obige 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>
getContentVerificationLog(string, string)
function getContentVerificationLog(publisherName: string, extensionName: string): Promise<ArrayBuffer>
Parameter
- publisherName
-
string
- extensionName
-
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 der tägliche Stat der 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 wird beim Aufrufen von GET auf dieser öffentlichen Route die oben genannte GET-Implementierung GetExtensionDailyStats aufgerufen.
function getExtensionDailyStatsAnonymous(publisherName: string, extensionName: string, version: string): Promise<ExtensionDailyStats>
Parameter
- publisherName
-
string
Name des Herausgebers
- extensionName
-
string
Der 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 sind, hat count 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
Der 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
Der Name der Erweiterung
- days
-
number
Bericht der letzten n Tage. Wenn afterDate und days angegeben sind, haben Tage Priorität.
- count
-
number
Anzahl der zurückzugebenden Ereignisse
- afterDate
-
Date
Verwenden Sie , wenn Sie Ereignisse abrufen möchten, die neuer als das angegebene Datum sind.
Gibt zurück
Promise<any>
getGalleryUserSettings(string, string)
Abrufen aller Einstellungseinträge für den angegebenen Benutzer-/Alle-Benutzer-Bereich
function getGalleryUserSettings(userScope: string, key?: string): Promise<{[key: string]: any}>
Parameter
- userScope
-
string
User-Scope, an der der Wert abgerufen werden soll. Sollte "ich" für den aktuellen Benutzer oder "Host" für alle Benutzer 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 getroffen, wenn Sie eine VSTS-Erweiterung von 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 eines Herausgeberobjekts wie logo als Stream
function getPublisherAsset(publisherName: string, assetType?: string): Promise<ArrayBuffer>
Parameter
- publisherName
-
string
Interner Name des Herausgebers
- assetType
-
string
Art des Medienobjekts. 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 der Satz von Fragen abgerufen werden soll.
- afterDate
-
Date
Wenn angegeben, werden Ergebnisfragen zurückgegeben, die nach diesem Datum gepostet wurden.
Gibt zurück
Promise<QuestionsResult>
getReviews(string, string, number, ReviewFilterOptions, Date, Date)
Gibt eine Liste von Überprüfungen 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
Der Name der Erweiterung
- count
-
number
Anzahl der abzurufenden Überprüfungen (Standardwert: 5)
- filterOptions
- ReviewFilterOptions
FilterOptions zum Herausfiltern leerer Rezensionen usw.
- beforeDate
-
Date
Verwenden Sie , wenn Sie Überprüfungen abrufen möchten, die älter als das angegebene Datum sind, standardmäßig NULL.
- afterDate
-
Date
Verwenden Sie , wenn Sie Überprüfungen abrufen möchten, die neuer als das angegebene Datum sind, standardmäßig NULL.
Gibt zurück
Promise<ReviewsResult>
getReviewsSummary(string, string, Date, Date)
Gibt eine Zusammenfassung der Überprüfungen 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
Der Name der Erweiterung
- beforeDate
-
Date
Verwenden Sie , wenn Sie eine Zusammenfassung von Überprüfungen abrufen möchten, die älter als das angegebene Datum sind, und standardmäßig NULL ist.
- afterDate
-
Date
Verwenden Sie , wenn Sie eine Zusammenfassung der Überprüfungen abrufen möchten, die neuer als das angegebene Datum sind, standardmäßig NULL.
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>
incrementExtensionDailyStat(string, string, string, string, string)
Inkrementiert 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
Der Name der Erweiterung
- version
-
string
Version der Erweiterung
- statType
-
string
Typ des zu inkrementierenden Stats
- 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 aufgerufen werden, um uns Daten im Zusammenhang mit der Installation/Deinstallation einer Erweiterung zu senden.
function publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>
Parameter
- 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 vorhandenen 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)
Senden einer Benachrichtigung
function sendNotifications(notificationData: NotificationsData): Promise<void>
Parameter
- notificationData
- NotificationsData
Bezeichnen der daten, die zum Senden einer Benachrichtigung erforderlich sind
Gibt zurück
Promise<void>
setGalleryUserSettings({[key: string]: any}, string)
Festlegen aller Einstellungseinträge für den angegebenen Benutzer-/Alle-Benutzer-Bereich
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, an der der Wert abgerufen werden soll. Sollte "ich" für den aktuellen Benutzer oder "Host" für alle Benutzer 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
Der Name der Erweiterung
- extensionType
-
string
- reCaptchaToken
-
string
- bypassScopeCheck
-
boolean
Dieser Parameter entscheidet, ob die Überprüfung der Bereichsänderung 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
Header zum Übergeben des Dateinamens der hochgeladenen Daten
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
Header zum Übergeben des Dateinamens der hochgeladenen Daten
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 das Herausgeberobjekt 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
Art des Medienobjekts. Der Standardwert ist "logo".
- fileName
-
String
Header zum Übergeben des Dateinamens der hochgeladenen Daten
Gibt zurück
Promise<{[key: string]: string}>
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)
Endpunkt zum Hinzufügen/Ändern der Verlegermitgliedschaft. Derzeit Unterstützt nur das Hinzufügen/Ändern von 1 Benutzer gleichzeitig Funktioniert nur für das Hinzufügen von Mitgliedern desselben Mandanten.
function updatePublisherMembers(roleAssignments: PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<PublisherRoleAssignment[]>
Parameter
- roleAssignments
Liste der hinzuzufügenden Benutzerbezeichner (E-Mail-Adresse) und Rolle. Derzeit wird nur ein Eintrag unterstützt.
- publisherName
-
string
Name/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)
Updates 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)
Updates eine vorhandene Antwort auf eine bestimmte Frage für eine Erweiterung.
function updateResponse(response: Response, publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<Response>
Parameter
- response
- Response
Die Antwort wurde aktualisiert, 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 die die 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)
Updates oder Kennzeichnen einer Bewertung
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
Der 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>