GalleryRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends: RestClientBase

Construtores

GalleryRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

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)	Cria uma nova pergunta para uma extensão.
createResponse(Response, string, string, number)	Cria uma nova resposta para uma determinada pergunta para uma extensão.
createReview(Review, string, string)	Cria uma nova revisão para uma extensão
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Eliminar recurso do publicador como logótipo
deleteQuestion(string, string, number)	Elimina uma pergunta existente e todas as respetivas respostas associadas para uma extensão. (eliminação recuperável)
deleteResponse(string, string, number, number)	Elimina uma resposta para uma extensão. (eliminação recuperável)
deleteReview(string, string, number)	Elimina uma revisão
extensionValidator(AzureRestApiRequestModel)	Ponto final rest para validar se um publicador do Azure detém uma extensão para o cenário de comércio de terceiros. O Azure só suporta operações POST e a assinatura acima não é típica das operações 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)	Este ID de rota/localização só suporta HTTP POST anonimamente, para que a estatística diária da vista de página possa ser incrementada a partir do cliente do Marketplace. Tentar chamar GET nesta rota deve resultar numa exceção. Sem esta implementação explícita, chamar GET nesta rota pública invoca a implementação GET acima GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Obter eventos de instalação/desinstalação de uma extensão. Se os parâmetros count e afterDate forem especificados, a contagem tem precedência.
getExtensionReports(string, string, number, number, Date)	Devolve relatórios de extensão
getGalleryUserSettings(string, string)	Obter todas as entradas de definição para o âmbito de utilizador/todos os utilizadores especificado
getPackage(string, string, string, string, boolean, String)	Este ponto final é atingido quando transfere uma extensão VSTS a partir da IU da Web
getPublisher(string, number)
getPublisherAsset(string, string)	Obter um recurso do publicador como logótipo como um fluxo
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Devolve uma lista de perguntas com as respetivas respostas associadas a uma extensão.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Devolve uma lista de críticas associadas a uma extensão
getReviewsSummary(string, string, Date, Date)	Devolve um resumo das críticas
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	Incrementa uma estatística diária associada à extensão
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	Ponto final da API para publicar eventos de instalação/desinstalação da extensão. Isto destina-se a ser invocado pelo EMS apenas para nos enviar dados relacionados com a instalação/desinstalação de uma extensão.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Sinaliza uma preocupação com uma pergunta existente para uma extensão.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Enviar Notificação
setGalleryUserSettings({[key: string]: any}, string)	Definir todas as entradas de definição para o âmbito de utilizador/todos os utilizadores especificado
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)	Ponto final REST para atualizar uma extensão.
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)	Atualize o recurso do publicador, como o logótipo. Aceita o ficheiro de recursos como um fluxo de octetos e o nome de ficheiro é transmitido em valores de cabeçalho.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Ponto final para adicionar/modificar a associação ao publicador. Atualmente suporta apenas adição/modificação de 1 utilizador de cada vez Funciona apenas para adicionar membros do mesmo inquilino.
updateQuestion(Question, string, string, number)	Atualizações uma pergunta existente para uma extensão.
updateResponse(Response, string, string, number, number)	Atualizações uma resposta existente para uma determinada pergunta para uma extensão.
updateReview(ReviewPatch, string, string, number)	Atualizações ou Sinaliza uma revisão
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Detalhes do Construtor

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

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

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

Parâmetros

content: string

Conteúdo a carregar

publisherName: string

extensionName: string

draftId: string

assetType: string

Devoluções

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parâmetros

content: string

Conteúdo a carregar

publisherName: string

draftId: string

assetType: string

Devoluções

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parâmetros

publisherName: string

azurePublisherId: string

Devoluções

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parâmetros

category: ExtensionCategory

Devoluções

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parâmetros

publisherName: string

extensionName: string

Devoluções

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

product: String

Cabeçalho para transmitir o tipo de produto do ficheiro payload

fileName: String

Cabeçalho para transmitir o nome de ficheiro dos dados carregados

Devoluções

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parâmetros

content: any

Conteúdo a carregar

extensionType: string

reCaptchaToken: string

Devoluções

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

extensionType: string

reCaptchaToken: string

Devoluções

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parâmetros

publisher: Publisher

Devoluções

Promise<Publisher>

createQuestion(Question, string, string)

Cria uma nova pergunta para uma extensão.

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

Parâmetros

question: Question

Pergunta a criar para a extensão.

publisherName: string

Nome do editor que publicou a extensão.

extensionName: string

Nome da extensão.

Devoluções

Promise<Question>

createResponse(Response, string, string, number)

Cria uma nova resposta para uma determinada pergunta para uma extensão.

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

Parâmetros

response: Response

Resposta a ser criada para a extensão.

publisherName: string

Nome do editor que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identificador da pergunta para a qual a resposta deve ser criada para a extensão.

Devoluções

Promise<Response>

createReview(Review, string, string)

Cria uma nova revisão para uma extensão

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

Parâmetros

review: Review

Revisão a ser criada para a extensão

pubName: string

Nome do editor que publicou a extensão

extName: string

Nome da extensão

Devoluções

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parâmetros

customerSupportRequest: CustomerSupportRequest

Devoluções

Promise<void>

deleteExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

version: string

Devoluções

Promise<void>

deleteExtensionById(string, string)

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

Parâmetros

extensionId: string

version: string

Devoluções

Promise<void>

deletePublisher(string)

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

Parâmetros

publisherName: string

Devoluções

Promise<void>

deletePublisherAsset(string, string)

Eliminar recurso do publicador como logótipo

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

Parâmetros

publisherName: string

Nome interno do publicador

assetType: string

Tipo de recurso. O valor predefinido é "logótipo".

Devoluções

Promise<void>

deleteQuestion(string, string, number)

Elimina uma pergunta existente e todas as respetivas respostas associadas para uma extensão. (eliminação recuperável)

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

Parâmetros

publisherName: string

Nome do publicador que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identificador da pergunta a eliminar para a extensão.

Devoluções

Promise<void>

deleteResponse(string, string, number, number)

Elimina uma resposta para uma extensão. (eliminação recuperável)

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

Parâmetros

publisherName: string

Nome do publicador que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identifica a pergunta cuja resposta deve ser eliminada.

responseId: number

Identifica a resposta a eliminar.

Devoluções

Promise<void>

deleteReview(string, string, number)

Elimina uma revisão

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

Parâmetros

pubName: string

Nome do editor que publicou a extensão

extName: string

Nome da extensão

reviewId: number

ID da revisão que tem de ser atualizada

Devoluções

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Ponto final rest para validar se um publicador do Azure detém uma extensão para o cenário de comércio de terceiros. O Azure só suporta operações POST e a assinatura acima não é típica das operações 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>

Parâmetros

azureRestApiRequestModel: AzureRestApiRequestModel

Todos os parâmetros são enviados no corpo do pedido

Devoluções

Promise<void>

fetchDomainToken(string)

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

Parâmetros

publisherName: string

Devoluções

Promise<string>

generateKey(string, number)

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

Parâmetros

keyType: string

expireCurrentSeconds: number

Devoluções

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parâmetros

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Devoluções

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>

Parâmetros

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

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>

Parâmetros

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

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>

Parâmetros

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parâmetros

publisherName: string

draftId: string

assetType: string

extensionName: string

Devoluções

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parâmetros

publisherName: string

draftId: string

assetType: string

Devoluções

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>

Parâmetros

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

Promise<ArrayBuffer>

getCategories(string)

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

Parâmetros

languages: string

Devoluções

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parâmetros

categoryName: string

languages: string

product: string

Devoluções

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>

Parâmetros

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Devoluções

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

version: string

Devoluções

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parâmetros

publisherName: string

extensionName: string

Devoluções

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>

Parâmetros

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parâmetros

extensionId: string

version: string

flags: ExtensionQueryFlags

Devoluções

Promise<PublishedExtension>

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

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

Parâmetros

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Devoluções

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Este ID de rota/localização só suporta HTTP POST anonimamente, para que a estatística diária da vista de página possa ser incrementada a partir do cliente do Marketplace. Tentar chamar GET nesta rota deve resultar numa exceção. Sem esta implementação explícita, chamar GET nesta rota pública invoca a implementação GET acima GetExtensionDailyStats.

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

Parâmetros

publisherName: string

Nome do publicador

extensionName: string

Nome da extensão

version: string

Versão da extensão

Devoluções

Promise<ExtensionDailyStats>

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

Obter eventos de instalação/desinstalação de uma extensão. Se os parâmetros count e afterDate forem especificados, a contagem tem precedência.

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

Parâmetros

publisherName: string

Nome do publicador

extensionName: string

Nome da extensão

count: number

A contagem de eventos a obter aplica-se a cada tipo de evento.

afterDate: Date

Obter eventos que ocorreram em ou depois desta data

include: string

Opções de filtro. Valores suportados: instalar, desinstalar, rever, aquisição, vendas. A predefinição é obter todos os tipos de eventos

includeProperty: string

Propriedades do evento a incluir. Atualmente, apenas "lastContactDetails" é suportado para eventos de desinstalação

Devoluções

Promise<ExtensionEvents>

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

Devolve relatórios de extensão

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

Parâmetros

publisherName: string

Nome do editor que publicou a extensão

extensionName: string

Nome da extensão

days: number

Relatório dos últimos n dias. Se afterDate e dias forem especificados, os dias terão prioridade

count: number

Número de eventos a devolver

afterDate: Date

Utilize se quiser obter eventos mais recentes do que a data especificada

Devoluções

Promise<any>

getGalleryUserSettings(string, string)

Obter todas as entradas de definição para o âmbito de utilizador/todos os utilizadores especificado

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

Parâmetros

userScope: string

User-Scope para obter o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.

key: string

Chave opcional sob a qual filtrar todas as entradas

Devoluções

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

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

Este ponto final é atingido quando transfere uma extensão VSTS a partir da IU da Web

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

Parâmetros

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parâmetros

publisherName: string

flags: number

Devoluções

Promise<Publisher>

getPublisherAsset(string, string)

Obter um recurso do publicador como logótipo como um fluxo

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

Parâmetros

publisherName: string

Nome interno do publicador

assetType: string

Tipo de recurso. O valor predefinido é "logótipo".

Devoluções

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parâmetros

publisherName: string

Devoluções

Promise<Publisher>

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

Devolve uma lista de perguntas com as respetivas respostas associadas a uma extensão.

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

Parâmetros

publisherName: string

Nome do publicador que publicou a extensão.

extensionName: string

Nome da extensão.

count: number

Número de perguntas a obter (a predefinição é 10).

page: number

Número de página a partir do qual o conjunto de perguntas deve ser obtido.

afterDate: Date

Se for fornecido, são devolvidas as perguntas de resultados que foram publicadas após esta data

Devoluções

Promise<QuestionsResult>

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

Devolve uma lista de críticas associadas a uma extensão

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

Parâmetros

publisherName: string

Nome do editor que publicou a extensão

extensionName: string

Nome da extensão

count: number

Número de revisões a obter (predefinições para 5)

filterOptions: ReviewFilterOptions

FilterOptions para filtrar críticas vazias, etc., predefinições para nenhuma

beforeDate: Date

Utilize se quiser obter críticas mais antigas do que a data especificada, a predefinição é nula

afterDate: Date

Utilize se quiser obter revisões mais recentes do que a data especificada, a predefinição é nula

Devoluções

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Devolve um resumo das críticas

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

Parâmetros

pubName: string

Nome do editor que publicou a extensão

extName: string

Nome da extensão

beforeDate: Date

Utilize se quiser obter o resumo das críticas mais antigas do que a data especificada, a predefinição é nula

afterDate: Date

Utilize se quiser obter o resumo das revisões mais recentes do que a data especificada, a predefinição é nula

Devoluções

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>

Parâmetros

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Devoluções

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parâmetros

keyType: string

Devoluções

Promise<string>

getVerificationLog(string, string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

version: string

targetPlatform: string

Devoluções

Promise<ArrayBuffer>

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

Incrementa uma estatística diária associada à extensão

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

Parâmetros

publisherName: string

Nome do publicador

extensionName: string

Nome da extensão

version: string

Versão da extensão

statType: string

Tipo de estatística a incrementar

targetPlatform: string

Devoluções

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parâmetros

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Devoluções

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parâmetros

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Devoluções

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Ponto final da API para publicar eventos de instalação/desinstalação da extensão. Isto destina-se a ser invocado pelo EMS apenas para nos enviar dados relacionados com a instalação/desinstalação de uma extensão.

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

Parâmetros

extensionEvents: ExtensionEvents[]

Devoluções

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>

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Devoluções

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parâmetros

publisherName: string

Devoluções

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parâmetros

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Cabeçalho para transmitir o token de conta

Devoluções

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parâmetros

publisherQuery: PublisherQuery

Devoluções

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Sinaliza uma preocupação com uma pergunta existente para uma extensão.

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

Parâmetros

concern: Concern

O utilizador comunicou a preocupação com uma pergunta para a extensão.

pubName: string

Nome do publicador que publicou a extensão.

extName: string

Nome da extensão.

questionId: number

Identificador da pergunta a atualizar para a extensão.

Devoluções

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parâmetros

acquisitionRequest: ExtensionAcquisitionRequest

Devoluções

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Enviar Notificação

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

Parâmetros

notificationData: NotificationsData

Denotar os dados necessários para enviar uma notificação

Devoluções

Promise<void>

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

Definir todas as entradas de definição para o âmbito de utilizador/todos os utilizadores especificado

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

Parâmetros

entries: {[key: string]: any}

Um par chave-valor de todas as definições que têm de ser definidas

userScope: string

User-Scope para obter o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.

Devoluções

Promise<void>

shareExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

accountName: string

Devoluções

Promise<void>

shareExtensionById(string, string)

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

Parâmetros

extensionId: string

accountName: string

Devoluções

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

hostType: string

hostName: string

Devoluções

Promise<void>

unshareExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

accountName: string

Devoluções

Promise<void>

unshareExtensionById(string, string)

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

Parâmetros

extensionId: string

accountName: string

Devoluções

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

hostType: string

hostName: string

Devoluções

Promise<void>

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

Ponto final REST para atualizar uma extensão.

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

Nome do publicador

extensionName: string

Nome da extensão

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Este parâmetro decide se a verificação de alteração do âmbito tem de ser invocada ou não

Devoluções

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parâmetros

extensionId: string

reCaptchaToken: string

Devoluções

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parâmetros

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Devoluções

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parâmetros

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Devoluções

Promise<void>

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

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

extensionName: string

draftId: string

fileName: String

Cabeçalho para transmitir o nome do ficheiro dos dados carregados

Devoluções

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

draftId: string

fileName: String

Cabeçalho para transmitir o nome do ficheiro dos dados carregados

Devoluções

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parâmetros

publisher: Publisher

publisherName: string

Devoluções

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Atualize o recurso do publicador, como o logótipo. Aceita o ficheiro de recursos como um fluxo de octetos e o nome de ficheiro é transmitido em valores de cabeçalho.

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

Parâmetros

content: any

Conteúdo a carregar

publisherName: string

Nome interno do publicador

assetType: string

Tipo de recurso. O valor predefinido é "logótipo".

fileName: String

Cabeçalho para transmitir o nome do ficheiro dos dados carregados

Devoluções

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Ponto final para adicionar/modificar a associação ao publicador. Atualmente suporta apenas adição/modificação de 1 utilizador de cada vez Funciona apenas para adicionar membros do mesmo inquilino.

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

Parâmetros

roleAssignments: PublisherUserRoleAssignmentRef[]

Lista de identificadores de utilizador (endereço de e-mail) e função a adicionar. Atualmente, só é suportada uma entrada.

publisherName: string

O nome/id do publicador ao qual os utilizadores têm de ser adicionados

limitToCallerIdentityDomain: boolean

Devem ser permitidos ou não suplementos entre inquilinos.

Devoluções

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Atualizações uma pergunta existente para uma extensão.

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

Parâmetros

question: Question

Pergunta atualizada a definir para a extensão.

publisherName: string

Nome do publicador que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identificador da pergunta a atualizar para a extensão.

Devoluções

Promise<Question>

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

Atualizações uma resposta existente para uma determinada pergunta para uma extensão.

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

Parâmetros

response: Response

Resposta atualizada a ser definida para a extensão.

publisherName: string

Nome do publicador que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identificador da pergunta para a qual a resposta deve ser atualizada para a extensão.

responseId: number

Identificador da resposta que tem de ser atualizada.

Devoluções

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Atualizações ou Sinaliza uma revisão

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

Parâmetros

reviewPatch: ReviewPatch

Objeto ReviewPatch que contém as alterações a aplicar à revisão

pubName: string

Nome do editor que publicou a extensão

extName: string

Nome da extensão

reviewId: number

ID da revisão que tem de ser atualizada

Devoluções

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parâmetros

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Devoluções

Promise<void>

verifyDomainToken(string)

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

Parâmetros

publisherName: string

Devoluções

Promise<void>

Partilhar via

GalleryRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

GalleryRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

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

Parâmetros

Devoluções

addAssetForNewExtensionDraft(string, string, string, string)

Parâmetros

Devoluções

associateAzurePublisher(string, string)

Parâmetros

Devoluções

createCategory(ExtensionCategory)

Parâmetros

Devoluções

createDraftForEditExtension(string, string)

Parâmetros

Devoluções

createDraftForNewExtension(any, string, String, String)

Parâmetros

Devoluções

createExtension(any, string, string)

Parâmetros

Devoluções

createExtensionWithPublisher(any, string, string, string)

Parâmetros

Devoluções

createPublisher(Publisher)

Parâmetros

Devoluções

createQuestion(Question, string, string)

Parâmetros

Devoluções

createResponse(Response, string, string, number)

Parâmetros

Devoluções

createReview(Review, string, string)

Parâmetros

Devoluções

createSupportRequest(CustomerSupportRequest)

Parâmetros

Devoluções

deleteExtension(string, string, string)

Parâmetros

Devoluções

deleteExtensionById(string, string)

Parâmetros

Devoluções

deletePublisher(string)

Parâmetros

Devoluções

deletePublisherAsset(string, string)

Parâmetros

Devoluções

deleteQuestion(string, string, number)

Parâmetros

Devoluções

deleteResponse(string, string, number, number)

Parâmetros

Devoluções

deleteReview(string, string, number)

Parâmetros

Devoluções

extensionValidator(AzureRestApiRequestModel)

Parâmetros

Devoluções

fetchDomainToken(string)

Parâmetros

Devoluções

generateKey(string, number)

Parâmetros