GalleryRestClient class

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

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 editor, como logotipo
deleteQuestion(string, string, number)	Exclui uma pergunta existente e todas as respostas associadas para uma extensão. (eliminação suave)
deleteResponse(string, string, number, number)	Exclui uma resposta para uma extensão. (eliminação suave)
deleteReview(string, string, number)	Exclui uma avaliação
extensionValidator(AzureRestApiRequestModel)	Ponto de extremidade de repouso para validar se um editor do Azure possui uma extensão para o cenário de comércio de terceiros 3rd. O Azure suporta apenas 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=Dados%20Market%20Partner%20integration%20with%20Marketplace%20service.docx&action=default
fetchDomainToken(string)
generateKey(string, number)
getAcquisitionOptions(string, string, boolean, boolean)
getAsset(string, string, string, string, boolean, String)
getAssetAuthenticated(string, string, string, string, string, String)
getAssetByName(string, string, string, string, string, boolean, String)
getAssetFromEditExtensionDraft(string, string, string, string)
getAssetFromNewExtensionDraft(string, string, string)
getAssetWithToken(string, string, string, string, string, string, boolean, String)
getCategories(string)
getCategoryDetails(string, string, string)
getCategoryTree(string, string, number, string, string, string, string, string)
getCertificate(string, string, string)
getExtension(string, string, string, ExtensionQueryFlags, string, String)
getExtensionById(string, string, ExtensionQueryFlags)
getExtensionDailyStats(string, string, number, Daily, Date)
getExtensionDailyStatsAnonymous(string, string, string)	Este ID de rota/localização suporta apenas HTTP POST anonimamente, para que a estatística diária de visualização de página possa ser incrementada a partir do cliente do Marketplace. Tentar chamar GET nesta rota deve resultar em uma exceção. Sem essa implementação explícita, chamar GET nesta rota pública invoca a implementação GET acima GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Obtenha 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 de determinado usuário/todos os usuários
getPackage(string, string, string, string, boolean, String)	Esse ponto de extremidade é atingido quando você baixa uma extensão VSTS da interface do usuário da Web
getPublisher(string, number)
getPublisherAsset(string, string)	Obter o ativo do editor, como o 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)	Devolve uma lista de comentários associados a uma extensão
getReviewsSummary(string, string, Date, Date)	Devolve um resumo das avaliações
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
getVSCodeExtensionLatestVersion(string, string)	Ponto final para obter a(s) versão(ões) mais recente(s) de uma extensão VS Code.
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 da API para publicar eventos de instalação/desinstalação de 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 questão 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 de determinado 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 editor, 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 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 uma pergunta existente para uma extensão.
updateResponse(Response, string, string, number, number)	Atualiza uma resposta existente para uma determinada pergunta para uma extensão.
updateReview(ReviewPatch, string, string, number)	Atualiza ou sinaliza uma avaliaçã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 para 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 para 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 para carregar

publisherName: string

product: String

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

fileName: String

Cabeçalho para passar o nome do arquivo 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 para 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 para 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 ser criada 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)

Excluir ativo do editor, 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'.

Devoluções

Promise<void>

deleteQuestion(string, string, number)

Exclui uma pergunta existente e todas as respostas associadas para uma extensão. (eliminação suave)

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.

Devoluções

Promise<void>

deleteResponse(string, string, number, number)

Exclui uma resposta para uma extensão. (eliminação suave)

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.

Devoluções

Promise<void>

deleteReview(string, string, number)

Exclui uma avaliaçã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

Devoluções

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Ponto de extremidade de repouso para validar se um editor do Azure possui uma extensão para o cenário de comércio de terceiros 3rd. O Azure suporta apenas 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=Dados%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

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 passar o token da 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 passar o token da 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 passar o token da 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 passar o token da 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>

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 da 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 suporta apenas HTTP POST anonimamente, para que a estatística diária de visualização de página possa ser incrementada a partir do cliente do Marketplace. Tentar chamar GET nesta rota deve resultar em uma exceção. Sem essa 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 editor

extensionName: string

Nome da extensão

version: string

Versão da extensão

Devoluções

Promise<ExtensionDailyStats>

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

Obtenha 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 aplica-se a cada tipo de evento.

afterDate: Date

Buscar eventos que ocorreram nesta data ou após essa data

include: string

Opções de filtro. Valores suportados: instalar, desinstalar, rever, adquirir, vender. O padrão é buscar todos os tipos de eventos

includeProperty: string

Propriedades do evento a serem incluídas. Atualmente, apenas 'lastContactDetails' é suportado para eventos de desinstalação

Devoluções

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 days forem especificados, os dias terão prioridade

count: number

Número de eventos a serem retornados

afterDate: Date

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

Devoluções

Promise<any>

getGalleryUserSettings(string, string)

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

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 usuário atual ou "host" para todos os usuários.

key: string

Tecla opcional sob a qual filtrar todas as entradas

Devoluções

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

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

Esse ponto de extremidade é atingido quando você baixa uma extensão 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 da 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 o ativo do editor, como o 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'.

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)

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 da página a partir da qual o conjunto de perguntas deve ser recuperado.

afterDate: Date

Se fornecidas, as perguntas de resultados são retornadas que foram postadas após esta data

Devoluções

Promise<QuestionsResult>

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

Devolve uma lista de comentários associados 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 avaliações a serem recuperadas (o padrão é 5)

filterOptions: ReviewFilterOptions

FilterOptions para filtrar avaliações vazias, etcetera, o padrão é nenhum

beforeDate: Date

Use se quiser buscar avaliações anteriores à data especificada, o padrão é null

afterDate: Date

Use se quiser buscar avaliações mais recentes do que a data especificada, o padrão é null

Devoluções

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Devolve um resumo das avaliaçõ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 quiser buscar um resumo de avaliações anteriores à data especificada, o padrão é null

afterDate: Date

Use se quiser buscar um resumo de avaliações mais recentes do que a data especificada, o padrão é null

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>

getVSCodeExtensionLatestVersion(string, string)

Ponto final para obter a(s) versão(ões) mais recente(s) de uma extensão VS Code.

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

Parâmetros

publisherName: string

O nome do editor da extensão VS Code solicitada.

extensionName: string

O nome da extensão.

Devoluções

Promise<PublishedExtension>

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 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 de extremidade da API para publicar eventos de instalação/desinstalação de 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 para 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 passar o token da 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 questão existente para uma extensão.

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

Parâmetros

concern: Concern

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.

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

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

Devoluções

Promise<void>

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

Definir todas as entradas de configuração para o escopo de determinado 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 para obter o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.

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 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 para carregar

publisherName: string

Nome do editor

extensionName: string

Nome da extensão

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Este parâmetro decide se a verificação de alteração de escopo precisa 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 para carregar

publisherName: string

extensionName: string

draftId: string

fileName: String

Cabeçalho para passar o nome do arquivo 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 para carregar

publisherName: string

draftId: string

fileName: String

Cabeçalho para passar o nome do arquivo 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 ativo do editor, 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 para carregar

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

Devoluções

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Ponto de extremidade para adicionar/modificar a associação do editor. 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 usuário (endereço de e-mail) e função a ser adicionada. Atualmente, apenas uma entrada é suportada.

publisherName: string

O nome/id do editor ao qual os usuários devem ser adicionados

limitToCallerIdentityDomain: boolean

As adições de locatário cruzado devem ser permitidas ou não.

Devoluções

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

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

Devoluções

Promise<Question>

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

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

responseId: number

Identificador da resposta que deve ser atualizado.

Devoluções

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Atualiza ou sinaliza uma avaliaçã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

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>

Comentários

Esta página foi útil?

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