GalleryRestClient class

Odwołanie

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends: RestClientBase

Konstruktory

GalleryRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

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)	Tworzy nowe pytanie dotyczące rozszerzenia.
createResponse(Response, string, string, number)	Tworzy nową odpowiedź dla danego pytania dla rozszerzenia.
createReview(Review, string, string)	Tworzy nową recenzję rozszerzenia
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	Usuwanie elementu zawartości wydawcy, takiego jak logo
deleteQuestion(string, string, number)	Usuwa istniejące pytanie i wszystkie skojarzone z nim odpowiedzi dla rozszerzenia. (usuwanie nietrwałe)
deleteResponse(string, string, number, number)	Usuwa odpowiedź rozszerzenia. (usuwanie nietrwałe)
deleteReview(string, string, number)	Usuwa recenzję
extensionValidator(AzureRestApiRequestModel)	Punkt końcowy rest, aby sprawdzić, czy wydawca platformy Azure jest właścicielem rozszerzenia dla scenariusza handlu innej firmy. Platforma Azure obsługuje tylko operacje POST, a powyższy podpis nie jest typowy dla operacji 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)	Ten identyfikator trasy/lokalizacji obsługuje tylko anonimowo post PROTOKOŁU HTTP, dzięki czemu można zwiększać dzienny statystykę widoku strony z poziomu klienta witryny Marketplace. Próba wywołania metody GET na tej trasie powinna spowodować wyjątek. Bez tej jawnej implementacji wywołanie metody GET na tej trasie publicznej wywołuje powyższą implementację GET GetExtensionDailyStats.
getExtensionEvents(string, string, number, Date, string, string)	Pobieranie zdarzeń instalacji/odinstalowywania rozszerzenia. Jeśli określono parametry count i afterDate, pierwszeństwo ma liczba.
getExtensionReports(string, string, number, number, Date)	Zwraca raporty rozszerzeń
getGalleryUserSettings(string, string)	Pobieranie wszystkich wpisów ustawień dla danego zakresu użytkownika/wszystkich użytkowników
getPackage(string, string, string, string, boolean, String)	Ten punkt końcowy jest osiągany podczas pobierania rozszerzenia usługi VSTS z internetowego interfejsu użytkownika
getPublisher(string, number)
getPublisherAsset(string, string)	Pobieranie elementu zawartości wydawcy, takiego jak logo jako strumień
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	Zwraca listę pytań z odpowiedziami skojarzonymi z rozszerzeniem.
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	Zwraca listę przeglądów skojarzonych z rozszerzeniem
getReviewsSummary(string, string, Date, Date)	Zwraca podsumowanie przeglądów
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	Zwiększa dzienną statystykę skojarzoną z rozszerzeniem
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	Punkt końcowy interfejsu API do publikowania zdarzeń instalowania/odinstalowywania rozszerzenia. Ma to być wywoływane przez pakiet EMS tylko w celu wysyłania danych związanych z instalacją/odinstalowywaniem rozszerzenia.
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	Flaguje problem z istniejącym pytaniem dotyczącym rozszerzenia.
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	Wyślij powiadomienie
setGalleryUserSettings({[key: string]: any}, string)	Ustaw wszystkie wpisy ustawień dla danego zakresu użytkownika/wszystkich użytkowników
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)	Punkt końcowy REST w celu zaktualizowania rozszerzenia.
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)	Zaktualizuj element zawartości wydawcy, taki jak logo. Akceptuje plik elementu zawartości jako strumień oktetów, a nazwa pliku jest przekazywana w wartościach nagłówka.
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	Punkt końcowy do dodawania/modyfikowania członkostwa wydawcy. Obecnie obsługuje tylko dodawanie/modyfikowanie 1 użytkownika jednocześnie Działa tylko w przypadku dodawania członków tej samej dzierżawy.
updateQuestion(Question, string, string, number)	Aktualizacje istniejące pytanie dotyczące rozszerzenia.
updateResponse(Response, string, string, number, number)	Aktualizacje istniejącą odpowiedź dla danego pytania dotyczącego rozszerzenia.
updateReview(ReviewPatch, string, string, number)	Aktualizacje lub flaguje recenzję
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

Szczegóły konstruktora

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

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

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

Parametry

content: string

Zawartość do przekazania

publisherName: string

extensionName: string

draftId: string

assetType: string

Zwraca

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

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

Parametry

content: string

Zawartość do przekazania

publisherName: string

draftId: string

assetType: string

Zwraca

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

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

Parametry

publisherName: string

azurePublisherId: string

Zwraca

Promise<AzurePublisher>

createCategory(ExtensionCategory)

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

Parametry

category: ExtensionCategory

Zwraca

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

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

Parametry

publisherName: string

extensionName: string

Zwraca

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

product: String

Nagłówek umożliwiający przekazanie typu produktu pliku ładunku

fileName: String

Nagłówek umożliwiający przekazanie nazwy pliku przekazanych danych

Zwraca

Promise<ExtensionDraft>

createExtension(any, string, string)

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

Parametry

content: any

Zawartość do przekazania

extensionType: string

reCaptchaToken: string

Zwraca

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

extensionType: string

reCaptchaToken: string

Zwraca

Promise<PublishedExtension>

createPublisher(Publisher)

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

Parametry

publisher: Publisher

Zwraca

Promise<Publisher>

createQuestion(Question, string, string)

Tworzy nowe pytanie dotyczące rozszerzenia.

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

Parametry

question: Question

Pytanie, które ma zostać utworzone dla rozszerzenia.

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

Zwraca

Promise<Question>

createResponse(Response, string, string, number)

Tworzy nową odpowiedź dla danego pytania dla rozszerzenia.

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

Parametry

response: Response

Odpowiedź, która ma zostać utworzona dla rozszerzenia.

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

questionId: number

Identyfikator pytania, dla którego ma zostać utworzona odpowiedź dla rozszerzenia.

Zwraca

Promise<Response>

createReview(Review, string, string)

Tworzy nową recenzję rozszerzenia

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

Parametry

review: Review

Przegląd, który ma zostać utworzony dla rozszerzenia

pubName: string

Nazwa wydawcy, który opublikował rozszerzenie

extName: string

Nazwa rozszerzenia

Zwraca

Promise<Review>

createSupportRequest(CustomerSupportRequest)

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

Parametry

customerSupportRequest: CustomerSupportRequest

Zwraca

Promise<void>

deleteExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

Zwraca

Promise<void>

deleteExtensionById(string, string)

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

Parametry

extensionId: string

version: string

Zwraca

Promise<void>

deletePublisher(string)

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

Parametry

publisherName: string

Zwraca

Promise<void>

deletePublisherAsset(string, string)

Usuwanie elementu zawartości wydawcy, takiego jak logo

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

Parametry

publisherName: string

Wewnętrzna nazwa wydawcy

assetType: string

Typ elementu zawartości. Wartość domyślna to "logo".

Zwraca

Promise<void>

deleteQuestion(string, string, number)

Usuwa istniejące pytanie i wszystkie skojarzone z nim odpowiedzi dla rozszerzenia. (usuwanie nietrwałe)

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

Parametry

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

questionId: number

Identyfikator pytania, który ma zostać usunięty dla rozszerzenia.

Zwraca

Promise<void>

deleteResponse(string, string, number, number)

Usuwa odpowiedź rozszerzenia. (usuwanie nietrwałe)

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

Parametry

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

questionId: number

Określa pytanie, którego odpowiedź ma zostać usunięta.

responseId: number

Identyfikuje odpowiedź do usunięcia.

Zwraca

Promise<void>

deleteReview(string, string, number)

Usuwa recenzję

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

Parametry

pubName: string

Nazwa wydawcy, który opublikował rozszerzenie

extName: string

Nazwa rozszerzenia

reviewId: number

Identyfikator przeglądu, który należy zaktualizować

Zwraca

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Punkt końcowy rest, aby sprawdzić, czy wydawca platformy Azure jest właścicielem rozszerzenia dla scenariusza handlu innej firmy. Platforma Azure obsługuje tylko operacje POST, a powyższy podpis nie jest typowy dla operacji 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>

Parametry

azureRestApiRequestModel: AzureRestApiRequestModel

Wszystkie parametry są wysyłane w treści żądania

Zwraca

Promise<void>

fetchDomainToken(string)

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

Parametry

publisherName: string

Zwraca

Promise<string>

generateKey(string, number)

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

Parametry

keyType: string

expireCurrentSeconds: number

Zwraca

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

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

Parametry

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

Zwraca

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>

Parametry

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

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

Parametry

publisherName: string

draftId: string

assetType: string

extensionName: string

Zwraca

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

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

Parametry

publisherName: string

draftId: string

assetType: string

Zwraca

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>

Parametry

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

Promise<ArrayBuffer>

getCategories(string)

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

Parametry

languages: string

Zwraca

Promise<string[]>

getCategoryDetails(string, string, string)

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

Parametry

categoryName: string

languages: string

product: string

Zwraca

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>

Parametry

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

Zwraca

Promise<ProductCategory>

getCertificate(string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

Zwraca

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

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

Parametry

publisherName: string

extensionName: string

Zwraca

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>

Parametry

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

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

Parametry

extensionId: string

version: string

flags: ExtensionQueryFlags

Zwraca

Promise<PublishedExtension>

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

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

Parametry

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

Zwraca

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

Ten identyfikator trasy/lokalizacji obsługuje tylko anonimowo post PROTOKOŁU HTTP, dzięki czemu można zwiększać dzienny statystykę widoku strony z poziomu klienta witryny Marketplace. Próba wywołania metody GET na tej trasie powinna spowodować wyjątek. Bez tej jawnej implementacji wywołanie metody GET na tej trasie publicznej wywołuje powyższą implementację GET GetExtensionDailyStats.

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

Parametry

publisherName: string

Nazwa wydawcy

extensionName: string

Nazwa rozszerzenia

version: string

Wersja rozszerzenia

Zwraca

Promise<ExtensionDailyStats>

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

Pobieranie zdarzeń instalacji/odinstalowywania rozszerzenia. Jeśli określono parametry count i afterDate, pierwszeństwo ma liczba.

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

Parametry

publisherName: string

Nazwa wydawcy

extensionName: string

Nazwa rozszerzenia

count: number

Liczba zdarzeń do pobrania, ma zastosowanie do każdego typu zdarzenia.

afterDate: Date

Pobieranie zdarzeń, które wystąpiły w dniu lub po tej dacie

include: string

Opcje filtrowania. Obsługiwane wartości: instalowanie, odinstalowywanie, przeglądanie, pozyskiwanie, sprzedaż. Wartość domyślna to pobieranie wszystkich typów zdarzeń

includeProperty: string

Właściwości zdarzenia do uwzględnienia. Obecnie tylko element "lastContactDetails" jest obsługiwany w przypadku zdarzeń odinstalowywania

Zwraca

Promise<ExtensionEvents>

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

Zwraca raporty rozszerzeń

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

Parametry

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie

extensionName: string

Nazwa rozszerzenia

days: number

Raport z ostatnich n dni. Jeśli określono wartość afterDate i days, dni będą traktowane priorytetowo

count: number

Liczba zdarzeń do zwrócenia

afterDate: Date

Użyj polecenia , jeśli chcesz pobrać zdarzenia nowsze niż określona data

Zwraca

Promise<any>

getGalleryUserSettings(string, string)

Pobieranie wszystkich wpisów ustawień dla danego zakresu użytkownika/wszystkich użytkowników

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

Parametry

userScope: string

User-Scope, w którym ma być pobierana wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.

key: string

Klucz opcjonalny, pod którym mają być filtrować wszystkie wpisy

Zwraca

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

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

Ten punkt końcowy jest osiągany podczas pobierania rozszerzenia usługi VSTS z internetowego interfejsu użytkownika

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

Parametry

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

Promise<ArrayBuffer>

getPublisher(string, number)

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

Parametry

publisherName: string

flags: number

Zwraca

Promise<Publisher>

getPublisherAsset(string, string)

Pobieranie elementu zawartości wydawcy, takiego jak logo jako strumień

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

Parametry

publisherName: string

Wewnętrzna nazwa wydawcy

assetType: string

Typ elementu zawartości. Wartość domyślna to "logo".

Zwraca

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

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

Parametry

publisherName: string

Zwraca

Promise<Publisher>

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

Zwraca listę pytań z odpowiedziami skojarzonymi z rozszerzeniem.

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

Parametry

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

count: number

Liczba pytań do pobrania (wartość domyślna to 10).

page: number

Numer strony, z którego ma zostać pobrany zestaw pytań.

afterDate: Date

Jeśli zostanie podana, zostaną zwrócone pytania dotyczące wyników, które zostały opublikowane po tej dacie

Zwraca

Promise<QuestionsResult>

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

Zwraca listę przeglądów skojarzonych z rozszerzeniem

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

Parametry

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie

extensionName: string

Nazwa rozszerzenia

count: number

Liczba recenzji do pobrania (wartość domyślna to 5)

filterOptions: ReviewFilterOptions

FilterOptions, aby odfiltrować puste recenzje itpetera, domyślnie nie ma wartości

beforeDate: Date

Użyj polecenia , jeśli chcesz pobrać przeglądy starsze niż określona data, wartość domyślna to null

afterDate: Date

Użyj polecenia , jeśli chcesz pobrać recenzje nowsze niż określona data, domyślnie ma wartość null

Zwraca

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

Zwraca podsumowanie przeglądów

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

Parametry

pubName: string

Nazwa wydawcy, który opublikował rozszerzenie

extName: string

Nazwa rozszerzenia

beforeDate: Date

Użyj polecenia , jeśli chcesz pobrać podsumowanie przeglądów starszych niż określona data, wartość domyślna to null

afterDate: Date

Użyj polecenia , jeśli chcesz pobrać podsumowanie przeglądów nowszych niż określona data, wartość domyślna to null

Zwraca

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>

Parametry

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

Zwraca

Promise<ProductCategoriesResult>

getSigningKey(string)

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

Parametry

keyType: string

Zwraca

Promise<string>

getVerificationLog(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

version: string

targetPlatform: string

Zwraca

Promise<ArrayBuffer>

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

Zwiększa dzienną statystykę skojarzoną z rozszerzeniem

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

Parametry

publisherName: string

Nazwa wydawcy

extensionName: string

Nazwa rozszerzenia

version: string

Wersja rozszerzenia

statType: string

Typ statystyki do przyrostu

targetPlatform: string

Zwraca

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

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

Parametry

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

Zwraca

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

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

Parametry

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

Zwraca

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

Punkt końcowy interfejsu API do publikowania zdarzeń instalowania/odinstalowywania rozszerzenia. Ma to być wywoływane przez pakiet EMS tylko w celu wysyłania danych związanych z instalacją/odinstalowywaniem rozszerzenia.

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

Parametry

extensionEvents: ExtensionEvents[]

Zwraca

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>

Parametry

content: any

Zawartość do przekazania

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Zwraca

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

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

Parametry

publisherName: string

Zwraca

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

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

Parametry

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

Nagłówek umożliwiający przekazanie tokenu konta

Zwraca

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

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

Parametry

publisherQuery: PublisherQuery

Zwraca

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

Flaguje problem z istniejącym pytaniem dotyczącym rozszerzenia.

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

Parametry

concern: Concern

Użytkownik zgłosił problem z pytaniem dotyczącym rozszerzenia.

pubName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extName: string

Nazwa rozszerzenia.

questionId: number

Identyfikator pytania, który ma zostać zaktualizowany dla rozszerzenia.

Zwraca

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametry

acquisitionRequest: ExtensionAcquisitionRequest

Zwraca

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

Wyślij powiadomienie

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

Parametry

notificationData: NotificationsData

Oznaczanie danych potrzebnych do wysłania powiadomienia

Zwraca

Promise<void>

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

Ustaw wszystkie wpisy ustawień dla danego zakresu użytkownika/wszystkich użytkowników

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

Parametry

entries: {[key: string]: any}

Para klucz-wartość wszystkich ustawień, które należy ustawić

userScope: string

User-Scope, w którym ma być pobierana wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.

Zwraca

Promise<void>

shareExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

accountName: string

Zwraca

Promise<void>

shareExtensionById(string, string)

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

Parametry

extensionId: string

accountName: string

Zwraca

Promise<void>

shareExtensionWithHost(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

hostType: string

hostName: string

Zwraca

Promise<void>

unshareExtension(string, string, string)

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

Parametry

publisherName: string

extensionName: string

accountName: string

Zwraca

Promise<void>

unshareExtensionById(string, string)

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

Parametry

extensionId: string

accountName: string

Zwraca

Promise<void>

unshareExtensionWithHost(string, string, string, string)

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

Parametry

publisherName: string

extensionName: string

hostType: string

hostName: string

Zwraca

Promise<void>

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

Punkt końcowy REST w celu zaktualizowania rozszerzenia.

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

Nazwa wydawcy

extensionName: string

Nazwa rozszerzenia

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

Ten parametr określa, czy należy wywołać sprawdzanie zmiany zakresu, czy nie

Zwraca

Promise<PublishedExtension>

updateExtensionById(string, string)

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

Parametry

extensionId: string

reCaptchaToken: string

Zwraca

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

Parametry

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

Zwraca

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

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

Parametry

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

Zwraca

Promise<void>

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

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

extensionName: string

draftId: string

fileName: String

Nagłówek do przekazania nazwy pliku przekazanych danych

Zwraca

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

draftId: string

fileName: String

Nagłówek do przekazania nazwy pliku przekazanych danych

Zwraca

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

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

Parametry

publisher: Publisher

publisherName: string

Zwraca

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

Zaktualizuj element zawartości wydawcy, taki jak logo. Akceptuje plik elementu zawartości jako strumień oktetów, a nazwa pliku jest przekazywana w wartościach nagłówka.

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

Parametry

content: any

Zawartość do przekazania

publisherName: string

Wewnętrzna nazwa wydawcy

assetType: string

Typ elementu zawartości. Wartość domyślna to "logo".

fileName: String

Nagłówek do przekazania nazwy pliku przekazanych danych

Zwraca

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

Punkt końcowy do dodawania/modyfikowania członkostwa wydawcy. Obecnie obsługuje tylko dodawanie/modyfikowanie 1 użytkownika jednocześnie Działa tylko w przypadku dodawania członków tej samej dzierżawy.

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

Parametry

roleAssignments: PublisherUserRoleAssignmentRef[]

Lista identyfikatorów użytkowników (adres e-mail) i rola do dodania. Obecnie obsługiwany jest tylko jeden wpis.

publisherName: string

Nazwa/identyfikator wydawcy, do którego należy dodać użytkowników

limitToCallerIdentityDomain: boolean

Czy dodatki między dzierżawami powinny być dozwolone lub nie.

Zwraca

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

Aktualizacje istniejące pytanie dotyczące rozszerzenia.

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

Parametry

question: Question

Zaktualizowano pytanie, które ma zostać ustawione dla rozszerzenia.

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

questionId: number

Identyfikator pytania, który ma zostać zaktualizowany dla rozszerzenia.

Zwraca

Promise<Question>

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

Aktualizacje istniejącą odpowiedź dla danego pytania dotyczącego rozszerzenia.

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

Parametry

response: Response

Zaktualizowano odpowiedź, która ma zostać ustawiona dla rozszerzenia.

publisherName: string

Nazwa wydawcy, który opublikował rozszerzenie.

extensionName: string

Nazwa rozszerzenia.

questionId: number

Identyfikator pytania, dla którego ma zostać zaktualizowana odpowiedź dla rozszerzenia.

responseId: number

Identyfikator odpowiedzi, która musi zostać zaktualizowana.

Zwraca

Promise<Response>

updateReview(ReviewPatch, string, string, number)

Aktualizacje lub flaguje recenzję

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

Parametry

reviewPatch: ReviewPatch

ReviewPatch, obiekt zawierający zmiany, które mają zostać zastosowane do przeglądu

pubName: string

Nazwa wydawcy, który opublikował rozszerzenie

extName: string

Nazwa rozszerzenia

reviewId: number

Identyfikator przeglądu, który należy zaktualizować

Zwraca

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

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

Parametry

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

Zwraca

Promise<void>

verifyDomainToken(string)

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

Parametry

publisherName: string

Zwraca

Promise<void>

Udostępnij za pośrednictwem

GalleryRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

GalleryRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

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

Parametry

Zwraca

addAssetForNewExtensionDraft(string, string, string, string)

Parametry

Zwraca

associateAzurePublisher(string, string)

Parametry

Zwraca

createCategory(ExtensionCategory)

Parametry

Zwraca

createDraftForEditExtension(string, string)

Parametry

Zwraca

createDraftForNewExtension(any, string, String, String)

Parametry

Zwraca

createExtension(any, string, string)

Parametry

Zwraca

createExtensionWithPublisher(any, string, string, string)

Parametry

Zwraca

createPublisher(Publisher)

Parametry

Zwraca

createQuestion(Question, string, string)

Parametry

Zwraca

createResponse(Response, string, string, number)

Parametry

Zwraca

createReview(Review, string, string)

Parametry

Zwraca

createSupportRequest(CustomerSupportRequest)

Parametry

Zwraca

deleteExtension(string, string, string)

Parametry

Zwraca

deleteExtensionById(string, string)

Parametry

Zwraca

deletePublisher(string)

Parametry

Zwraca

deletePublisherAsset(string, string)

Parametry

Zwraca

deleteQuestion(string, string, number)

Parametry

Zwraca

deleteResponse(string, string, number, number)

Parametry

Zwraca

deleteReview(string, string, number)

Parametry

Zwraca

extensionValidator(AzureRestApiRequestModel)

Parametry

Zwraca

fetchDomainToken(string)

Parametry

Zwraca

generateKey(string, number)

Parametry