GalleryRestClient class

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Costruttori

GalleryRestClient(IVssRestClientOptions)

Proprietà

Metodi

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)	Crea una nuova domanda per un'estensione.
createResponse(Response, string, string, number)	Crea una nuova risposta per una determinata domanda per un'estensione.
createReview(Review, string, string)	Crea una nuova revisione per un'estensione
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Eliminare l'asset dell'editore, ad esempio il logo
deleteQuestion(string, string, number)	Elimina una domanda esistente e tutte le risposte associate per un'estensione. (eliminazione temporanea)
deleteResponse(string, string, number, number)	Elimina una risposta per un'estensione. (eliminazione temporanea)
deleteReview(string, string, number)	Elimina una revisione
extensionValidator(AzureRestApiRequestModel)	Punto finale rest per verificare se un editore di Azure è proprietario di un'estensione per uno scenario commerciale di terze parti. Azure supporta solo le operazioni POST e la firma precedente non è tipica delle operazioni REST. http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}& file=Data%20Market%20Partner%20integration%20with%20Marketplace%20service.docx&action=default
fetchDomainToken(string)
generateKey(string, number)
getAcquisitionOptions(string, string, boolean, boolean)
getAsset(string, string, string, string, boolean, String)
getAssetAuthenticated(string, string, string, string, string, String)
getAssetByName(string, string, string, string, string, boolean, String)
getAssetFromEditExtensionDraft(string, string, string, string)
getAssetFromNewExtensionDraft(string, string, string)
getAssetWithToken(string, string, string, string, string, string, boolean, String)
getCategories(string)
getCategoryDetails(string, string, string)
getCategoryTree(string, string, number, string, string, string, string, string)
getCertificate(string, string, string)
getExtension(string, string, string, ExtensionQueryFlags, string, String)
getExtensionById(string, string, ExtensionQueryFlags)
getExtensionDailyStats(string, string, number, Daily, Date)
getExtensionDailyStatsAnonymous(string, string, string)	Questo ID di route/posizione supporta solo HTTP POST in modo anonimo, in modo che lo stato giornaliero della visualizzazione pagina possa essere incrementato dal client marketplace. Il tentativo di chiamare GET su questa route dovrebbe generare un'eccezione. Senza questa implementazione esplicita, la chiamata a GET su questa route pubblica richiama l'implementazione getExtensionDailyStats precedente.
getExtensionEvents(string, string, number, Date, string, string)	Ottenere eventi di installazione/disinstallazione di un'estensione. Se vengono specificati entrambi i parametri count e afterDate, count ha la precedenza.
getExtensionReports(string, string, number, number, Date)	Restituisce report di estensione
getGalleryUserSettings(string, string)	Ottiene tutte le voci di impostazione per l'ambito utente/tutti gli utenti specificato
getPackage(string, string, string, string, boolean, String)	Questo endpoint viene raggiunto quando si scarica un'estensione VSTS dall'interfaccia utente Web
getPublisher(string, number)
getPublisherAsset(string, string)	Ottenere un asset dell'editore come logo come flusso
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Restituisce un elenco di domande con le relative risposte associate a un'estensione.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Restituisce un elenco di revisioni associate a un'estensione
getReviewsSummary(string, string, Date, Date)	Restituisce un riepilogo delle recensioni
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
getVSCodeExtensionLatestVersion(string, string)	Endpoint per ottenere le versioni più recenti di un'estensione di VS Code.
incrementExtensionDailyStat(string, string, string, string, string)	Incrementa una statistica giornaliera associata all'estensione
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	Endpoint API per pubblicare eventi di installazione/disinstallazione dell'estensione. Questo è destinato a essere richiamato da EMS solo per l'invio di dati correlati all'installazione/disinstallazione di un'estensione.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensionByVsixId(string, string, string, string)	Consulta una singola estensione VS tramite il suo ID VSIX, con filtraggio opzionale per architettura, gamma di versioni e SKU.
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Segnala un problema relativo a una domanda esistente per un'estensione.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Invia notifica
setGalleryUserSettings({[key: string]: any}, string)	Impostare tutte le voci di impostazione per l'ambito utente/tutti gli utenti specificato
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)	Endpoint REST per aggiornare un'estensione.
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)	Aggiornare l'asset dell'editore, ad esempio il logo. Accetta il file di asset come flusso ottetto e il nome file vengono passati nei valori di intestazione.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Endpoint per aggiungere/modificare l'appartenenza al server di pubblicazione. Attualmente supporta solo l'aggiunta/modifica di 1 utente alla volta funziona solo per l'aggiunta di membri dello stesso tenant.
updateQuestion(Question, string, string, number)	Aggiorna una domanda esistente per un'estensione.
updateResponse(Response, string, string, number, number)	Aggiorna una risposta esistente per una determinata domanda per un'estensione.
updateReview(ReviewPatch, string, string, number)	Aggiornamenti o flag di una revisione
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "69d21c00-f135-441b-b5ce-3626378e0819" = "69d21c00-f135-441b-b5ce-3626378e0819"

Valore della proprietà

"69d21c00-f135-441b-b5ce-3626378e0819"

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

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

Parametri

content: string

Contenuto da caricare

publisherName: string

extensionName: string

draftId: string

assetType: string

Valori restituiti

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parametri

content: string

Contenuto da caricare

publisherName: string

draftId: string

assetType: string

Valori restituiti

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parametri

publisherName: string

azurePublisherId: string

Valori restituiti

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parametri

category: ExtensionCategory

Valori restituiti

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parametri

publisherName: string

extensionName: string

Valori restituiti

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parametri

content: any

Contenuto da caricare

publisherName: string

product: String

Intestazione per passare il tipo di prodotto del file di payload

fileName: String

Intestazione per passare il nome file dei dati caricati

Valori restituiti

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parametri

content: any

Contenuto da caricare

extensionType: string

reCaptchaToken: string

Valori restituiti

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parametri

content: any

Contenuto da caricare

publisherName: string

extensionType: string

reCaptchaToken: string

Valori restituiti

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parametri

publisher: Publisher

Valori restituiti

Promise<Publisher>

createQuestion(Question, string, string)

Crea una nuova domanda per un'estensione.

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

Parametri

question: Question

Domanda da creare per l'estensione.

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

Valori restituiti

Promise<Question>

createResponse(Response, string, string, number)

Crea una nuova risposta per una determinata domanda per un'estensione.

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

Parametri

response: Response

Risposta da creare per l'estensione.

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda per la quale deve essere creata la risposta per l'estensione.

Valori restituiti

Promise<Response>

createReview(Review, string, string)

Crea una nuova revisione per un'estensione

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

Parametri

review: Review

Verifica da creare per l'estensione

pubName: string

Nome dell'autore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

Valori restituiti

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parametri

customerSupportRequest: CustomerSupportRequest

Valori restituiti

Promise<void>

deleteExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

version: string

Valori restituiti

Promise<void>

deleteExtensionById(string, string)

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

Parametri

extensionId: string

version: string

Valori restituiti

Promise<void>

deletePublisher(string)

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

Parametri

publisherName: string

Valori restituiti

Promise<void>

deletePublisherAsset(string, string)

Eliminare l'asset dell'editore, ad esempio il logo

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

Parametri

publisherName: string

Nome interno del server di pubblicazione

assetType: string

Tipo di asset. Il valore predefinito è 'logo'.

Valori restituiti

Promise<void>

deleteQuestion(string, string, number)

Elimina una domanda esistente e tutte le risposte associate per un'estensione. (eliminazione temporanea)

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

Parametri

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da eliminare per l'estensione.

Valori restituiti

Promise<void>

deleteResponse(string, string, number, number)

Elimina una risposta per un'estensione. (eliminazione temporanea)

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

Parametri

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identifica la domanda la cui risposta deve essere eliminata.

responseId: number

Identifica la risposta da eliminare.

Valori restituiti

Promise<void>

deleteReview(string, string, number)

Elimina una revisione

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

Parametri

pubName: string

Nome dell'autore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

reviewId: number

ID della verifica da aggiornare

Valori restituiti

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Punto finale rest per verificare se un editore di Azure è proprietario di un'estensione per uno scenario commerciale di terze parti. Azure supporta solo le operazioni POST e la firma precedente non è tipica delle operazioni REST. http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}& file=Data%20Market%20Partner%20integration%20with%20Marketplace%20service.docx&action=default

function extensionValidator(azureRestApiRequestModel: AzureRestApiRequestModel): Promise<void>

Parametri

azureRestApiRequestModel: AzureRestApiRequestModel

Tutti i parametri vengono inviati nel corpo della richiesta

Valori restituiti

Promise<void>

fetchDomainToken(string)

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

Parametri

publisherName: string

Valori restituiti

Promise<string>

generateKey(string, number)

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

Parametri

keyType: string

expireCurrentSeconds: number

Valori restituiti

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parametri

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Valori restituiti

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>

Parametri

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

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>

Parametri

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

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>

Parametri

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parametri

publisherName: string

draftId: string

assetType: string

extensionName: string

Valori restituiti

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parametri

publisherName: string

draftId: string

assetType: string

Valori restituiti

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>

Parametri

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

Promise<ArrayBuffer>

getCategories(string)

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

Parametri

languages: string

Valori restituiti

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parametri

categoryName: string

languages: string

product: string

Valori restituiti

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>

Parametri

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Valori restituiti

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parametri

publisherName: string

extensionName: string

version: string

Valori restituiti

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>

Parametri

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parametri

extensionId: string

version: string

flags: ExtensionQueryFlags

Valori restituiti

Promise<PublishedExtension>

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

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

Parametri

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Valori restituiti

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Questo ID di route/posizione supporta solo HTTP POST in modo anonimo, in modo che lo stato giornaliero della visualizzazione pagina possa essere incrementato dal client marketplace. Il tentativo di chiamare GET su questa route dovrebbe generare un'eccezione. Senza questa implementazione esplicita, la chiamata a GET su questa route pubblica richiama l'implementazione getExtensionDailyStats precedente.

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

Parametri

publisherName: string

Nome dell'editore

extensionName: string

Nome dell'estensione

version: string

Versione dell'estensione

Valori restituiti

Promise<ExtensionDailyStats>

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

Ottenere eventi di installazione/disinstallazione di un'estensione. Se vengono specificati entrambi i parametri count e afterDate, count ha la precedenza.

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

Parametri

publisherName: string

Nome dell'editore

extensionName: string

Nome dell'estensione

count: number

Numero di eventi da recuperare, si applica a ogni tipo di evento.

afterDate: Date

Recuperare gli eventi che si sono verificati in o dopo questa data

include: string

Opzioni di filtro. Valori supportati: installazione, disinstallazione, revisione, acquisizione, vendite. Il valore predefinito è recuperare tutti i tipi di eventi

includeProperty: string

Proprietà dell'evento da includere. Attualmente è supportato solo "lastContactDetails" per gli eventi di disinstallazione

Valori restituiti

Promise<ExtensionEvents>

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

Restituisce report di estensione

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

Parametri

publisherName: string

Nome dell'autore che ha pubblicato l'estensione

extensionName: string

Nome dell'estensione

days: number

Rapporto ultimi n giorni. Se si specifica afterDate e days, i giorni avranno la priorità

count: number

Numero di eventi da restituire

afterDate: Date

Usare se si desidera recuperare gli eventi più recenti della data specificata

Valori restituiti

Promise<any>

getGalleryUserSettings(string, string)

Ottiene tutte le voci di impostazione per l'ambito utente/tutti gli utenti specificato

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

Parametri

userScope: string

User-Scope in corrispondenza del quale ottenere il valore. Deve essere "me" per l'utente corrente o "host" per tutti gli utenti.

key: string

Chiave facoltativa in cui filtrare tutte le voci

Valori restituiti

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

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

Questo endpoint viene raggiunto quando si scarica un'estensione VSTS dall'interfaccia utente Web

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

Parametri

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parametri

publisherName: string

flags: number

Valori restituiti

Promise<Publisher>

getPublisherAsset(string, string)

Ottenere un asset dell'editore come logo come flusso

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

Parametri

publisherName: string

Nome interno del server di pubblicazione

assetType: string

Tipo di asset. Il valore predefinito è 'logo'.

Valori restituiti

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parametri

publisherName: string

Valori restituiti

Promise<Publisher>

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

Restituisce un elenco di domande con le relative risposte associate a un'estensione.

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

Parametri

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

count: number

Numero di domande da recuperare (il valore predefinito è 10).

page: number

Numero di pagina da cui recuperare il set di domande.

afterDate: Date

Se specificato, vengono restituite domande sui risultati che sono state pubblicate dopo questa data

Valori restituiti

Promise<QuestionsResult>

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

Restituisce un elenco di revisioni associate a un'estensione

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

Parametri

publisherName: string

Nome dell'autore che ha pubblicato l'estensione

extensionName: string

Nome dell'estensione

count: number

Numero di recensioni da recuperare (il valore predefinito è 5)

filterOptions: ReviewFilterOptions

FilterOptions per filtrare le recensioni vuote e così via, per impostazione predefinita none

beforeDate: Date

Usare se si desidera recuperare le revisioni precedenti alla data specificata, il valore predefinito è Null

afterDate: Date

Usare se si desidera recuperare le revisioni più recenti rispetto alla data specificata, per impostazione predefinita è Null

Valori restituiti

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Restituisce un riepilogo delle recensioni

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

Parametri

pubName: string

Nome dell'autore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

beforeDate: Date

Usare se si desidera recuperare il riepilogo delle recensioni precedenti alla data specificata, per impostazione predefinita è Null

afterDate: Date

Usare se si desidera recuperare il riepilogo delle recensioni più recenti della data specificata, per impostazione predefinita è Null

Valori restituiti

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>

Parametri

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Valori restituiti

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parametri

keyType: string

Valori restituiti

Promise<string>

getVerificationLog(string, string, string, string)

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

Parametri

publisherName: string

extensionName: string

version: string

targetPlatform: string

Valori restituiti

Promise<ArrayBuffer>

getVSCodeExtensionLatestVersion(string, string)

Endpoint per ottenere le versioni più recenti di un'estensione di VS Code.

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

Parametri

publisherName: string

Nome del server di pubblicazione dell'estensione VS Code richiesta.

extensionName: string

Nome dell'estensione.

Valori restituiti

Promise<PublishedExtension>

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

Incrementa una statistica giornaliera associata all'estensione

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

Parametri

publisherName: string

Nome dell'editore

extensionName: string

Nome dell'estensione

version: string

Versione dell'estensione

statType: string

Tipo di stato da incrementare

targetPlatform: string

Valori restituiti

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parametri

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Valori restituiti

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parametri

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Valori restituiti

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Endpoint API per pubblicare eventi di installazione/disinstallazione dell'estensione. Questo è destinato a essere richiamato da EMS solo per l'invio di dati correlati all'installazione/disinstallazione di un'estensione.

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

Parametri

extensionEvents: ExtensionEvents[]

Valori restituiti

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>

Parametri

content: any

Contenuto da caricare

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Valori restituiti

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parametri

publisherName: string

Valori restituiti

Promise<AzurePublisher>

queryExtensionByVsixId(string, string, string, string)

Consulta una singola estensione VS tramite il suo ID VSIX, con filtraggio opzionale per architettura, gamma di versioni e SKU.

function queryExtensionByVsixId(vsixId: string, arch?: string, versionRange?: string, sku?: string): Promise<ExtensionQueryResult>

Parametri

vsixId: string

L'ID VSIX dell'estensione da interrogare.

arch: string

Filtro architetturale (ad esempio, "amd64", "arm64", "x86").

versionRange: string

Intervallo di versione di installazione di destinazione formattato come "{min}-{max}". Entrambi i vincoli possono essere omesos (ad esempio, "17.0-" o "-18.4").

sku: string

VS filtro SKU (ad esempio, "VisualStudio"). Di default è la corrispondenza ampia.

Valori restituiti

Promise<ExtensionQueryResult>

queryExtensions(ExtensionQuery, string, String)

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

Parametri

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Intestazione per passare il token dell'account

Valori restituiti

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parametri

publisherQuery: PublisherQuery

Valori restituiti

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Segnala un problema relativo a una domanda esistente per un'estensione.

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

Parametri

concern: Concern

L'utente ha segnalato un problema con una domanda per l'estensione.

pubName: string

Nome dell'autore che ha pubblicato l'estensione.

extName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da aggiornare per l'estensione.

Valori restituiti

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametri

acquisitionRequest: ExtensionAcquisitionRequest

Valori restituiti

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Invia notifica

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

Parametri

notificationData: NotificationsData

Denotare i dati necessari per inviare una notifica

Valori restituiti

Promise<void>

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

Impostare tutte le voci di impostazione per l'ambito utente/tutti gli utenti specificato

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

Parametri

entries: {[key: string]: any}

Coppia chiave-valore di tutte le impostazioni che devono essere impostate

userScope: string

User-Scope in corrispondenza del quale ottenere il valore. Deve essere "me" per l'utente corrente o "host" per tutti gli utenti.

Valori restituiti

Promise<void>

shareExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

accountName: string

Valori restituiti

Promise<void>

shareExtensionById(string, string)

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

Parametri

extensionId: string

accountName: string

Valori restituiti

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parametri

publisherName: string

extensionName: string

hostType: string

hostName: string

Valori restituiti

Promise<void>

unshareExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

accountName: string

Valori restituiti

Promise<void>

unshareExtensionById(string, string)

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

Parametri

extensionId: string

accountName: string

Valori restituiti

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parametri

publisherName: string

extensionName: string

hostType: string

hostName: string

Valori restituiti

Promise<void>

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

Endpoint REST per aggiornare un'estensione.

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

Parametri

content: any

Contenuto da caricare

publisherName: string

Nome dell'editore

extensionName: string

Nome dell'estensione

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Questo parametro determina se il controllo delle modifiche dell'ambito deve essere richiamato o meno

Valori restituiti

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parametri

extensionId: string

reCaptchaToken: string

Valori restituiti

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parametri

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Valori restituiti

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parametri

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Valori restituiti

Promise<void>

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

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

Parametri

content: any

Contenuto da caricare

publisherName: string

extensionName: string

draftId: string

fileName: String

Intestazione per passare il nome file dei dati caricati

Valori restituiti

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parametri

content: any

Contenuto da caricare

publisherName: string

draftId: string

fileName: String

Intestazione per passare il nome file dei dati caricati

Valori restituiti

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parametri

publisher: Publisher

publisherName: string

Valori restituiti

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Aggiornare l'asset dell'editore, ad esempio il logo. Accetta il file di asset come flusso ottetto e il nome file vengono passati nei valori di intestazione.

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

Parametri

content: any

Contenuto da caricare

publisherName: string

Nome interno del server di pubblicazione

assetType: string

Tipo di asset. Il valore predefinito è 'logo'.

fileName: String

Intestazione per passare il nome file dei dati caricati

Valori restituiti

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Endpoint per aggiungere/modificare l'appartenenza al server di pubblicazione. Attualmente supporta solo l'aggiunta/modifica di 1 utente alla volta funziona solo per l'aggiunta di membri dello stesso tenant.

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

Parametri

roleAssignments: PublisherUserRoleAssignmentRef[]

Elenco di identificatori utente (indirizzo di posta elettronica) e ruolo da aggiungere. Attualmente è supportata una sola voce.

publisherName: string

Nome/ID dell'autore a cui devono essere aggiunti gli utenti

limitToCallerIdentityDomain: boolean

Le aggiunte tra tenant devono essere consentite o meno.

Valori restituiti

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Aggiorna una domanda esistente per un'estensione.

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

Parametri

question: Question

Domanda aggiornata da impostare per l'estensione.

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da aggiornare per l'estensione.

Valori restituiti

Promise<Question>

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

Aggiorna una risposta esistente per una determinata domanda per un'estensione.

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

Parametri

response: Response

Risposta aggiornata da impostare per l'estensione.

publisherName: string

Nome dell'autore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda per la risposta da aggiornare per l'estensione.

responseId: number

Identificatore della risposta che deve essere aggiornata.

Valori restituiti

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Aggiornamenti o flag di una revisione

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

Parametri

reviewPatch: ReviewPatch

Oggetto ReviewPatch che contiene le modifiche da applicare alla revisione

pubName: string

Nome dell'autore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

reviewId: number

ID della verifica da aggiornare

Valori restituiti

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parametri

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Valori restituiti

Promise<void>

verifyDomainToken(string)

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

Parametri

publisherName: string

Valori restituiti

Promise<void>

GalleryRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

GalleryRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

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

Parametri

Valori restituiti

addAssetForNewExtensionDraft(string, string, string, string)

Parametri

Valori restituiti

associateAzurePublisher(string, string)

Parametri

Valori restituiti

createCategory(ExtensionCategory)

Parametri

Valori restituiti

createDraftForEditExtension(string, string)

Parametri

Valori restituiti

createDraftForNewExtension(any, string, String, String)

Parametri

Valori restituiti

createExtension(any, string, string)

Parametri

Valori restituiti

createExtensionWithPublisher(any, string, string, string)

Parametri

Valori restituiti

createPublisher(Publisher)

Parametri

Valori restituiti

createQuestion(Question, string, string)

Parametri

Valori restituiti

createResponse(Response, string, string, number)

Parametri

Valori restituiti

createReview(Review, string, string)

Parametri

Valori restituiti

createSupportRequest(CustomerSupportRequest)

Parametri

Valori restituiti

deleteExtension(string, string, string)

Parametri

Valori restituiti

deleteExtensionById(string, string)

Parametri

Valori restituiti

deletePublisher(string)

Parametri

Valori restituiti

deletePublisherAsset(string, string)

Parametri

Valori restituiti

deleteQuestion(string, string, number)

Parametri

Valori restituiti

deleteResponse(string, string, number, number)

Parametri

Valori restituiti

deleteReview(string, string, number)

Parametri

Valori restituiti

extensionValidator(AzureRestApiRequestModel)

Parametri

Valori restituiti

fetchDomainToken(string)

Parametri

Valori restituiti

generateKey(string, number)

Parametri

Valori restituiti