GalleryRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS
- Extends
Constructeurs
| Gallery |
Propriétés
| RESOURCE_AREA_ID |
Méthodes
Détails du constructeur
GalleryRestClient(IVssRestClientOptions)
Détails de la propriété
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValeur de propriété
string
Détails de la méthode
addAssetForEditExtensionDraft(string, string, string, string, string)
function addAssetForEditExtensionDraft(content: string, publisherName: string, extensionName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>Paramètres
- content
-
string
Contenu à charger
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
- assetType
-
string
Retours
Promise<ExtensionDraftAsset>
addAssetForNewExtensionDraft(string, string, string, string)
function addAssetForNewExtensionDraft(content: string, publisherName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>Paramètres
- content
-
string
Contenu à charger
- publisherName
-
string
- draftId
-
string
- assetType
-
string
Retours
Promise<ExtensionDraftAsset>
associateAzurePublisher(string, string)
function associateAzurePublisher(publisherName: string, azurePublisherId: string): Promise<AzurePublisher>Paramètres
- publisherName
-
string
- azurePublisherId
-
string
Retours
Promise<AzurePublisher>
createCategory(ExtensionCategory)
function createCategory(category: ExtensionCategory): Promise<ExtensionCategory>Paramètres
- category
- ExtensionCategory
Retours
Promise<ExtensionCategory>
createDraftForEditExtension(string, string)
function createDraftForEditExtension(publisherName: string, extensionName: string): Promise<ExtensionDraft>Paramètres
- publisherName
-
string
- extensionName
-
string
Retours
Promise<ExtensionDraft>
createDraftForNewExtension(any, string, String, String)
function createDraftForNewExtension(content: any, publisherName: string, product: String, fileName?: String): Promise<ExtensionDraft>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
- product
-
String
En-tête pour passer le type de produit du fichier de charge utile
- fileName
-
String
En-tête pour transmettre le nom de fichier des données chargées
Retours
Promise<ExtensionDraft>
createExtension(any, string, string)
function createExtension(content: any, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>Paramètres
- content
-
any
Contenu à charger
- extensionType
-
string
- reCaptchaToken
-
string
Retours
Promise<PublishedExtension>
createExtensionWithPublisher(any, string, string, string)
function createExtensionWithPublisher(content: any, publisherName: string, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
- extensionType
-
string
- reCaptchaToken
-
string
Retours
Promise<PublishedExtension>
createPublisher(Publisher)
function createPublisher(publisher: Publisher): Promise<Publisher>Paramètres
- publisher
- Publisher
Retours
Promise<Publisher>
createQuestion(Question, string, string)
Crée une question pour une extension.
function createQuestion(question: Question, publisherName: string, extensionName: string): Promise<Question>Paramètres
- question
- Question
Question à créer pour l’extension.
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
Retours
Promise<Question>
createResponse(Response, string, string, number)
Crée une réponse pour une question donnée pour une extension.
function createResponse(response: Response, publisherName: string, extensionName: string, questionId: number): Promise<Response>Paramètres
- response
- Response
Réponse à créer pour l’extension.
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- questionId
-
number
Identificateur de la question pour laquelle la réponse doit être créée pour l’extension.
Retours
Promise<Response>
createReview(Review, string, string)
Crée une révision pour une extension
function createReview(review: Review, pubName: string, extName: string): Promise<Review>Paramètres
- review
- Review
Révision à créer pour l’extension
- pubName
-
string
Nom de l’éditeur qui a publié l’extension
- extName
-
string
Nom de l’extension.
Retours
Promise<Review>
createSupportRequest(CustomerSupportRequest)
function createSupportRequest(customerSupportRequest: CustomerSupportRequest): Promise<void>Paramètres
- customerSupportRequest
- CustomerSupportRequest
Retours
Promise<void>
deleteExtension(string, string, string)
function deleteExtension(publisherName: string, extensionName: string, version?: string): Promise<void>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
Retours
Promise<void>
deleteExtensionById(string, string)
function deleteExtensionById(extensionId: string, version?: string): Promise<void>Paramètres
- extensionId
-
string
- version
-
string
Retours
Promise<void>
deletePublisher(string)
function deletePublisher(publisherName: string): Promise<void>Paramètres
- publisherName
-
string
Retours
Promise<void>
deletePublisherAsset(string, string)
Supprimer l’élément multimédia de l’éditeur comme le logo
function deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>Paramètres
- publisherName
-
string
Nom interne de l’éditeur
- assetType
-
string
Type de ressource. La valeur par défaut est 'logo'.
Retours
Promise<void>
deleteQuestion(string, string, number)
Supprime une question existante et toutes ses réponses associées pour une extension. (suppression réversible)
function deleteQuestion(publisherName: string, extensionName: string, questionId: number): Promise<void>Paramètres
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- questionId
-
number
Identificateur de la question à supprimer pour l’extension.
Retours
Promise<void>
deleteResponse(string, string, number, number)
Supprime une réponse pour une extension. (suppression réversible)
function deleteResponse(publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<void>Paramètres
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- questionId
-
number
Identifie la question dont la réponse doit être supprimée.
- responseId
-
number
Identifie la réponse à supprimer.
Retours
Promise<void>
deleteReview(string, string, number)
Supprime une révision
function deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>Paramètres
- pubName
-
string
Nom de l’éditeur qui a publié l’extension
- extName
-
string
Nom de l’extension.
- reviewId
-
number
ID de la révision à mettre à jour
Retours
Promise<void>
extensionValidator(AzureRestApiRequestModel)
Point de terminaison rest pour vérifier si un éditeur Azure possède une extension pour le scénario de commerce tiers. Azure prend uniquement en charge les opérations POST et la signature ci-dessus n’est pas typique des opérations 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>Paramètres
- azureRestApiRequestModel
- AzureRestApiRequestModel
Tous les paramètres sont envoyés dans le corps de la demande
Retours
Promise<void>
fetchDomainToken(string)
function fetchDomainToken(publisherName: string): Promise<string>Paramètres
- publisherName
-
string
Retours
Promise<string>
generateKey(string, number)
function generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>Paramètres
- keyType
-
string
- expireCurrentSeconds
-
number
Retours
Promise<void>
getAcquisitionOptions(string, string, boolean, boolean)
function getAcquisitionOptions(itemId: string, installationTarget: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean): Promise<AcquisitionOptions>Paramètres
- itemId
-
string
- installationTarget
-
string
- testCommerce
-
boolean
- isFreeOrTrialInstall
-
boolean
Retours
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>Paramètres
- extensionId
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
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>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
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>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
Promise<ArrayBuffer>
getAssetFromEditExtensionDraft(string, string, string, string)
function getAssetFromEditExtensionDraft(publisherName: string, draftId: string, assetType: string, extensionName: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- draftId
-
string
- assetType
-
string
- extensionName
-
string
Retours
Promise<ArrayBuffer>
getAssetFromNewExtensionDraft(string, string, string)
function getAssetFromNewExtensionDraft(publisherName: string, draftId: string, assetType: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- draftId
-
string
- assetType
-
string
Retours
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>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- assetToken
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
Promise<ArrayBuffer>
getCategories(string)
function getCategories(languages?: string): Promise<string[]>Paramètres
- languages
-
string
Retours
Promise<string[]>
getCategoryDetails(string, string, string)
function getCategoryDetails(categoryName: string, languages?: string, product?: string): Promise<CategoriesResult>Paramètres
- categoryName
-
string
- languages
-
string
- product
-
string
Retours
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>Paramètres
- product
-
string
- categoryId
-
string
- lcid
-
number
- source
-
string
- productVersion
-
string
- skus
-
string
- subSkus
-
string
- productArchitecture
-
string
Retours
Promise<ProductCategory>
getCertificate(string, string, string)
function getCertificate(publisherName: string, extensionName: string, version?: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
Retours
Promise<ArrayBuffer>
getContentVerificationLog(string, string)
function getContentVerificationLog(publisherName: string, extensionName: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- extensionName
-
string
Retours
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>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- flags
- ExtensionQueryFlags
- accountToken
-
string
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
Promise<PublishedExtension>
getExtensionById(string, string, ExtensionQueryFlags)
function getExtensionById(extensionId: string, version?: string, flags?: ExtensionQueryFlags): Promise<PublishedExtension>Paramètres
- extensionId
-
string
- version
-
string
- flags
- ExtensionQueryFlags
Retours
Promise<PublishedExtension>
getExtensionDailyStats(string, string, number, Daily, Date)
function getExtensionDailyStats(publisherName: string, extensionName: string, days?: number, aggregate?: Daily, afterDate?: Date): Promise<ExtensionDailyStats>Paramètres
- publisherName
-
string
- extensionName
-
string
- days
-
number
- aggregate
- Daily
- afterDate
-
Date
Retours
Promise<ExtensionDailyStats>
getExtensionDailyStatsAnonymous(string, string, string)
Cet ID d’itinéraire/d’emplacement prend uniquement en charge HTTP POST de manière anonyme, de sorte que les statistiques quotidiennes de l’affichage de la page peuvent être incrémentées à partir du client de la Place de marché. La tentative d’appel get sur cet itinéraire doit entraîner une exception. Sans cette implémentation explicite, l’appel de GET sur cette route publique appelle l’implémentation GET ci-dessus GetExtensionDailyStats.
function getExtensionDailyStatsAnonymous(publisherName: string, extensionName: string, version: string): Promise<ExtensionDailyStats>Paramètres
- publisherName
-
string
Nom de l’éditeur
- extensionName
-
string
Nom de l’extension.
- version
-
string
Version de l’extension
Retours
Promise<ExtensionDailyStats>
getExtensionEvents(string, string, number, Date, string, string)
Obtenir les événements d’installation/désinstallation d’une extension. Si les paramètres count et afterDate sont spécifiés, count est prioritaire.
function getExtensionEvents(publisherName: string, extensionName: string, count?: number, afterDate?: Date, include?: string, includeProperty?: string): Promise<ExtensionEvents>Paramètres
- publisherName
-
string
Nom de l’éditeur
- extensionName
-
string
Nom de l’extension.
- count
-
number
Le nombre d’événements à récupérer s’applique à chaque type d’événement.
- afterDate
-
Date
Récupérer les événements qui se sont produits à cette date ou après celle-ci
- include
-
string
Options de filtre. Valeurs prises en charge : installation, désinstallation, révision, acquisition, ventes. La valeur par défaut consiste à extraire tous les types d’événements
- includeProperty
-
string
Propriétés d’événement à inclure. Actuellement, seul « lastContactDetails » est pris en charge pour les événements de désinstallation
Retours
Promise<ExtensionEvents>
getExtensionReports(string, string, number, number, Date)
Retourne les rapports d’extension
function getExtensionReports(publisherName: string, extensionName: string, days?: number, count?: number, afterDate?: Date): Promise<any>Paramètres
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension
- extensionName
-
string
Nom de l’extension.
- days
-
number
Rapport des n derniers jours. Si afterDate et days sont spécifiés, les jours sont prioritaires
- count
-
number
Nombre d’événements à retourner
- afterDate
-
Date
Utilisez si vous souhaitez récupérer des événements plus récents que la date spécifiée
Retours
Promise<any>
getGalleryUserSettings(string, string)
Obtenir toutes les entrées de paramètre pour l’étendue utilisateur/tous les utilisateurs donné
function getGalleryUserSettings(userScope: string, key?: string): Promise<{[key: string]: any}>Paramètres
- userScope
-
string
User-Scope à laquelle obtenir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.
- key
-
string
Clé facultative sous laquelle filtrer toutes les entrées
Retours
Promise<{[key: string]: any}>
getPackage(string, string, string, string, boolean, String)
Ce point de terminaison est atteint lorsque vous téléchargez une extension VSTS à partir de l’interface utilisateur web
function getPackage(publisherName: string, extensionName: string, version: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
Promise<ArrayBuffer>
getPublisher(string, number)
function getPublisher(publisherName: string, flags?: number): Promise<Publisher>Paramètres
- publisherName
-
string
- flags
-
number
Retours
Promise<Publisher>
getPublisherAsset(string, string)
Obtenir une ressource d’éditeur comme un logo en tant que flux
function getPublisherAsset(publisherName: string, assetType?: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
Nom interne de l’éditeur
- assetType
-
string
Type de ressource. La valeur par défaut est 'logo'.
Retours
Promise<ArrayBuffer>
getPublisherWithoutToken(string)
function getPublisherWithoutToken(publisherName: string): Promise<Publisher>Paramètres
- publisherName
-
string
Retours
Promise<Publisher>
getQuestions(string, string, number, number, Date)
Retourne une liste de questions avec leurs réponses associées à une extension.
function getQuestions(publisherName: string, extensionName: string, count?: number, page?: number, afterDate?: Date): Promise<QuestionsResult>Paramètres
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- count
-
number
Nombre de questions à récupérer (10 par défaut).
- page
-
number
Numéro de page à partir duquel l’ensemble de questions doit être récupéré.
- afterDate
-
Date
Si elles sont fournies, les questions sur les résultats qui ont été publiées après cette date sont retournées.
Retours
Promise<QuestionsResult>
getReviews(string, string, number, ReviewFilterOptions, Date, Date)
Retourne une liste de révisions associées à une extension
function getReviews(publisherName: string, extensionName: string, count?: number, filterOptions?: ReviewFilterOptions, beforeDate?: Date, afterDate?: Date): Promise<ReviewsResult>Paramètres
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension
- extensionName
-
string
Nom de l’extension.
- count
-
number
Nombre de révisions à récupérer (5 par défaut)
- filterOptions
- ReviewFilterOptions
FilterOptions pour filtrer les révisions vides, etc., les valeurs par défaut sont none
- beforeDate
-
Date
Utilisez si vous souhaitez récupérer des révisions antérieures à la date spécifiée, la valeur par défaut est null
- afterDate
-
Date
Utilisez si vous souhaitez récupérer les révisions plus récentes que la date spécifiée, la valeur par défaut est null
Retours
Promise<ReviewsResult>
getReviewsSummary(string, string, Date, Date)
Retourne un résumé des révisions
function getReviewsSummary(pubName: string, extName: string, beforeDate?: Date, afterDate?: Date): Promise<ReviewSummary>Paramètres
- pubName
-
string
Nom de l’éditeur qui a publié l’extension
- extName
-
string
Nom de l’extension.
- beforeDate
-
Date
Utilisez si vous souhaitez récupérer le résumé des révisions antérieures à la date spécifiée, la valeur par défaut est null
- afterDate
-
Date
Utilisez si vous souhaitez récupérer le résumé des révisions plus récentes que la date spécifiée, la valeur par défaut est null
Retours
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>Paramètres
- product
-
string
- lcid
-
number
- source
-
string
- productVersion
-
string
- skus
-
string
- subSkus
-
string
Retours
Promise<ProductCategoriesResult>
getSigningKey(string)
function getSigningKey(keyType: string): Promise<string>Paramètres
- keyType
-
string
Retours
Promise<string>
getVerificationLog(string, string, string, string)
function getVerificationLog(publisherName: string, extensionName: string, version: string, targetPlatform?: string): Promise<ArrayBuffer>Paramètres
- publisherName
-
string
- extensionName
-
string
- version
-
string
- targetPlatform
-
string
Retours
Promise<ArrayBuffer>
incrementExtensionDailyStat(string, string, string, string, string)
Incrémente une statistique quotidienne associée à l’extension
function incrementExtensionDailyStat(publisherName: string, extensionName: string, version: string, statType: string, targetPlatform?: string): Promise<void>Paramètres
- publisherName
-
string
Nom de l’éditeur
- extensionName
-
string
Nom de l’extension.
- version
-
string
Version de l’extension
- statType
-
string
Type de statistiques à incrémenter
- targetPlatform
-
string
Retours
Promise<void>
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
function performEditExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, extensionName: string, draftId: string): Promise<ExtensionDraft>Paramètres
- draftPatch
- ExtensionDraftPatch
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
Retours
Promise<ExtensionDraft>
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
function performNewExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, draftId: string): Promise<ExtensionDraft>Paramètres
- draftPatch
- ExtensionDraftPatch
- publisherName
-
string
- draftId
-
string
Retours
Promise<ExtensionDraft>
publishExtensionEvents(ExtensionEvents[])
Point de terminaison d’API pour publier des événements d’installation/désinstallation de l’extension. Cela est destiné à être appelé par EMS uniquement pour nous envoyer des données relatives à l’installation/désinstallation d’une extension.
function publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>Paramètres
- extensionEvents
Retours
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>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
- extensionName
-
string
- extensionType
-
string
- reCaptchaToken
-
string
- bypassScopeCheck
-
boolean
Retours
Promise<PublishedExtension>
queryAssociatedAzurePublisher(string)
function queryAssociatedAzurePublisher(publisherName: string): Promise<AzurePublisher>Paramètres
- publisherName
-
string
Retours
Promise<AzurePublisher>
queryExtensions(ExtensionQuery, string, String)
function queryExtensions(extensionQuery: ExtensionQuery, accountToken?: string, accountTokenHeader?: String): Promise<ExtensionQueryResult>Paramètres
- extensionQuery
- ExtensionQuery
- accountToken
-
string
- accountTokenHeader
-
String
En-tête pour passer le jeton de compte
Retours
Promise<ExtensionQueryResult>
queryPublishers(PublisherQuery)
function queryPublishers(publisherQuery: PublisherQuery): Promise<PublisherQueryResult>Paramètres
- publisherQuery
- PublisherQuery
Retours
Promise<PublisherQueryResult>
reportQuestion(Concern, string, string, number)
Signale un problème avec une question existante pour une extension.
function reportQuestion(concern: Concern, pubName: string, extName: string, questionId: number): Promise<Concern>Paramètres
- concern
- Concern
L’utilisateur a signalé un problème avec une question pour l’extension.
- pubName
-
string
Nom de l’éditeur qui a publié l’extension.
- extName
-
string
Nom de l’extension.
- questionId
-
number
Identificateur de la question à mettre à jour pour l’extension.
Retours
Promise<Concern>
requestAcquisition(ExtensionAcquisitionRequest)
function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>Paramètres
- acquisitionRequest
- ExtensionAcquisitionRequest
Retours
Promise<ExtensionAcquisitionRequest>
sendNotifications(NotificationsData)
Envoyer une notification
function sendNotifications(notificationData: NotificationsData): Promise<void>Paramètres
- notificationData
- NotificationsData
Dénotage des données nécessaires à l’envoi de la notification
Retours
Promise<void>
setGalleryUserSettings({[key: string]: any}, string)
Définir toutes les entrées de paramètre pour l’étendue utilisateur/tous les utilisateurs donné
function setGalleryUserSettings(entries: {[key: string]: any}, userScope: string): Promise<void>Paramètres
- entries
-
{[key: string]: any}
Paire clé-valeur de tous les paramètres à définir
- userScope
-
string
User-Scope à laquelle obtenir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.
Retours
Promise<void>
shareExtension(string, string, string)
function shareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>Paramètres
- publisherName
-
string
- extensionName
-
string
- accountName
-
string
Retours
Promise<void>
shareExtensionById(string, string)
function shareExtensionById(extensionId: string, accountName: string): Promise<void>Paramètres
- extensionId
-
string
- accountName
-
string
Retours
Promise<void>
shareExtensionWithHost(string, string, string, string)
function shareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>Paramètres
- publisherName
-
string
- extensionName
-
string
- hostType
-
string
- hostName
-
string
Retours
Promise<void>
unshareExtension(string, string, string)
function unshareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>Paramètres
- publisherName
-
string
- extensionName
-
string
- accountName
-
string
Retours
Promise<void>
unshareExtensionById(string, string)
function unshareExtensionById(extensionId: string, accountName: string): Promise<void>Paramètres
- extensionId
-
string
- accountName
-
string
Retours
Promise<void>
unshareExtensionWithHost(string, string, string, string)
function unshareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>Paramètres
- publisherName
-
string
- extensionName
-
string
- hostType
-
string
- hostName
-
string
Retours
Promise<void>
updateExtension(any, string, string, string, string, boolean)
Point de terminaison REST pour mettre à jour une extension.
function updateExtension(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
Nom de l’éditeur
- extensionName
-
string
Nom de l’extension.
- extensionType
-
string
- reCaptchaToken
-
string
- bypassScopeCheck
-
boolean
Ce paramètre détermine si le changement d’étendue case activée doit être appelé ou non
Retours
Promise<PublishedExtension>
updateExtensionById(string, string)
function updateExtensionById(extensionId: string, reCaptchaToken?: string): Promise<PublishedExtension>Paramètres
- extensionId
-
string
- reCaptchaToken
-
string
Retours
Promise<PublishedExtension>
updateExtensionProperties(string, string, PublishedExtensionFlags)
function updateExtensionProperties(publisherName: string, extensionName: string, flags: PublishedExtensionFlags): Promise<PublishedExtension>Paramètres
- publisherName
-
string
- extensionName
-
string
- flags
- PublishedExtensionFlags
Retours
Promise<PublishedExtension>
updateExtensionStatistics(ExtensionStatisticUpdate, string, string)
function updateExtensionStatistics(extensionStatisticsUpdate: ExtensionStatisticUpdate, publisherName: string, extensionName: string): Promise<void>Paramètres
- extensionStatisticsUpdate
- ExtensionStatisticUpdate
- publisherName
-
string
- extensionName
-
string
Retours
Promise<void>
updatePayloadInDraftForEditExtension(any, string, string, string, String)
function updatePayloadInDraftForEditExtension(content: any, publisherName: string, extensionName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
- fileName
-
String
En-tête pour passer le nom de fichier des données chargées
Retours
Promise<ExtensionDraft>
updatePayloadInDraftForNewExtension(any, string, string, String)
function updatePayloadInDraftForNewExtension(content: any, publisherName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
- draftId
-
string
- fileName
-
String
En-tête pour passer le nom de fichier des données chargées
Retours
Promise<ExtensionDraft>
updatePublisher(Publisher, string)
function updatePublisher(publisher: Publisher, publisherName: string): Promise<Publisher>Paramètres
- publisher
- Publisher
- publisherName
-
string
Retours
Promise<Publisher>
updatePublisherAsset(any, string, string, String)
Mettre à jour la ressource de l’éditeur comme le logo. Il accepte le fichier de ressources en tant que flux d’octets et le nom du fichier est passé dans les valeurs d’en-tête.
function updatePublisherAsset(content: any, publisherName: string, assetType?: string, fileName?: String): Promise<{[key: string]: string}>Paramètres
- content
-
any
Contenu à charger
- publisherName
-
string
Nom interne de l’éditeur
- assetType
-
string
Type de ressource. La valeur par défaut est 'logo'.
- fileName
-
String
En-tête pour passer le nom de fichier des données chargées
Retours
Promise<{[key: string]: string}>
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)
Point de terminaison pour ajouter/modifier l’appartenance à l’éditeur. Prend actuellement en charge uniquement l’ajout/modification d’un utilisateur à la fois Fonctionne uniquement pour l’ajout de membres du même locataire.
function updatePublisherMembers(roleAssignments: PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<PublisherRoleAssignment[]>Paramètres
- roleAssignments
Liste des identificateurs d’utilisateur (adresse e-mail) et du rôle à ajouter. Actuellement, une seule entrée est prise en charge.
- publisherName
-
string
Nom/id de l’éditeur auquel les utilisateurs doivent être ajoutés
- limitToCallerIdentityDomain
-
boolean
Les ajouts entre locataires doivent être autorisés ou non.
Retours
Promise<PublisherRoleAssignment[]>
updateQuestion(Question, string, string, number)
Mises à jour une question existante pour une extension.
function updateQuestion(question: Question, publisherName: string, extensionName: string, questionId: number): Promise<Question>Paramètres
- question
- Question
Mise à jour de la question à définir pour l’extension.
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- questionId
-
number
Identificateur de la question à mettre à jour pour l’extension.
Retours
Promise<Question>
updateResponse(Response, string, string, number, number)
Mises à jour une réponse existante à une question donnée pour une extension.
function updateResponse(response: Response, publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<Response>Paramètres
- response
- Response
Réponse mise à jour à définir pour l’extension.
- publisherName
-
string
Nom de l’éditeur qui a publié l’extension.
- extensionName
-
string
Nom de l’extension.
- questionId
-
number
Identificateur de la question pour laquelle la réponse doit être mise à jour pour l’extension.
- responseId
-
number
Identificateur de la réponse qui doit être mise à jour.
Retours
Promise<Response>
updateReview(ReviewPatch, string, string, number)
Mises à jour ou signale une révision
function updateReview(reviewPatch: ReviewPatch, pubName: string, extName: string, reviewId: number): Promise<ReviewPatch>Paramètres
- reviewPatch
- ReviewPatch
Objet ReviewPatch qui contient les modifications à appliquer à la révision
- pubName
-
string
Nom de l’éditeur qui a publié l’extension
- extName
-
string
Nom de l’extension.
- reviewId
-
number
ID de la révision à mettre à jour
Retours
Promise<ReviewPatch>
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
function updateVSCodeWebExtensionStatistics(itemName: string, version: string, statType: VSCodeWebExtensionStatisicsType): Promise<void>Paramètres
- itemName
-
string
- version
-
string
- statType
- VSCodeWebExtensionStatisicsType
Retours
Promise<void>
verifyDomainToken(string)
function verifyDomainToken(publisherName: string): Promise<void>Paramètres
- publisherName
-
string
Retours
Promise<void>