GalleryRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends: RestClientBase

Konstruktorer

GalleryRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

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)	Skapar en ny fråga för ett tillägg.
createResponse(Response, string, string, number)	Skapar ett nytt svar för en viss fråga för ett tillägg.
createReview(Review, string, string)	Skapar en ny granskning för ett tillägg
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Ta bort utgivartillgång som logotyp
deleteQuestion(string, string, number)	Tar bort en befintlig fråga och alla tillhörande svar för ett tillägg. (mjuk borttagning)
deleteResponse(string, string, number, number)	Tar bort ett svar för ett tillägg. (mjuk borttagning)
deleteReview(string, string, number)	Tar bort en granskning
extensionValidator(AzureRestApiRequestModel)	Rest-slutpunkt för att verifiera om en Azure-utgivare äger ett tillägg för tredje parts handelsscenario. Azure stöder endast POST-åtgärder och signaturen ovan är inte typisk för REST-åtgärderna. 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)	Det här routnings-/plats-ID:t stöder endast HTTP POST anonymt, så att den dagliga sidvisningsstatistiken kan ökas från Marketplace-klienten. Om du försöker anropa GET på den här vägen bör det resultera i ett undantag. Utan den här uttryckliga implementeringen anropar GET på den här offentliga vägen ovan GET-implementeringen GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Hämta installations-/avinstallationshändelser för ett tillägg. Om parametrarna count och afterDate anges har antalet företräde.
getExtensionReports(string, string, number, number, Date)	Returnerar tilläggsrapporter
getGalleryUserSettings(string, string)	Hämta alla inställningsposter för det angivna användar-/all-users-omfånget
getPackage(string, string, string, string, boolean, String)	Den här slutpunkten nås när du laddar ned ett VSTS-tillägg från webbgränssnittet
getPublisher(string, number)
getPublisherAsset(string, string)	Hämta utgivartillgång som logotyp som en dataström
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Returnerar en lista med frågor med deras svar som är associerade med ett tillägg.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Returnerar en lista över granskningar som är associerade med ett tillägg
getReviewsSummary(string, string, Date, Date)	Returnerar en sammanfattning av granskningarna
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	Ökar en daglig statistik som är associerad med tillägget
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	API-slutpunkt för att publicera installations-/avinstallationshändelser för tillägg. Detta är avsett att anropas av EMS endast för att skicka data som rör installation/avinstallation av ett tillägg.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Flaggar ett problem med en befintlig fråga för ett tillägg.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Skicka meddelande
setGalleryUserSettings({[key: string]: any}, string)	Ange alla inställningsposter för det angivna användar-/alla-användaromfånget
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)	REST-slutpunkt för att uppdatera ett tillägg.
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)	Uppdatera utgivartillgång som logotyp. Den accepterar tillgångsfilen som en oktettström och filnamnet skickas i rubrikvärden.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Slutpunkt för att lägga till/ändra utgivarmedlemskap. Stöder för närvarande endast tillägg/ändring av en användare åt gången Fungerar endast för att lägga till medlemmar i samma klientorganisation.
updateQuestion(Question, string, string, number)	Uppdateringar en befintlig fråga för ett tillägg.
updateResponse(Response, string, string, number, number)	Uppdateringar ett befintligt svar på en viss fråga för ett tillägg.
updateReview(ReviewPatch, string, string, number)	Uppdateringar eller Flaggar en granskning
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Konstruktorinformation

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

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

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

Parametrar

content: string

Innehåll som ska laddas upp

publisherName: string

extensionName: string

draftId: string

assetType: string

Returer

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parametrar

content: string

Innehåll som ska laddas upp

publisherName: string

draftId: string

assetType: string

Returer

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parametrar

publisherName: string

azurePublisherId: string

Returer

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parametrar

category: ExtensionCategory

Returer

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parametrar

publisherName: string

extensionName: string

Returer

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

product: String

Rubrik för att skicka nyttolastfilens produkttyp

fileName: String

Rubrik för att skicka filnamnet för uppladdade data

Returer

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parametrar

content: any

Innehåll som ska laddas upp

extensionType: string

reCaptchaToken: string

Returer

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

extensionType: string

reCaptchaToken: string

Returer

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parametrar

publisher: Publisher

Returer

Promise<Publisher>

createQuestion(Question, string, string)

Skapar en ny fråga för ett tillägg.

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

Parametrar

question: Question

Fråga som ska skapas för tillägget.

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

Returer

Promise<Question>

createResponse(Response, string, string, number)

Skapar ett nytt svar för en viss fråga för ett tillägg.

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

Parametrar

response: Response

Svar som ska skapas för tillägget.

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

questionId: number

Identifierare för frågan för vilken svar ska skapas för tillägget.

Returer

Promise<Response>

createReview(Review, string, string)

Skapar en ny granskning för ett tillägg

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

Parametrar

review: Review

Granskning som ska skapas för tillägget

pubName: string

Namnet på utgivaren som publicerade tillägget

extName: string

Namn på tillägget

Returer

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parametrar

customerSupportRequest: CustomerSupportRequest

Returer

Promise<void>

deleteExtension(string, string, string)

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

Parametrar

publisherName: string

extensionName: string

version: string

Returer

Promise<void>

deleteExtensionById(string, string)

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

Parametrar

extensionId: string

version: string

Returer

Promise<void>

deletePublisher(string)

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

Parametrar

publisherName: string

Returer

Promise<void>

deletePublisherAsset(string, string)

Ta bort utgivartillgång som logotyp

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

Parametrar

publisherName: string

Utgivarens interna namn

assetType: string

Typ av tillgång. Standardvärdet är "logo".

Returer

Promise<void>

deleteQuestion(string, string, number)

Tar bort en befintlig fråga och alla tillhörande svar för ett tillägg. (mjuk borttagning)

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

Parametrar

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

questionId: number

Identifierare för den fråga som ska tas bort för tillägget.

Returer

Promise<void>

deleteResponse(string, string, number, number)

Tar bort ett svar för ett tillägg. (mjuk borttagning)

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

Parametrar

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

questionId: number

Identifierar frågan vars svar ska tas bort.

responseId: number

Identifierar svaret som ska tas bort.

Returer

Promise<void>

deleteReview(string, string, number)

Tar bort en granskning

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

Parametrar

pubName: string

Namnet på utgivaren som publicerade tillägget

extName: string

Namn på tillägget

reviewId: number

Id för den granskning som behöver uppdateras

Returer

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Rest-slutpunkt för att verifiera om en Azure-utgivare äger ett tillägg för tredje parts handelsscenario. Azure stöder endast POST-åtgärder och signaturen ovan är inte typisk för REST-åtgärderna. 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>

Parametrar

azureRestApiRequestModel: AzureRestApiRequestModel

Alla parametrar skickas i begärandetexten

Returer

Promise<void>

fetchDomainToken(string)

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

Parametrar

publisherName: string

Returer

Promise<string>

generateKey(string, number)

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

Parametrar

keyType: string

expireCurrentSeconds: number

Returer

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parametrar

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Returer

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>

Parametrar

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

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>

Parametrar

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

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>

Parametrar

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parametrar

publisherName: string

draftId: string

assetType: string

extensionName: string

Returer

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parametrar

publisherName: string

draftId: string

assetType: string

Returer

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>

Parametrar

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

Promise<ArrayBuffer>

getCategories(string)

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

Parametrar

languages: string

Returer

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parametrar

categoryName: string

languages: string

product: string

Returer

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>

Parametrar

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Returer

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parametrar

publisherName: string

extensionName: string

version: string

Returer

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parametrar

publisherName: string

extensionName: string

Returer

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>

Parametrar

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parametrar

extensionId: string

version: string

flags: ExtensionQueryFlags

Returer

Promise<PublishedExtension>

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

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

Parametrar

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Returer

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Det här routnings-/plats-ID:t stöder endast HTTP POST anonymt, så att den dagliga sidvisningsstatistiken kan ökas från Marketplace-klienten. Om du försöker anropa GET på den här vägen bör det resultera i ett undantag. Utan den här uttryckliga implementeringen anropar GET på den här offentliga vägen ovan GET-implementeringen GetExtensionDailyStats.

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

Parametrar

publisherName: string

Utgivarens namn

extensionName: string

Namn på tillägget

version: string

Version av tillägget

Returer

Promise<ExtensionDailyStats>

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

Hämta installations-/avinstallationshändelser för ett tillägg. Om parametrarna count och afterDate anges har antalet företräde.

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

Parametrar

publisherName: string

Utgivarens namn

extensionName: string

Namn på tillägget

count: number

Antalet händelser som ska hämtas gäller för varje händelsetyp.

afterDate: Date

Hämta händelser som inträffat på eller efter det här datumet

include: string

Filteralternativ. Värden som stöds: installera, avinstallera, granska, förvärva, sälja. Standard är att hämta alla typer av händelser

includeProperty: string

Händelseegenskaper som ska inkluderas. För närvarande stöds endast "lastContactDetails" för avinstallationshändelser

Returer

Promise<ExtensionEvents>

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

Returnerar tilläggsrapporter

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

Parametrar

publisherName: string

Namnet på utgivaren som publicerade tillägget

extensionName: string

Namn på tillägget

days: number

Senaste n dagarnas rapport. Om afterDate och dagar har angetts prioriteras dagar

count: number

Antal händelser som ska returneras

afterDate: Date

Använd om du vill hämta händelser som är nyare än det angivna datumet

Returer

Promise<any>

getGalleryUserSettings(string, string)

Hämta alla inställningsposter för det angivna användar-/all-users-omfånget

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

Parametrar

userScope: string

User-Scope där värdet ska hämtas. Bör vara "jag" för den aktuella användaren eller "värden" för alla användare.

key: string

Valfri nyckel som alla poster ska filtreras under

Returer

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

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

Den här slutpunkten nås när du laddar ned ett VSTS-tillägg från webbgränssnittet

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

Parametrar

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parametrar

publisherName: string

flags: number

Returer

Promise<Publisher>

getPublisherAsset(string, string)

Hämta utgivartillgång som logotyp som en dataström

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

Parametrar

publisherName: string

Utgivarens interna namn

assetType: string

Typ av tillgång. Standardvärdet är "logo".

Returer

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parametrar

publisherName: string

Returer

Promise<Publisher>

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

Returnerar en lista med frågor med deras svar som är associerade med ett tillägg.

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

Parametrar

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

count: number

Antal frågor som ska hämtas (standardvärdet är 10).

page: number

Sidnummer från vilken uppsättning frågor som ska hämtas.

afterDate: Date

Om detta anges returneras resultatfrågor som har publicerats efter detta datum

Returer

Promise<QuestionsResult>

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

Returnerar en lista över granskningar som är associerade med ett tillägg

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

Parametrar

publisherName: string

Namnet på utgivaren som publicerade tillägget

extensionName: string

Namn på tillägget

count: number

Antal granskningar som ska hämtas (standardvärdet är 5)

filterOptions: ReviewFilterOptions

FilterAlternativ för att filtrera bort tomma recensioner osv., standardvärdet är ingen

beforeDate: Date

Använd om du vill hämta granskningar som är äldre än det angivna datumet, standardvärdet är null

afterDate: Date

Använd om du vill hämta recensioner som är nyare än det angivna datumet, standardvärdet är null

Returer

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Returnerar en sammanfattning av granskningarna

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

Parametrar

pubName: string

Namnet på utgivaren som publicerade tillägget

extName: string

Namn på tillägget

beforeDate: Date

Använd om du vill hämta en sammanfattning av granskningar som är äldre än det angivna datumet. Standardvärdet är null

afterDate: Date

Använd om du vill hämta en sammanfattning av recensioner som är nyare än det angivna datumet, standardvärdet är null

Returer

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>

Parametrar

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Returer

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parametrar

keyType: string

Returer

Promise<string>

getVerificationLog(string, string, string, string)

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

Parametrar

publisherName: string

extensionName: string

version: string

targetPlatform: string

Returer

Promise<ArrayBuffer>

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

Ökar en daglig statistik som är associerad med tillägget

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

Parametrar

publisherName: string

Utgivarens namn

extensionName: string

Namn på tillägget

version: string

Version av tillägget

statType: string

Typ av statistik som ska ökas

targetPlatform: string

Returer

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parametrar

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Returer

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parametrar

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Returer

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

API-slutpunkt för att publicera installations-/avinstallationshändelser för tillägg. Detta är avsett att anropas av EMS endast för att skicka data som rör installation/avinstallation av ett tillägg.

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

Parametrar

extensionEvents: ExtensionEvents[]

Returer

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>

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Returer

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parametrar

publisherName: string

Returer

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parametrar

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Rubrik för att skicka kontotoken

Returer

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parametrar

publisherQuery: PublisherQuery

Returer

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Flaggar ett problem med en befintlig fråga för ett tillägg.

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

Parametrar

concern: Concern

Användaren rapporterade problem med en fråga för tillägget.

pubName: string

Namnet på utgivaren som publicerade tillägget.

extName: string

Namnet på tillägget.

questionId: number

Identifierare för frågan som ska uppdateras för tillägget.

Returer

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametrar

acquisitionRequest: ExtensionAcquisitionRequest

Returer

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Skicka meddelande

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

Parametrar

notificationData: NotificationsData

Anger vilka data som behövs för att skicka meddelanden

Returer

Promise<void>

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

Ange alla inställningsposter för det angivna användar-/alla-användaromfånget

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

Parametrar

entries: {[key: string]: any}

Ett nyckel/värde-par med alla inställningar som måste anges

userScope: string

User-Scope där värdet ska hämtas. Bör vara "jag" för den aktuella användaren eller "värden" för alla användare.

Returer

Promise<void>

shareExtension(string, string, string)

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

Parametrar

publisherName: string

extensionName: string

accountName: string

Returer

Promise<void>

shareExtensionById(string, string)

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

Parametrar

extensionId: string

accountName: string

Returer

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parametrar

publisherName: string

extensionName: string

hostType: string

hostName: string

Returer

Promise<void>

unshareExtension(string, string, string)

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

Parametrar

publisherName: string

extensionName: string

accountName: string

Returer

Promise<void>

unshareExtensionById(string, string)

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

Parametrar

extensionId: string

accountName: string

Returer

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parametrar

publisherName: string

extensionName: string

hostType: string

hostName: string

Returer

Promise<void>

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

REST-slutpunkt för att uppdatera ett tillägg.

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

Utgivarens namn

extensionName: string

Namn på tillägget

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Den här parametern avgör om omfångsändringskontrollen måste anropas eller inte

Returer

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parametrar

extensionId: string

reCaptchaToken: string

Returer

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parametrar

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Returer

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parametrar

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Returer

Promise<void>

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

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

extensionName: string

draftId: string

fileName: String

Rubrik för att skicka filnamnet för uppladdade data

Returer

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

draftId: string

fileName: String

Rubrik för att skicka filnamnet för uppladdade data

Returer

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parametrar

publisher: Publisher

publisherName: string

Returer

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Uppdatera utgivartillgång som logotyp. Den accepterar tillgångsfilen som en oktettström och filnamnet skickas i rubrikvärden.

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

Parametrar

content: any

Innehåll som ska laddas upp

publisherName: string

Utgivarens interna namn

assetType: string

Typ av tillgång. Standardvärdet är "logo".

fileName: String

Rubrik för att skicka filnamnet för uppladdade data

Returer

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Slutpunkt för att lägga till/ändra utgivarmedlemskap. Stöder för närvarande endast tillägg/ändring av en användare åt gången Fungerar endast för att lägga till medlemmar i samma klientorganisation.

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

Parametrar

roleAssignments: PublisherUserRoleAssignmentRef[]

Lista över användaridentifierare (e-postadress) och roll som ska läggas till. För närvarande stöds endast en post.

publisherName: string

Namnet/ID:t för utgivaren som användare måste läggas till i

limitToCallerIdentityDomain: boolean

Ska tillägg mellan klientorganisationer tillåtas eller inte.

Returer

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Uppdateringar en befintlig fråga för ett tillägg.

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

Parametrar

question: Question

Uppdaterad fråga som ska ställas in för tillägget.

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

questionId: number

Identifierare för frågan som ska uppdateras för tillägget.

Returer

Promise<Question>

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

Uppdateringar ett befintligt svar på en viss fråga för ett tillägg.

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

Parametrar

response: Response

Uppdaterat svar som ska anges för tillägget.

publisherName: string

Namnet på utgivaren som publicerade tillägget.

extensionName: string

Namnet på tillägget.

questionId: number

Identifierare för frågan för vilken svar ska uppdateras för tillägget.

responseId: number

Identifierare för svaret som måste uppdateras.

Returer

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Uppdateringar eller Flaggar en granskning

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

Parametrar

reviewPatch: ReviewPatch

ReviewPatch-objekt som innehåller de ändringar som ska tillämpas på granskningen

pubName: string

Namnet på utgivaren som publicerade tillägget

extName: string

Namn på tillägget

reviewId: number

ID för den granskning som behöver uppdateras

Returer

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parametrar

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Returer

Promise<void>

verifyDomainToken(string)

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

Parametrar

publisherName: string

Returer

Promise<void>

Dela via

GalleryRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

GalleryRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

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

Parametrar

Returer

addAssetForNewExtensionDraft(string, string, string, string)

Parametrar

Returer

associateAzurePublisher(string, string)

Parametrar

Returer

createCategory(ExtensionCategory)

Parametrar

Returer

createDraftForEditExtension(string, string)

Parametrar

Returer

createDraftForNewExtension(any, string, String, String)

Parametrar

Returer

createExtension(any, string, string)

Parametrar

Returer

createExtensionWithPublisher(any, string, string, string)

Parametrar

Returer

createPublisher(Publisher)

Parametrar

Returer

createQuestion(Question, string, string)

Parametrar

Returer

createResponse(Response, string, string, number)

Parametrar

Returer

createReview(Review, string, string)

Parametrar

Returer

createSupportRequest(CustomerSupportRequest)

Parametrar

Returer

deleteExtension(string, string, string)

Parametrar

Returer

deleteExtensionById(string, string)

Parametrar

Returer

deletePublisher(string)

Parametrar

Returer

deletePublisherAsset(string, string)

Parametrar

Returer

deleteQuestion(string, string, number)

Parametrar

Returer

deleteResponse(string, string, number, number)

Parametrar

Returer

deleteReview(string, string, number)

Parametrar

Returer

extensionValidator(AzureRestApiRequestModel)

Parametrar

Returer

fetchDomainToken(string)

Parametrar

Returer

generateKey(string, number)

Parametrar