GalleryRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends: RestClientBase

Costruttori

GalleryRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

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 relative 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 convalidare se un editore di Azure possiede un'estensione per lo 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)
getContentVerificationLog(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 route/posizione supporta solo HTTP POST in modo anonimo, in modo che la visualizzazione pagina giornaliera stat possa essere incrementata dal client marketplace. Il tentativo di chiamare GET in questa route deve comportare un'eccezione. Senza questa implementazione esplicita, la chiamata a GET in 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, il conteggio ha la precedenza.
getExtensionReports(string, string, number, number, Date)	Restituisce report di estensione
getGalleryUserSettings(string, string)	Ottenere 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 asset di pubblicazione 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 recensioni 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)
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 gli eventi di installazione/disinstallazione dell'estensione. Ciò significa 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)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Contrassegna 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 o la modifica di 1 utente alla volta Funziona solo per l'aggiunta di membri dello stesso tenant.
updateQuestion(Question, string, string, number)	Aggiornamenti una domanda esistente per un'estensione.
updateResponse(Response, string, string, number, number)	Aggiornamenti una risposta esistente per una determinata domanda per un'estensione.
updateReview(ReviewPatch, string, string, number)	Aggiornamenti o Contrassegna una recensione
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Dettagli costruttore

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

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

Restituisce

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

Restituisce

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parametri

publisherName: string

azurePublisherId: string

Restituisce

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parametri

category: ExtensionCategory

Restituisce

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parametri

publisherName: string

extensionName: string

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parametri

publisher: Publisher

Restituisce

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'editore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

Restituisce

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'editore 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.

Restituisce

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

Revisione da creare per l'estensione

pubName: string

Nome dell'editore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

Restituisce

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parametri

customerSupportRequest: CustomerSupportRequest

Restituisce

Promise<void>

deleteExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

version: string

Restituisce

Promise<void>

deleteExtensionById(string, string)

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

Parametri

extensionId: string

version: string

Restituisce

Promise<void>

deletePublisher(string)

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

Parametri

publisherName: string

Restituisce

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'.

Restituisce

Promise<void>

deleteQuestion(string, string, number)

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

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

Parametri

publisherName: string

Nome dell'editore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da eliminare per l'estensione.

Restituisce

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'editore 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.

Restituisce

Promise<void>

deleteReview(string, string, number)

Elimina una revisione

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

Parametri

pubName: string

Nome dell'editore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

reviewId: number

ID della revisione che deve essere aggiornata

Restituisce

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Punto finale rest per convalidare se un editore di Azure possiede un'estensione per lo 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

Restituisce

Promise<void>

fetchDomainToken(string)

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

Parametri

publisherName: string

Restituisce

Promise<string>

generateKey(string, number)

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

Parametri

keyType: string

expireCurrentSeconds: number

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parametri

publisherName: string

draftId: string

assetType: string

Restituisce

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

Restituisce

Promise<ArrayBuffer>

getCategories(string)

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

Parametri

languages: string

Restituisce

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parametri

categoryName: string

languages: string

product: string

Restituisce

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

Restituisce

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parametri

publisherName: string

extensionName: string

version: string

Restituisce

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parametri

publisherName: string

extensionName: string

Restituisce

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

Restituisce

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parametri

extensionId: string

version: string

flags: ExtensionQueryFlags

Restituisce

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

Restituisce

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Questo ID route/posizione supporta solo HTTP POST in modo anonimo, in modo che la visualizzazione pagina giornaliera stat possa essere incrementata dal client marketplace. Il tentativo di chiamare GET in questa route deve comportare un'eccezione. Senza questa implementazione esplicita, la chiamata a GET in questa route pubblica richiama l'implementazione GETExtensionDailyStats precedente.

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

Parametri

publisherName: string

Nome del server di pubblicazione

extensionName: string

Nome dell'estensione

version: string

Versione dell'estensione

Restituisce

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, il conteggio ha la precedenza.

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

Parametri

publisherName: string

Nome del server di pubblicazione

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: installare, disinstallare, esaminare, acquisire, vendite. Il valore predefinito è recuperare tutti i tipi di eventi

includeProperty: string

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

Restituisce

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'editore che ha pubblicato l'estensione

extensionName: string

Nome dell'estensione

days: number

Ultimo rapporto n giorni. Se dopoDate e giorni vengono specificati, 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

Restituisce

Promise<any>

getGalleryUserSettings(string, string)

Ottenere 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

Restituisce

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

Restituisce

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parametri

publisherName: string

flags: number

Restituisce

Promise<Publisher>

getPublisherAsset(string, string)

Ottenere asset di pubblicazione 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'.

Restituisce

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parametri

publisherName: string

Restituisce

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'editore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

count: number

Numero di domande da recuperare (impostazione predefinita su 10).

page: number

Numero di pagina da cui recuperare il set di domande.

afterDate: Date

Se specificato, le domande dei risultati vengono restituite dopo questa data

Restituisce

Promise<QuestionsResult>

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

Restituisce un elenco di recensioni 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'editore che ha pubblicato l'estensione

extensionName: string

Nome dell'estensione

count: number

Numero di recensioni da recuperare (impostazione predefinita a 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, le impostazioni predefinite sono null

afterDate: Date

Usare se si desidera recuperare le revisioni più recenti della data specificata, le impostazioni predefinite sono null

Restituisce

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'editore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

beforeDate: Date

Usare se si vuole recuperare il riepilogo delle revisioni precedenti alla data specificata, le impostazioni predefinite sono null

afterDate: Date

Usare se si vuole recuperare il riepilogo delle revisioni più recenti rispetto alla data specificata, le impostazioni predefinite sono null

Restituisce

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

Restituisce

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parametri

keyType: string

Restituisce

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

Restituisce

Promise<ArrayBuffer>

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 del server di pubblicazione

extensionName: string

Nome dell'estensione

version: string

Versione dell'estensione

statType: string

Tipo di stat da incrementare

targetPlatform: string

Restituisce

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

Restituisce

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parametri

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Restituisce

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Endpoint API per pubblicare gli eventi di installazione/disinstallazione dell'estensione. Ciò significa 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[]

Restituisce

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

Restituisce

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parametri

publisherName: string

Restituisce

Promise<AzurePublisher>

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

Restituisce

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parametri

publisherQuery: PublisherQuery

Restituisce

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Contrassegna 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 preoccupazione per una domanda per l'estensione.

pubName: string

Nome dell'editore che ha pubblicato l'estensione.

extName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da aggiornare per l'estensione.

Restituisce

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametri

acquisitionRequest: ExtensionAcquisitionRequest

Restituisce

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Invia notifica

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

Parametri

notificationData: NotificationsData

Denotare i dati necessari per inviare una notifica

Restituisce

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.

Restituisce

Promise<void>

shareExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

accountName: string

Restituisce

Promise<void>

shareExtensionById(string, string)

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

Parametri

extensionId: string

accountName: string

Restituisce

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

Restituisce

Promise<void>

unshareExtension(string, string, string)

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

Parametri

publisherName: string

extensionName: string

accountName: string

Restituisce

Promise<void>

unshareExtensionById(string, string)

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

Parametri

extensionId: string

accountName: string

Restituisce

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

Restituisce

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 decide se il controllo delle modifiche dell'ambito deve essere richiamato o meno

Restituisce

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parametri

extensionId: string

reCaptchaToken: string

Restituisce

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parametri

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Restituisce

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parametri

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Restituisce

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

Restituisce

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

Restituisce

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parametri

publisher: Publisher

publisherName: string

Restituisce

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

Restituisce

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Endpoint per aggiungere/modificare l'appartenenza al server di pubblicazione. Attualmente supporta solo l'aggiunta o la 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'editore a cui devono essere aggiunti gli utenti

limitToCallerIdentityDomain: boolean

Le aggiunte tra tenant devono essere consentite o meno.

Restituisce

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Aggiornamenti 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'editore che ha pubblicato l'estensione.

extensionName: string

Nome dell'estensione.

questionId: number

Identificatore della domanda da aggiornare per l'estensione.

Restituisce

Promise<Question>

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

Aggiornamenti 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'editore 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.

Restituisce

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Aggiornamenti o Contrassegna una recensione

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'editore che ha pubblicato l'estensione

extName: string

Nome dell'estensione

reviewId: number

ID della verifica che deve essere aggiornata

Restituisce

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parametri

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Restituisce

Promise<void>

verifyDomainToken(string)

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

Parametri

publisherName: string

Restituisce

Promise<void>

Condividi tramite

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

Restituisce

addAssetForNewExtensionDraft(string, string, string, string)

Parametri

Restituisce

associateAzurePublisher(string, string)

Parametri

Restituisce

createCategory(ExtensionCategory)

Parametri

Restituisce

createDraftForEditExtension(string, string)

Parametri

Restituisce

createDraftForNewExtension(any, string, String, String)

Parametri

Restituisce

createExtension(any, string, string)

Parametri

Restituisce

createExtensionWithPublisher(any, string, string, string)

Parametri

Restituisce

createPublisher(Publisher)

Parametri

Restituisce

createQuestion(Question, string, string)

Parametri

Restituisce

createResponse(Response, string, string, number)

Parametri

Restituisce

createReview(Review, string, string)

Parametri

Restituisce

createSupportRequest(CustomerSupportRequest)

Parametri

Restituisce

deleteExtension(string, string, string)

Parametri

Restituisce

deleteExtensionById(string, string)

Parametri

Restituisce

deletePublisher(string)

Parametri

Restituisce

deletePublisherAsset(string, string)

Parametri

Restituisce

deleteQuestion(string, string, number)

Parametri

Restituisce

deleteResponse(string, string, number, number)

Parametri

Restituisce

deleteReview(string, string, number)

Parametri

Restituisce

extensionValidator(AzureRestApiRequestModel)

Parametri

Restituisce

fetchDomainToken(string)

Parametri

Restituisce

generateKey(string, number)

Parametri