GalleryRestClient class

Reference

Balíček:: azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends: RestClientBase

Konstruktory

GalleryRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

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)	Vytvoří novou otázku pro rozšíření.
createResponse(Response, string, string, number)	Vytvoří novou odpověď na danou otázku pro rozšíření.
createReview(Review, string, string)	Vytvoří novou revizi rozšíření.
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Odstranění prostředku vydavatele, jako je logo
deleteQuestion(string, string, number)	Odstraní existující otázku a všechny její přidružené odpovědi pro rozšíření. (obnovitelné odstranění)
deleteResponse(string, string, number, number)	Odstraní odpověď na rozšíření. (obnovitelné odstranění)
deleteReview(string, string, number)	Odstraní recenzi.
extensionValidator(AzureRestApiRequestModel)	Koncový bod restu k ověření, jestli vydavatel Azure vlastní rozšíření pro komerční scénář třetí strany. Azure podporuje pouze operace POST a výše uvedený podpis není pro operace REST typický. 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)	Toto ID trasy nebo umístění podporuje http POST jenom anonymně, aby bylo možné zvýšit denní statistiku zobrazení stránky z klienta Marketplace. Při pokusu o volání metody GET na této trase by měla dojít k výjimce. Bez této explicitní implementace volání GET na této veřejné trase vyvolá výše uvedenou implementaci GET GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Získejte události instalace/odinstalace rozšíření. Pokud jsou zadány parametry count i afterDate, má prioritu počet.
getExtensionReports(string, string, number, number, Date)	Vrátí sestavy rozšíření.
getGalleryUserSettings(string, string)	Získání všech položek nastavení pro daný obor uživatel nebo všichni uživatelé
getPackage(string, string, string, string, boolean, String)	K tomuto koncovému bodu dojde, když stáhnete rozšíření VSTS z webového uživatelského rozhraní.
getPublisher(string, number)
getPublisherAsset(string, string)	Získání prostředku vydavatele, jako je logo jako stream
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Vrátí seznam otázek s jejich odpověďmi přidruženými k rozšíření.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Vrátí seznam recenzí přidružených k rozšíření.
getReviewsSummary(string, string, Date, Date)	Vrátí souhrn recenzí.
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	Inkrementuje denní statistiku přidruženou k rozšíření.
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	Koncový bod rozhraní API pro publikování událostí instalace nebo odinstalace rozšíření To má EMS vyvolat pouze pro odesílání dat souvisejících s instalací nebo odinstalací rozšíření.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Označí problém existující otázkou pro rozšíření.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Odeslat oznámení
setGalleryUserSettings({[key: string]: any}, string)	Nastavení všech položek nastavení pro daný obor uživatel/všichni uživatelé
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)	Koncový bod REST pro aktualizaci rozšíření
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)	Aktualizujte asset vydavatele, jako je logo. Přijímá soubor prostředků jako datový proud oktetu a název souboru se předává v hodnotách hlaviček.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Koncový bod pro přidání nebo úpravu členství vydavatele. Aktuálně podporuje pouze přidávání nebo úpravy 1 uživatele najednou Funguje pouze pro přidávání členů stejného tenanta.
updateQuestion(Question, string, string, number)	Aktualizace existující otázku pro rozšíření.
updateResponse(Response, string, string, number, number)	Aktualizace existující odpověď na danou otázku pro rozšíření.
updateReview(ReviewPatch, string, string, number)	Aktualizace nebo označí recenzi příznakem
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Podrobnosti konstruktoru

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

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

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

Parametry

content: string

Obsah k nahrání

publisherName: string

extensionName: string

draftId: string

assetType: string

Návraty

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parametry

content: string

Obsah k nahrání

publisherName: string

draftId: string

assetType: string

Návraty

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parametry

publisherName: string

azurePublisherId: string

Návraty

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parametry

category: ExtensionCategory

Návraty

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parametry

publisherName: string

extensionName: string

Návraty

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parametry

content: any

Obsah k nahrání

publisherName: string

product: String

Hlavička pro předání typu produktu souboru datové části

fileName: String

Hlavička pro předání názvu souboru odeslaných dat

Návraty

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parametry

content: any

Obsah k nahrání

extensionType: string

reCaptchaToken: string

Návraty

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parametry

content: any

Obsah k nahrání

publisherName: string

extensionType: string

reCaptchaToken: string

Návraty

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parametry

publisher: Publisher

Návraty

Promise<Publisher>

createQuestion(Question, string, string)

Vytvoří novou otázku pro rozšíření.

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

Parametry

question: Question

Otázka, která se má vytvořit pro rozšíření

publisherName: string

Název vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření

Návraty

Promise<Question>

createResponse(Response, string, string, number)

Vytvoří novou odpověď na danou otázku pro rozšíření.

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

Parametry

response: Response

Odpověď, která se má pro rozšíření vytvořit.

publisherName: string

Název vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření

questionId: number

Identifikátor otázky, na kterou se má pro rozšíření vytvořit odpověď.

Návraty

Promise<Response>

createReview(Review, string, string)

Vytvoří novou revizi rozšíření.

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

Parametry

review: Review

Kontrola vytvoření pro rozšíření

pubName: string

Název vydavatele, který rozšíření publikoval

extName: string

Název rozšíření

Návraty

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parametry

customerSupportRequest: CustomerSupportRequest

Návraty

Promise<void>

deleteExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

Návraty

Promise<void>

deleteExtensionById(string, string)

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

Parametry

extensionId: string

version: string

Návraty

Promise<void>

deletePublisher(string)

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

Parametry

publisherName: string

Návraty

Promise<void>

deletePublisherAsset(string, string)

Odstranění prostředku vydavatele, jako je logo

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

Parametry

publisherName: string

Interní název vydavatele

assetType: string

Typ prostředku. Výchozí hodnota je logo.

Návraty

Promise<void>

deleteQuestion(string, string, number)

Odstraní existující otázku a všechny její přidružené odpovědi pro rozšíření. (obnovitelné odstranění)

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

Parametry

publisherName: string

Jméno vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření.

questionId: number

Identifikátor otázky, která má být odstraněna pro rozšíření.

Návraty

Promise<void>

deleteResponse(string, string, number, number)

Odstraní odpověď na rozšíření. (obnovitelné odstranění)

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

Parametry

publisherName: string

Jméno vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření.

questionId: number

Určuje otázku, jejíž odpověď má být odstraněna.

responseId: number

Identifikuje odpověď, která se má odstranit.

Návraty

Promise<void>

deleteReview(string, string, number)

Odstraní recenzi.

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

Parametry

pubName: string

Jméno vydavatele, který rozšíření publikoval

extName: string

Název rozšíření

reviewId: number

ID revize, kterou je potřeba aktualizovat

Návraty

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Koncový bod restu k ověření, jestli vydavatel Azure vlastní rozšíření pro komerční scénář třetí strany. Azure podporuje pouze operace POST a výše uvedený podpis není pro operace REST typický. 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>

Parametry

azureRestApiRequestModel: AzureRestApiRequestModel

Všechny parametry se odesílají v textu požadavku.

Návraty

Promise<void>

fetchDomainToken(string)

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

Parametry

publisherName: string

Návraty

Promise<string>

generateKey(string, number)

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

Parametry

keyType: string

expireCurrentSeconds: number

Návraty

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parametry

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Návraty

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>

Parametry

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parametry

publisherName: string

draftId: string

assetType: string

extensionName: string

Návraty

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parametry

publisherName: string

draftId: string

assetType: string

Návraty

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

Promise<ArrayBuffer>

getCategories(string)

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

Parametry

languages: string

Návraty

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parametry

categoryName: string

languages: string

product: string

Návraty

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>

Parametry

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Návraty

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

Návraty

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parametry

publisherName: string

extensionName: string

Návraty

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>

Parametry

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parametry

extensionId: string

version: string

flags: ExtensionQueryFlags

Návraty

Promise<PublishedExtension>

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

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

Parametry

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Návraty

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Toto ID trasy nebo umístění podporuje http POST jenom anonymně, aby bylo možné zvýšit denní statistiku zobrazení stránky z klienta Marketplace. Při pokusu o volání metody GET na této trase by měla dojít k výjimce. Bez této explicitní implementace volání GET na této veřejné trase vyvolá výše uvedenou implementaci GET GetExtensionDailyStats.

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

Parametry

publisherName: string

Název vydavatele

extensionName: string

Název rozšíření

version: string

Verze rozšíření

Návraty

Promise<ExtensionDailyStats>

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

Získejte události instalace/odinstalace rozšíření. Pokud jsou zadány parametry count i afterDate, má prioritu počet.

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

Parametry

publisherName: string

Název vydavatele

extensionName: string

Název rozšíření

count: number

Počet událostí, které se mají načíst, platí pro každý typ události.

afterDate: Date

Načtení událostí, ke kterým došlo k tomuto datu nebo později

include: string

Možnosti filtrování. Podporované hodnoty: instalace, odinstalace, kontrola, akvizice, prodej. Výchozí je načíst všechny typy událostí.

includeProperty: string

Vlastnosti události, které se mají zahrnout. V současné době se pro události odinstalace podporuje pouze lastContactDetails.

Návraty

Promise<ExtensionEvents>

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

Vrátí sestavy rozšíření.

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

Parametry

publisherName: string

Jméno vydavatele, který rozšíření publikoval

extensionName: string

Název rozšíření

days: number

Sestava za posledních n dnů. Pokud je zadáno afterDate a days, budou mít prioritu dny.

count: number

Počet událostí, které se mají vrátit

afterDate: Date

Použijte, pokud chcete načíst události novější než zadané datum.

Návraty

Promise<any>

getGalleryUserSettings(string, string)

Získání všech položek nastavení pro daný obor uživatel nebo všichni uživatelé

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

Parametry

userScope: string

User-Scope, pro kterou chcete hodnotu získat. Mělo by to být "já" pro aktuálního uživatele nebo "hostitel" pro všechny uživatele.

key: string

Volitelný klíč, pod kterým se mají filtrovat všechny položky

Návraty

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

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

K tomuto koncovému bodu dojde, když stáhnete rozšíření VSTS z webového uživatelského rozhraní.

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

Parametry

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parametry

publisherName: string

flags: number

Návraty

Promise<Publisher>

getPublisherAsset(string, string)

Získání prostředku vydavatele, jako je logo jako stream

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

Parametry

publisherName: string

Interní název vydavatele

assetType: string

Typ prostředku. Výchozí hodnota je logo.

Návraty

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parametry

publisherName: string

Návraty

Promise<Publisher>

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

Vrátí seznam otázek s jejich odpověďmi přidruženými k rozšíření.

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

Parametry

publisherName: string

Jméno vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření.

count: number

Počet otázek, které se mají načíst (výchozí hodnota je 10)

page: number

Číslo stránky, ze které se má načíst sada otázek.

afterDate: Date

Pokud jsou zadané, vrátí se dotazy k výsledkům, které byly zveřejněny po tomto datu.

Návraty

Promise<QuestionsResult>

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

Vrátí seznam recenzí přidružených k rozšíření.

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

Parametry

publisherName: string

Jméno vydavatele, který rozšíření publikoval

extensionName: string

Název rozšíření

count: number

Počet recenzí, které se mají načíst (výchozí hodnota je 5)

filterOptions: ReviewFilterOptions

FilterOptions to filter out empty reviews etcetera, defaults to none

beforeDate: Date

Použijte, pokud chcete načíst recenze starší než zadané datum, výchozí hodnota je null.

afterDate: Date

Použijte, pokud chcete načíst recenze novější než zadané datum, výchozí hodnota je null.

Návraty

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Vrátí souhrn recenzí.

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

Parametry

pubName: string

Jméno vydavatele, který rozšíření publikoval

extName: string

Název rozšíření

beforeDate: Date

Použijte, pokud chcete načíst souhrn recenzí starších než zadané datum, výchozí hodnota je null.

afterDate: Date

Použijte, pokud chcete načíst souhrn recenzí novější než zadané datum, výchozí hodnota je null.

Návraty

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>

Parametry

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Návraty

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parametry

keyType: string

Návraty

Promise<string>

getVerificationLog(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

targetPlatform: string

Návraty

Promise<ArrayBuffer>

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

Inkrementuje denní statistiku přidruženou k rozšíření.

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

Parametry

publisherName: string

Název vydavatele

extensionName: string

Název rozšíření

version: string

Verze rozšíření

statType: string

Typ statistiky pro zvýšení

targetPlatform: string

Návraty

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parametry

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Návraty

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parametry

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Návraty

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Koncový bod rozhraní API pro publikování událostí instalace nebo odinstalace rozšíření To má EMS vyvolat pouze pro odesílání dat souvisejících s instalací nebo odinstalací rozšíření.

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

Parametry

extensionEvents: ExtensionEvents[]

Návraty

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>

Parametry

content: any

Obsah k nahrání

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Návraty

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parametry

publisherName: string

Návraty

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parametry

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Hlavička pro předání tokenu účtu

Návraty

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parametry

publisherQuery: PublisherQuery

Návraty

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Označí problém existující otázkou pro rozšíření.

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

Parametry

concern: Concern

Uživatel nahlásil obavu s dotazem na rozšíření.

pubName: string

Jméno vydavatele, který rozšíření publikoval.

extName: string

Název rozšíření.

questionId: number

Identifikátor otázky, která má být aktualizována pro rozšíření.

Návraty

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametry

acquisitionRequest: ExtensionAcquisitionRequest

Návraty

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Odeslat oznámení

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

Parametry

notificationData: NotificationsData

Označení dat potřebných k odeslání oznámení

Návraty

Promise<void>

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

Nastavení všech položek nastavení pro daný obor uživatel/všichni uživatelé

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

Parametry

entries: {[key: string]: any}

Pár klíč-hodnota všech nastavení, která je potřeba nastavit

userScope: string

User-Scope, pro kterou chcete hodnotu získat. Mělo by to být "já" pro aktuálního uživatele nebo "hostitel" pro všechny uživatele.

Návraty

Promise<void>

shareExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

accountName: string

Návraty

Promise<void>

shareExtensionById(string, string)

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

Parametry

extensionId: string

accountName: string

Návraty

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

hostType: string

hostName: string

Návraty

Promise<void>

unshareExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

accountName: string

Návraty

Promise<void>

unshareExtensionById(string, string)

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

Parametry

extensionId: string

accountName: string

Návraty

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

hostType: string

hostName: string

Návraty

Promise<void>

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

Koncový bod REST pro aktualizaci rozšíření

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

Parametry

content: any

Obsah k nahrání

publisherName: string

Název vydavatele

extensionName: string

Název rozšíření

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Tento parametr rozhoduje, jestli je potřeba vyvolat kontrolu změny oboru, nebo ne.

Návraty

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parametry

extensionId: string

reCaptchaToken: string

Návraty

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parametry

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Návraty

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parametry

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Návraty

Promise<void>

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

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

Parametry

content: any

Obsah k nahrání

publisherName: string

extensionName: string

draftId: string

fileName: String

Hlavička pro předání názvu souboru odeslaných dat

Návraty

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parametry

content: any

Obsah k nahrání

publisherName: string

draftId: string

fileName: String

Hlavička pro předání názvu souboru odeslaných dat

Návraty

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parametry

publisher: Publisher

publisherName: string

Návraty

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Aktualizujte asset vydavatele, jako je logo. Přijímá soubor prostředků jako datový proud oktetu a název souboru se předává v hodnotách hlaviček.

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

Parametry

content: any

Obsah k nahrání

publisherName: string

Interní název vydavatele

assetType: string

Typ prostředku. Výchozí hodnota je logo.

fileName: String

Hlavička pro předání názvu souboru odeslaných dat

Návraty

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Koncový bod pro přidání nebo úpravu členství vydavatele. Aktuálně podporuje pouze přidávání nebo úpravy 1 uživatele najednou Funguje pouze pro přidávání členů stejného tenanta.

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

Parametry

roleAssignments: PublisherUserRoleAssignmentRef[]

Seznam identifikátorů uživatelů (e-mailová adresa) a role, které se mají přidat. Aktuálně je podporována pouze jedna položka.

publisherName: string

Název nebo ID vydavatele, ke kterému musí být uživatelé přidáni

limitToCallerIdentityDomain: boolean

Měly by být povolené doplňky mezi tenanty.

Návraty

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Aktualizace existující otázku pro rozšíření.

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

Parametry

question: Question

Aktualizovali jsme otázku, která se má nastavit pro rozšíření.

publisherName: string

Název vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření

questionId: number

Identifikátor otázky, která má být aktualizována pro rozšíření.

Návraty

Promise<Question>

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

Aktualizace existující odpověď na danou otázku pro rozšíření.

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

Parametry

response: Response

Aktualizovaná odpověď, která se má nastavit pro rozšíření.

publisherName: string

Název vydavatele, který rozšíření publikoval.

extensionName: string

Název rozšíření

questionId: number

Identifikátor otázky, na kterou má být aktualizována odpověď pro rozšíření.

responseId: number

Identifikátor odpovědi, kterou je třeba aktualizovat.

Návraty

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Aktualizace nebo označí recenzi příznakem

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

Parametry

reviewPatch: ReviewPatch

Objekt ReviewPatch obsahující změny, které se mají použít u revize

pubName: string

Název vydavatele, který rozšíření publikoval

extName: string

Název rozšíření

reviewId: number

ID kontroly, kterou je potřeba aktualizovat

Návraty

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parametry

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Návraty

Promise<void>

verifyDomainToken(string)

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

Parametry

publisherName: string

Návraty

Promise<void>

Sdílet prostřednictvím

GalleryRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

GalleryRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

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

Parametry

Návraty

addAssetForNewExtensionDraft(string, string, string, string)

Parametry

Návraty

associateAzurePublisher(string, string)

Parametry

Návraty

createCategory(ExtensionCategory)

Parametry

Návraty

createDraftForEditExtension(string, string)

Parametry

Návraty

createDraftForNewExtension(any, string, String, String)

Parametry

Návraty

createExtension(any, string, string)

Parametry

Návraty

createExtensionWithPublisher(any, string, string, string)

Parametry

Návraty

createPublisher(Publisher)

Parametry

Návraty

createQuestion(Question, string, string)

Parametry

Návraty

createResponse(Response, string, string, number)

Parametry

Návraty

createReview(Review, string, string)

Parametry

Návraty

createSupportRequest(CustomerSupportRequest)

Parametry

Návraty

deleteExtension(string, string, string)

Parametry

Návraty

deleteExtensionById(string, string)

Parametry

Návraty

deletePublisher(string)

Parametry

Návraty

deletePublisherAsset(string, string)

Parametry

Návraty

deleteQuestion(string, string, number)

Parametry

Návraty

deleteResponse(string, string, number, number)

Parametry

Návraty

deleteReview(string, string, number)

Parametry

Návraty

extensionValidator(AzureRestApiRequestModel)

Parametry

Návraty

fetchDomainToken(string)

Parametry

Návraty

generateKey(string, number)

Parametry