GalleryRestClient class

Referencia

Paquete:: azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends: RestClientBase

Constructores

GalleryRestClient(IVssRestClientOptions)

Propiedades

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)	Crea una nueva pregunta para una extensión.
createResponse(Response, string, string, number)	Crea una nueva respuesta para una pregunta determinada para una extensión.
createReview(Review, string, string)	Crea una nueva revisión para una extensión.
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Eliminación de un recurso de publicador como logotipo
deleteQuestion(string, string, number)	Elimina una pregunta existente y todas sus respuestas asociadas para una extensión. (eliminación temporal)
deleteResponse(string, string, number, number)	Elimina una respuesta de una extensión. (eliminación temporal)
deleteReview(string, string, number)	Elimina una revisión.
extensionValidator(AzureRestApiRequestModel)	Punto de conexión rest para validar si un publicador de Azure posee una extensión para un escenario comercial de terceros. Azure solo admite operaciones POST y la firma anterior no es típica de las operaciones 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 identificador de ruta o ubicación solo admite HTTP POST de forma anónima, de modo que la vista de página se pueda incrementar desde el cliente de Marketplace. Si intenta llamar a GET en esta ruta, se producirá una excepción. Sin esta implementación explícita, al llamar a GET en esta ruta pública se invoca la implementación getExtensionDailyStats anterior.
getExtensionEvents(string, string, number, Date, string, string)	Obtiene eventos de instalación o desinstalación de una extensión. Si se especifican los parámetros count y afterDate, count tiene prioridad.
getExtensionReports(string, string, number, number, Date)	Devuelve informes de extensión
getGalleryUserSettings(string, string)	Obtener todas las entradas de configuración para el ámbito de usuario o todos los usuarios especificados
getPackage(string, string, string, string, boolean, String)	Este punto de conexión se alcanza al descargar una extensión de VSTS desde la interfaz de usuario web.
getPublisher(string, number)
getPublisherAsset(string, string)	Obtención de un recurso de publicador como logotipo como una secuencia
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Devuelve una lista de preguntas con sus respuestas asociadas a una extensión.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Devuelve una lista de revisiones asociadas a una extensión.
getReviewsSummary(string, string, Date, Date)	Devuelve un resumen de las revisiones.
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	Incrementa una estadística diaria asociada a la extensión.
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	Punto de conexión de API para publicar eventos de instalación o desinstalación de la extensión. Esto está pensado para ser invocado por EMS solo para enviarnos datos relacionados con la instalación o desinstalación de una extensión.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Marca una preocupación con una pregunta existente para una extensión.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Enviar notificación
setGalleryUserSettings({[key: string]: any}, string)	Establecer todas las entradas de configuración para el ámbito de usuario o todos los usuarios especificados
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)	Punto de conexión REST para actualizar una extensión.
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)	Actualice el recurso del publicador como logotipo. Acepta el archivo de recursos como una secuencia de octetos y el nombre de archivo se pasa en los valores de encabezado.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Punto de conexión para agregar o modificar la pertenencia al publicador. Actualmente solo admite la adición o modificación de 1 usuario a la vez solo funciona para agregar miembros del mismo inquilino.
updateQuestion(Question, string, string, number)	Novedades una pregunta existente para una extensión.
updateResponse(Response, string, string, number, number)	Novedades una respuesta existente para una pregunta determinada para una extensión.
updateReview(ReviewPatch, string, string, number)	Novedades o marca una revisión
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Detalles del constructor

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parámetros

options: IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del 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

Contenido que se va a cargar

publisherName: string

extensionName: string

draftId: string

assetType: string

Devoluciones

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parámetros

content: string

Contenido que se va a cargar

publisherName: string

draftId: string

assetType: string

Devoluciones

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parámetros

publisherName: string

azurePublisherId: string

Devoluciones

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parámetros

category: ExtensionCategory

Devoluciones

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parámetros

publisherName: string

extensionName: string

Devoluciones

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parámetros

content: any

Contenido que se va a cargar

publisherName: string

product: String

Encabezado para pasar el tipo de producto del archivo de carga

fileName: String

Encabezado para pasar el nombre de archivo de los datos cargados

Devoluciones

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parámetros

content: any

Contenido que se va a cargar

extensionType: string

reCaptchaToken: string

Devoluciones

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parámetros

content: any

Contenido que se va a cargar

publisherName: string

extensionType: string

reCaptchaToken: string

Devoluciones

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parámetros

publisher: Publisher

Devoluciones

Promise<Publisher>

createQuestion(Question, string, string)

Crea una nueva pregunta para una extensión.

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

Parámetros

question: Question

Pregunta que se va a crear para la extensión.

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

Devoluciones

Promise<Question>

createResponse(Response, string, string, number)

Crea una nueva respuesta para una pregunta determinada para una extensión.

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

Parámetros

response: Response

Respuesta que se va a crear para la extensión.

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

questionId: number

Identificador de la pregunta para la que se va a crear la respuesta para la extensión.

Devoluciones

Promise<Response>

createReview(Review, string, string)

Crea una nueva revisión para una extensión.

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

Parámetros

review: Review

Revisión que se va a crear para la extensión

pubName: string

Nombre del publicador que publicó la extensión

extName: string

Nombre de la extensión.

Devoluciones

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parámetros

customerSupportRequest: CustomerSupportRequest

Devoluciones

Promise<void>

deleteExtension(string, string, string)

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

Parámetros

publisherName: string

extensionName: string

version: string

Devoluciones

Promise<void>

deleteExtensionById(string, string)

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

Parámetros

extensionId: string

version: string

Devoluciones

Promise<void>

deletePublisher(string)

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

Parámetros

publisherName: string

Devoluciones

Promise<void>

deletePublisherAsset(string, string)

Eliminación de un recurso de publicador como logotipo

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

Parámetros

publisherName: string

Nombre interno del publicador

assetType: string

Tipo de recurso. El valor predeterminado es 'logo'.

Devoluciones

Promise<void>

deleteQuestion(string, string, number)

Elimina una pregunta existente y todas sus respuestas asociadas para una extensión. (eliminación temporal)

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

Parámetros

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

questionId: number

Identificador de la pregunta que se va a eliminar para la extensión.

Devoluciones

Promise<void>

deleteResponse(string, string, number, number)

Elimina una respuesta de una extensión. (eliminación temporal)

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

Parámetros

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

questionId: number

Identifica la pregunta cuya respuesta se va a eliminar.

responseId: number

Identifica la respuesta que se va a eliminar.

Devoluciones

Promise<void>

deleteReview(string, string, number)

Elimina una revisión.

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

Parámetros

pubName: string

Nombre del publicador que publicó la extensión

extName: string

Nombre de la extensión.

reviewId: number

Identificador de la revisión que debe actualizarse

Devoluciones

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Punto de conexión rest para validar si un publicador de Azure posee una extensión para un escenario comercial de terceros. Azure solo admite operaciones POST y la firma anterior no es típica de las operaciones 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 los parámetros se envían en el cuerpo de la solicitud.

Devoluciones

Promise<void>

fetchDomainToken(string)

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

Parámetros

publisherName: string

Devoluciones

Promise<string>

generateKey(string, number)

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

Parámetros

keyType: string

expireCurrentSeconds: number

Devoluciones

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

Devoluciones

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

Encabezado para pasar el token de cuenta

Devoluciones

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

Encabezado para pasar el token de cuenta

Devoluciones

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

Encabezado para pasar el token de cuenta

Devoluciones

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

Devoluciones

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parámetros

publisherName: string

draftId: string

assetType: string

Devoluciones

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

Encabezado para pasar el token de cuenta

Devoluciones

Promise<ArrayBuffer>

getCategories(string)

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

Parámetros

languages: string

Devoluciones

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parámetros

categoryName: string

languages: string

product: string

Devoluciones

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

Devoluciones

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parámetros

publisherName: string

extensionName: string

version: string

Devoluciones

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parámetros

publisherName: string

extensionName: string

Devoluciones

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

Encabezado para pasar el token de cuenta

Devoluciones

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parámetros

extensionId: string

version: string

flags: ExtensionQueryFlags

Devoluciones

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

Devoluciones

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Este identificador de ruta o ubicación solo admite HTTP POST de forma anónima, de modo que la vista de página se pueda incrementar desde el cliente de Marketplace. Si intenta llamar a GET en esta ruta, se producirá una excepción. Sin esta implementación explícita, al llamar a GET en esta ruta pública se invoca la implementación getExtensionDailyStats anterior.

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

Parámetros

publisherName: string

Nombre del publicador

extensionName: string

Nombre de la extensión.

version: string

Versión de la extensión

Devoluciones

Promise<ExtensionDailyStats>

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

Obtiene eventos de instalación o desinstalación de una extensión. Si se especifican los parámetros count y afterDate, count tiene prioridad.

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

Parámetros

publisherName: string

Nombre del publicador

extensionName: string

Nombre de la extensión.

count: number

Recuento de eventos que se van a capturar, se aplica a cada tipo de evento.

afterDate: Date

Capturar eventos que se produjeron en o después de esta fecha

include: string

Opciones de filtro. Valores admitidos: instalar, desinstalar, revisar, adquirir, ventas. El valor predeterminado es capturar todos los tipos de eventos

includeProperty: string

Propiedades de evento que se van a incluir. Actualmente solo se admite "lastContactDetails" para eventos de desinstalación.

Devoluciones

Promise<ExtensionEvents>

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

Devuelve informes de extensión

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

Parámetros

publisherName: string

Nombre del publicador que publicó la extensión

extensionName: string

Nombre de la extensión.

days: number

Informe de últimos n días. Si se especifica afterDate y days, los días tendrán prioridad.

count: number

Número de eventos que se van a devolver

afterDate: Date

Use si desea capturar eventos más recientes que la fecha especificada.

Devoluciones

Promise<any>

getGalleryUserSettings(string, string)

Obtener todas las entradas de configuración para el ámbito de usuario o todos los usuarios especificados

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

Parámetros

userScope: string

User-Scope en el que se va a obtener el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.

key: string

Clave opcional en la que se van a filtrar todas las entradas

Devoluciones

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

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

Este punto de conexión se alcanza al descargar una extensión de VSTS desde la interfaz de usuario 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

Encabezado para pasar el token de cuenta

Devoluciones

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parámetros

publisherName: string

flags: number

Devoluciones

Promise<Publisher>

getPublisherAsset(string, string)

Obtención de un recurso de publicador como logotipo como una secuencia

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

Parámetros

publisherName: string

Nombre interno del publicador

assetType: string

Tipo de recurso. El valor predeterminado es 'logo'.

Devoluciones

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parámetros

publisherName: string

Devoluciones

Promise<Publisher>

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

Devuelve una lista de preguntas con sus respuestas asociadas a una extensión.

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

Parámetros

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

count: number

Número de preguntas que se van a recuperar (el valor predeterminado es 10).

page: number

Número de página del que se va a recuperar el conjunto de preguntas.

afterDate: Date

Si se proporciona, se devuelven las preguntas de resultados que se publicaron después de esta fecha.

Devoluciones

Promise<QuestionsResult>

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

Devuelve una lista de revisiones asociadas a una extensión.

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

Parámetros

publisherName: string

Nombre del publicador que publicó la extensión

extensionName: string

Nombre de la extensión.

count: number

Número de revisiones que se van a recuperar (el valor predeterminado es 5)

filterOptions: ReviewFilterOptions

FilterOptions para filtrar las revisiones vacías, etcetera, el valor predeterminado es none

beforeDate: Date

Use si desea capturar revisiones anteriores a la fecha especificada, el valor predeterminado es NULL.

afterDate: Date

Use si desea capturar revisiones más recientes que la fecha especificada, el valor predeterminado es NULL.

Devoluciones

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Devuelve un resumen de las revisiones.

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

Parámetros

pubName: string

Nombre del publicador que publicó la extensión

extName: string

Nombre de la extensión.

beforeDate: Date

Use si desea capturar el resumen de las revisiones anteriores a la fecha especificada, el valor predeterminado es NULL.

afterDate: Date

Use si desea capturar el resumen de las revisiones más recientes que la fecha especificada, el valor predeterminado es NULL.

Devoluciones

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

Devoluciones

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parámetros

keyType: string

Devoluciones

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

Devoluciones

Promise<ArrayBuffer>

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

Incrementa una estadística diaria asociada a la extensión.

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

Parámetros

publisherName: string

Nombre del publicador

extensionName: string

Nombre de la extensión.

version: string

Versión de la extensión

statType: string

Tipo de estadísticas que se va a incrementar

targetPlatform: string

Devoluciones

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

Devoluciones

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parámetros

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Devoluciones

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Punto de conexión de API para publicar eventos de instalación o desinstalación de la extensión. Esto está pensado para ser invocado por EMS solo para enviarnos datos relacionados con la instalación o desinstalación de una extensión.

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

Parámetros

extensionEvents: ExtensionEvents[]

Devoluciones

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

Contenido que se va a cargar

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Devoluciones

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parámetros

publisherName: string

Devoluciones

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parámetros

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Encabezado para pasar el token de cuenta

Devoluciones

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parámetros

publisherQuery: PublisherQuery

Devoluciones

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Marca una preocupación con una pregunta existente para una extensión.

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

Parámetros

concern: Concern

El usuario informó de preocupación con una pregunta para la extensión.

pubName: string

Nombre del publicador que publicó la extensión.

extName: string

Nombre de la extensión.

questionId: number

Identificador de la pregunta que se va a actualizar para la extensión.

Devoluciones

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parámetros

acquisitionRequest: ExtensionAcquisitionRequest

Devoluciones

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Enviar notificación

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

Parámetros

notificationData: NotificationsData

Denotar los datos necesarios para enviar una notificación

Devoluciones

Promise<void>

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

Establecer todas las entradas de configuración para el ámbito de usuario o todos los usuarios especificados

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

Parámetros

entries: {[key: string]: any}

Par clave-valor de todas las configuraciones que deben establecerse

userScope: string

User-Scope en el que se va a obtener el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.

Devoluciones

Promise<void>

shareExtension(string, string, string)

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

Parámetros

publisherName: string

extensionName: string

accountName: string

Devoluciones

Promise<void>

shareExtensionById(string, string)

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

Parámetros

extensionId: string

accountName: string

Devoluciones

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

Devoluciones

Promise<void>

unshareExtension(string, string, string)

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

Parámetros

publisherName: string

extensionName: string

accountName: string

Devoluciones

Promise<void>

unshareExtensionById(string, string)

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

Parámetros

extensionId: string

accountName: string

Devoluciones

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

Devoluciones

Promise<void>

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

Punto de conexión REST para actualizar una extensión.

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

Parámetros

content: any

Contenido que se va a cargar

publisherName: string

Nombre del publicador

extensionName: string

Nombre de la extensión.

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Este parámetro decide si es necesario invocar o no la comprobación de cambios de ámbito.

Devoluciones

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parámetros

extensionId: string

reCaptchaToken: string

Devoluciones

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parámetros

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Devoluciones

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parámetros

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Devoluciones

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

Contenido que se va a cargar

publisherName: string

extensionName: string

draftId: string

fileName: String

Encabezado para pasar el nombre de archivo de los datos cargados

Devoluciones

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parámetros

content: any

Contenido que se va a cargar

publisherName: string

draftId: string

fileName: String

Encabezado para pasar el nombre de archivo de los datos cargados

Devoluciones

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parámetros

publisher: Publisher

publisherName: string

Devoluciones

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Actualice el recurso del publicador como logotipo. Acepta el archivo de recursos como una secuencia de octetos y el nombre de archivo se pasa en los valores de encabezado.

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

Parámetros

content: any

Contenido que se va a cargar

publisherName: string

Nombre interno del publicador

assetType: string

Tipo de recurso. El valor predeterminado es 'logo'.

fileName: String

Encabezado para pasar el nombre de archivo de los datos cargados

Devoluciones

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Punto de conexión para agregar o modificar la pertenencia al publicador. Actualmente solo admite la adición o modificación de 1 usuario a la vez solo funciona para agregar miembros del mismo inquilino.

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

Parámetros

roleAssignments: PublisherUserRoleAssignmentRef[]

Lista de identificadores de usuario (dirección de correo electrónico) y rol que se van a agregar. Actualmente solo se admite una entrada.

publisherName: string

Nombre o identificador del publicador al que se deben agregar usuarios

limitToCallerIdentityDomain: boolean

Debe permitirse o no agregar entre inquilinos.

Devoluciones

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Novedades una pregunta existente para una extensión.

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

Parámetros

question: Question

Se ha actualizado la pregunta que se va a establecer para la extensión.

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

questionId: number

Identificador de la pregunta que se va a actualizar para la extensión.

Devoluciones

Promise<Question>

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

Novedades una respuesta existente para una pregunta determinada para una extensión.

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

Parámetros

response: Response

Respuesta actualizada que se va a establecer para la extensión.

publisherName: string

Nombre del publicador que publicó la extensión.

extensionName: string

Nombre de la extensión.

questionId: number

Identificador de la pregunta para la que se va a actualizar la respuesta de la extensión.

responseId: number

Identificador de la respuesta que se debe actualizar.

Devoluciones

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Novedades o marca una revisión

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

Parámetros

reviewPatch: ReviewPatch

Objeto ReviewPatch que contiene los cambios que se van a aplicar a la revisión

pubName: string

Nombre del publicador que publicó la extensión

extName: string

Nombre de la extensión.

reviewId: number

Identificador de la revisión que debe actualizarse

Devoluciones

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parámetros

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Devoluciones

Promise<void>

verifyDomainToken(string)

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

Parámetros

publisherName: string

Devoluciones

Promise<void>

Compartir a través de

GalleryRestClient class

Constructores

Propiedades

Métodos

Detalles del constructor

GalleryRestClient(IVssRestClientOptions)

Parámetros

Detalles de las propiedades

RESOURCE_AREA_ID

Valor de propiedad

Detalles del método

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

Parámetros

Devoluciones

addAssetForNewExtensionDraft(string, string, string, string)

Parámetros

Devoluciones

associateAzurePublisher(string, string)

Parámetros

Devoluciones

createCategory(ExtensionCategory)

Parámetros

Devoluciones

createDraftForEditExtension(string, string)

Parámetros

Devoluciones

createDraftForNewExtension(any, string, String, String)

Parámetros

Devoluciones

createExtension(any, string, string)

Parámetros

Devoluciones

createExtensionWithPublisher(any, string, string, string)

Parámetros

Devoluciones

createPublisher(Publisher)

Parámetros

Devoluciones

createQuestion(Question, string, string)

Parámetros

Devoluciones

createResponse(Response, string, string, number)

Parámetros

Devoluciones

createReview(Review, string, string)

Parámetros

Devoluciones

createSupportRequest(CustomerSupportRequest)

Parámetros

Devoluciones

deleteExtension(string, string, string)

Parámetros

Devoluciones

deleteExtensionById(string, string)

Parámetros

Devoluciones

deletePublisher(string)

Parámetros

Devoluciones

deletePublisherAsset(string, string)

Parámetros

Devoluciones

deleteQuestion(string, string, number)

Parámetros

Devoluciones

deleteResponse(string, string, number, number)

Parámetros

Devoluciones

deleteReview(string, string, number)

Parámetros

Devoluciones

extensionValidator(AzureRestApiRequestModel)

Parámetros

Devoluciones

fetchDomainToken(string)

Parámetros

Devoluciones

generateKey(string, number)

Parámetros