GalleryRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para 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)	Excluir ativo do publicador como logotipo
deleteQuestion(string, string, number)	Exclui uma pergunta existente e todas as suas respostas associadas para uma extensão. (exclusão temporária)
deleteResponse(string, string, number, number)	Exclui uma resposta para uma extensão. (exclusão temporária)
deleteReview(string, string, number)	Exclui uma revisão
extensionValidator(AzureRestApiRequestModel)	Ponto de extremidade rest para validar se um editor do Azure possui uma extensão para cenário de comércio de terceiros. O Azure dá suporte apenas a 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)	Essa ID de rota/localização dá suporte apenas a HTTP POST anonimamente, para que a estatística diária de exibição de página possa ser incrementada do cliente do Marketplace. Tentar chamar GET nessa rota deve resultar em uma exceção. Sem essa implementação explícita, chamar GET nessa rota pública invoca a implementação GET GetExtensionDailyStats acima.
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, count terá precedência.
getExtensionReports(string, string, number, number, Date)	Retorna relatórios de extensão
getGalleryUserSettings(string, string)	Obter todas as entradas de configuração para o escopo determinado de usuário/todos os usuários
getPackage(string, string, string, string, boolean, String)	Esse ponto de extremidade é atingido quando você baixa uma extensão do VSTS da interface do usuário da Web
getPublisher(string, number)
getPublisherAsset(string, string)	Obter ativo do publicador como logotipo como um fluxo
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Retorna uma lista de perguntas com suas respostas associadas a uma extensão.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Retorna uma lista de revisões associadas a uma extensão
getReviewsSummary(string, string, Date, Date)	Retorna um resumo das revisões
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 de extremidade de API para publicar eventos de instalação/desinstalação de extensão. Isso deve ser invocado pelo EMS apenas para nos enviar dados relacionados à 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 configuração para o escopo determinado de usuário/todos os usuários
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 de extremidade 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 ativo do publicador como o logotipo. Ele aceita o arquivo de ativo como um fluxo de octeto e o nome do arquivo é passado em valores de cabeçalho.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Ponto de extremidade para adicionar/modificar a associação do editor. Atualmente, dá suporte apenas à adição/modificação de um usuário por vez Funciona apenas para adicionar membros do mesmo locatário.
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 da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do 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 ser carregado

publisherName: string

extensionName: string

draftId: string

assetType: string

Retornos

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 ser carregado

publisherName: string

draftId: string

assetType: string

Retornos

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parâmetros

publisherName: string

azurePublisherId: string

Retornos

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parâmetros

category: ExtensionCategory

Retornos

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parâmetros

publisherName: string

extensionName: string

Retornos

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 ser carregado

publisherName: string

product: String

Cabeçalho para passar o tipo de produto do arquivo de conteúdo

fileName: String

Cabeçalho para passar o nome do arquivo dos dados carregados

Retornos

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parâmetros

content: any

Conteúdo a ser carregado

extensionType: string

reCaptchaToken: string

Retornos

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 ser carregado

publisherName: string

extensionType: string

reCaptchaToken: string

Retornos

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parâmetros

publisher: Publisher

Retornos

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 ser criada para a extensão.

publisherName: string

Nome do editor que publicou a extensão.

extensionName: string

Nome da extensão.

Retornos

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 qual resposta deve ser criada para a extensão.

Retornos

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

Retornos

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parâmetros

customerSupportRequest: CustomerSupportRequest

Retornos

Promise<void>

deleteExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

version: string

Retornos

Promise<void>

deleteExtensionById(string, string)

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

Parâmetros

extensionId: string

version: string

Retornos

Promise<void>

deletePublisher(string)

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

Parâmetros

publisherName: string

Retornos

Promise<void>

deletePublisherAsset(string, string)

Excluir ativo do publicador como logotipo

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

Parâmetros

publisherName: string

Nome interno do editor

assetType: string

Tipo de ativo. O valor padrão é 'logo'.

Retornos

Promise<void>

deleteQuestion(string, string, number)

Exclui uma pergunta existente e todas as suas respostas associadas para uma extensão. (exclusão temporária)

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

Parâmetros

publisherName: string

Nome do editor que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identificador da pergunta a ser excluída para a extensão.

Retornos

Promise<void>

deleteResponse(string, string, number, number)

Exclui uma resposta para uma extensão. (exclusão temporária)

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

Parâmetros

publisherName: string

Nome do editor que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

Identifica a pergunta cuja resposta deve ser excluída.

responseId: number

Identifica a resposta a ser excluída.

Retornos

Promise<void>

deleteReview(string, string, number)

Exclui 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 precisa ser atualizada

Retornos

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Ponto de extremidade rest para validar se um editor do Azure possui uma extensão para cenário de comércio de terceiros. O Azure dá suporte apenas a 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 da solicitação

Retornos

Promise<void>

fetchDomainToken(string)

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

Parâmetros

publisherName: string

Retornos

Promise<string>

generateKey(string, number)

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

Parâmetros

keyType: string

expireCurrentSeconds: number

Retornos

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

Retornos

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 passar o token de conta

Retornos

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 passar o token de conta

Retornos

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 passar o token de conta

Retornos

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

Retornos

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parâmetros

publisherName: string

draftId: string

assetType: string

Retornos

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 passar o token de conta

Retornos

Promise<ArrayBuffer>

getCategories(string)

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

Parâmetros

languages: string

Retornos

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parâmetros

categoryName: string

languages: string

product: string

Retornos

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

Retornos

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

version: string

Retornos

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parâmetros

publisherName: string

extensionName: string

Retornos

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 passar o token de conta

Retornos

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parâmetros

extensionId: string

version: string

flags: ExtensionQueryFlags

Retornos

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

Retornos

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Essa ID de rota/localização dá suporte apenas a HTTP POST anonimamente, para que a estatística diária de exibição de página possa ser incrementada do cliente do Marketplace. Tentar chamar GET nessa rota deve resultar em uma exceção. Sem essa implementação explícita, chamar GET nessa rota pública invoca a implementação GET GetExtensionDailyStats acima.

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

Parâmetros

publisherName: string

Nome do editor

extensionName: string

Nome da extensão

version: string

Versão da extensão

Retornos

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, count terá precedência.

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

Parâmetros

publisherName: string

Nome do editor

extensionName: string

Nome da extensão

count: number

A contagem de eventos a serem buscados se aplica a cada tipo de evento.

afterDate: Date

Buscar eventos que ocorreram em ou após essa data

include: string

Opções de filtro. Valores com suporte: instalar, desinstalar, examinar, aquisição, vendas. O padrão é buscar todos os tipos de eventos

includeProperty: string

Propriedades de evento a serem incluídas. Atualmente, há suporte apenas para 'lastContactDetails' para eventos de desinstalação

Retornos

Promise<ExtensionEvents>

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

Retorna 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 serem retornados

afterDate: Date

Use se você quiser buscar eventos mais recentes do que a data especificada

Retornos

Promise<any>

getGalleryUserSettings(string, string)

Obter todas as entradas de configuração para o escopo determinado de usuário/todos os usuários

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

Parâmetros

userScope: string

User-Scope no qual obter o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.

key: string

Chave opcional sob a qual filtrar todas as entradas

Retornos

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

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

Esse ponto de extremidade é atingido quando você baixa uma extensão do VSTS da interface do usuário 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 passar o token de conta

Retornos

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parâmetros

publisherName: string

flags: number

Retornos

Promise<Publisher>

getPublisherAsset(string, string)

Obter ativo do publicador como logotipo como um fluxo

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

Parâmetros

publisherName: string

Nome interno do editor

assetType: string

Tipo de ativo. O valor padrão é 'logo'.

Retornos

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parâmetros

publisherName: string

Retornos

Promise<Publisher>

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

Retorna uma lista de perguntas com suas 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 editor que publicou a extensão.

extensionName: string

Nome da extensão.

count: number

Número de perguntas a serem recuperadas (o padrão é 10).

page: number

Número de página do qual o conjunto de perguntas deve ser recuperado.

afterDate: Date

Se fornecido, serão retornadas perguntas de resultados que foram postadas após essa data

Retornos

Promise<QuestionsResult>

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

Retorna uma lista de revisões 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 serem recuperadas (o padrão é 5)

filterOptions: ReviewFilterOptions

FilterOptions para filtrar revisões vazias etc., o padrão é nenhum

beforeDate: Date

Use se você quiser buscar revisões mais antigas que a data especificada, o padrão será nulo

afterDate: Date

Use se você quiser buscar revisões mais recentes do que a data especificada, o padrão será nulo

Retornos

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Retorna um resumo das revisões

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

Use se você quiser buscar o resumo de revisões mais antigas que a data especificada, o padrão será nulo

afterDate: Date

Use se você quiser buscar o resumo de revisões mais recentes do que a data especificada, o padrão será nulo

Retornos

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

Retornos

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parâmetros

keyType: string

Retornos

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

Retornos

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 editor

extensionName: string

Nome da extensão

version: string

Versão da extensão

statType: string

Tipo de estatística a ser incrementada

targetPlatform: string

Retornos

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

Retornos

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parâmetros

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Retornos

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Ponto de extremidade de API para publicar eventos de instalação/desinstalação de extensão. Isso deve ser invocado pelo EMS apenas para nos enviar dados relacionados à instalação/desinstalação de uma extensão.

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

Parâmetros

extensionEvents: ExtensionEvents[]

Retornos

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 ser carregado

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Retornos

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parâmetros

publisherName: string

Retornos

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 passar o token de conta

Retornos

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parâmetros

publisherQuery: PublisherQuery

Retornos

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 usuário relatou preocupação com uma pergunta para a extensão.

pubName: string

Nome do editor que publicou a extensão.

extName: string

Nome da extensão.

questionId: number

Identificador da pergunta a ser atualizada para a extensão.

Retornos

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parâmetros

acquisitionRequest: ExtensionAcquisitionRequest

Retornos

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Enviar Notificação

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

Parâmetros

notificationData: NotificationsData

Denotando os dados necessários para enviar notificação

Retornos

Promise<void>

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

Definir todas as entradas de configuração para o escopo determinado de usuário/todos os usuários

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

Parâmetros

entries: {[key: string]: any}

Um par chave-valor de todas as configurações que precisam ser definidas

userScope: string

User-Scope no qual obter o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.

Retornos

Promise<void>

shareExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

accountName: string

Retornos

Promise<void>

shareExtensionById(string, string)

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

Parâmetros

extensionId: string

accountName: string

Retornos

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

Retornos

Promise<void>

unshareExtension(string, string, string)

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

Parâmetros

publisherName: string

extensionName: string

accountName: string

Retornos

Promise<void>

unshareExtensionById(string, string)

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

Parâmetros

extensionId: string

accountName: string

Retornos

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

Retornos

Promise<void>

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

Ponto de extremidade 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 ser carregado

publisherName: string

Nome do editor

extensionName: string

Nome da extensão

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Esse parâmetro decide se a alteração de escopo marcar precisa ser invocada ou não

Retornos

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parâmetros

extensionId: string

reCaptchaToken: string

Retornos

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parâmetros

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Retornos

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parâmetros

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Retornos

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 ser carregado

publisherName: string

extensionName: string

draftId: string

fileName: String

Cabeçalho para passar o nome do arquivo dos dados carregados

Retornos

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 ser carregado

publisherName: string

draftId: string

fileName: String

Cabeçalho para passar o nome do arquivo dos dados carregados

Retornos

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parâmetros

publisher: Publisher

publisherName: string

Retornos

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Atualize o ativo do publicador como o logotipo. Ele aceita o arquivo de ativo como um fluxo de octeto e o nome do arquivo é passado 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 ser carregado

publisherName: string

Nome interno do editor

assetType: string

Tipo de ativo. O valor padrão é 'logo'.

fileName: String

Cabeçalho para passar o nome do arquivo dos dados carregados

Retornos

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Ponto de extremidade para adicionar/modificar a associação do editor. Atualmente, dá suporte apenas à adição/modificação de um usuário por vez Funciona apenas para adicionar membros do mesmo locatário.

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

Parâmetros

roleAssignments: PublisherUserRoleAssignmentRef[]

Lista de identificadores de usuário (endereço de email) e função a serem adicionadas. Atualmente, há suporte para apenas uma entrada.

publisherName: string

O nome/id do publicador ao qual os usuários precisam ser adicionados

limitToCallerIdentityDomain: boolean

As adições entre locatários devem ser permitidas ou não.

Retornos

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 ser definida 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 a ser atualizada para a extensão.

Retornos

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 editor que publicou a extensão.

extensionName: string

Nome da extensão.

questionId: number

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

responseId: number

Identificador da resposta que precisa ser atualizada.

Retornos

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 serem aplicadas à 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 precisa ser atualizada

Retornos

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parâmetros

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Retornos

Promise<void>

verifyDomainToken(string)

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

Parâmetros

publisherName: string

Retornos

Promise<void>

Compartilhar via

GalleryRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

GalleryRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

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

Parâmetros

Retornos

addAssetForNewExtensionDraft(string, string, string, string)

Parâmetros

Retornos

associateAzurePublisher(string, string)

Parâmetros

Retornos

createCategory(ExtensionCategory)

Parâmetros

Retornos

createDraftForEditExtension(string, string)

Parâmetros

Retornos

createDraftForNewExtension(any, string, String, String)

Parâmetros

Retornos

createExtension(any, string, string)

Parâmetros

Retornos

createExtensionWithPublisher(any, string, string, string)

Parâmetros

Retornos

createPublisher(Publisher)

Parâmetros

Retornos

createQuestion(Question, string, string)

Parâmetros

Retornos

createResponse(Response, string, string, number)

Parâmetros

Retornos

createReview(Review, string, string)

Parâmetros

Retornos

createSupportRequest(CustomerSupportRequest)

Parâmetros

Retornos

deleteExtension(string, string, string)

Parâmetros

Retornos

deleteExtensionById(string, string)

Parâmetros

Retornos

deletePublisher(string)

Parâmetros

Retornos

deletePublisherAsset(string, string)

Parâmetros

Retornos

deleteQuestion(string, string, number)

Parâmetros

Retornos

deleteResponse(string, string, number, number)

Parâmetros

Retornos

deleteReview(string, string, number)

Parâmetros

Retornos

extensionValidator(AzureRestApiRequestModel)

Parâmetros

Retornos

fetchDomainToken(string)

Parâmetros

Retornos

generateKey(string, number)

Parâmetros