GalleryRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Gallery |
Свойства
| RESOURCE_AREA_ID |
Методы
Сведения о конструкторе
GalleryRestClient(IVssRestClientOptions)
Сведения о свойстве
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringЗначение свойства
string
Сведения о методе
addAssetForEditExtensionDraft(string, string, string, string, string)
function addAssetForEditExtensionDraft(content: string, publisherName: string, extensionName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>Параметры
- content
-
string
Содержимое для отправки
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
- assetType
-
string
Возвращаемое значение
Promise<ExtensionDraftAsset>
addAssetForNewExtensionDraft(string, string, string, string)
function addAssetForNewExtensionDraft(content: string, publisherName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>Параметры
- content
-
string
Содержимое для отправки
- publisherName
-
string
- draftId
-
string
- assetType
-
string
Возвращаемое значение
Promise<ExtensionDraftAsset>
associateAzurePublisher(string, string)
function associateAzurePublisher(publisherName: string, azurePublisherId: string): Promise<AzurePublisher>Параметры
- publisherName
-
string
- azurePublisherId
-
string
Возвращаемое значение
Promise<AzurePublisher>
createCategory(ExtensionCategory)
function createCategory(category: ExtensionCategory): Promise<ExtensionCategory>Параметры
- category
- ExtensionCategory
Возвращаемое значение
Promise<ExtensionCategory>
createDraftForEditExtension(string, string)
function createDraftForEditExtension(publisherName: string, extensionName: string): Promise<ExtensionDraft>Параметры
- publisherName
-
string
- extensionName
-
string
Возвращаемое значение
Promise<ExtensionDraft>
createDraftForNewExtension(any, string, String, String)
function createDraftForNewExtension(content: any, publisherName: string, product: String, fileName?: String): Promise<ExtensionDraft>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
- product
-
String
Заголовок для передачи типа продукта файла полезных данных
- fileName
-
String
Заголовок для передачи имени файла отправленных данных
Возвращаемое значение
Promise<ExtensionDraft>
createExtension(any, string, string)
function createExtension(content: any, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>Параметры
- content
-
any
Содержимое для отправки
- extensionType
-
string
- reCaptchaToken
-
string
Возвращаемое значение
Promise<PublishedExtension>
createExtensionWithPublisher(any, string, string, string)
function createExtensionWithPublisher(content: any, publisherName: string, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
- extensionType
-
string
- reCaptchaToken
-
string
Возвращаемое значение
Promise<PublishedExtension>
createPublisher(Publisher)
createQuestion(Question, string, string)
Создает новый вопрос для расширения.
function createQuestion(question: Question, publisherName: string, extensionName: string): Promise<Question>Параметры
- question
- Question
Вопрос, который необходимо создать для расширения.
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
Возвращаемое значение
Promise<Question>
createResponse(Response, string, string, number)
Создает новый ответ для заданного вопроса для расширения.
function createResponse(response: Response, publisherName: string, extensionName: string, questionId: number): Promise<Response>Параметры
- response
- Response
Ответ, который необходимо создать для расширения.
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- questionId
-
number
Идентификатор вопроса, для которого необходимо создать ответ для расширения.
Возвращаемое значение
Promise<Response>
createReview(Review, string, string)
Создает новую проверку расширения
function createReview(review: Review, pubName: string, extName: string): Promise<Review>Параметры
- review
- Review
Проверка, которую необходимо создать для расширения
- pubName
-
string
Имя издателя, публикующего расширение
- extName
-
string
Имя расширения
Возвращаемое значение
Promise<Review>
createSupportRequest(CustomerSupportRequest)
function createSupportRequest(customerSupportRequest: CustomerSupportRequest): Promise<void>Параметры
- customerSupportRequest
- CustomerSupportRequest
Возвращаемое значение
Promise<void>
deleteExtension(string, string, string)
function deleteExtension(publisherName: string, extensionName: string, version?: string): Promise<void>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
Возвращаемое значение
Promise<void>
deleteExtensionById(string, string)
function deleteExtensionById(extensionId: string, version?: string): Promise<void>Параметры
- extensionId
-
string
- version
-
string
Возвращаемое значение
Promise<void>
deletePublisher(string)
function deletePublisher(publisherName: string): Promise<void>Параметры
- publisherName
-
string
Возвращаемое значение
Promise<void>
deletePublisherAsset(string, string)
Удаление ресурса издателя, например логотипа
function deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>Параметры
- publisherName
-
string
Внутреннее имя издателя
- assetType
-
string
Тип ресурса. Значением по умолчанию является логотип.
Возвращаемое значение
Promise<void>
deleteQuestion(string, string, number)
Удаляет существующий вопрос и все связанные с ним ответы для расширения. (обратимое удаление)
function deleteQuestion(publisherName: string, extensionName: string, questionId: number): Promise<void>Параметры
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- questionId
-
number
Идентификатор вопроса, который необходимо удалить для расширения.
Возвращаемое значение
Promise<void>
deleteResponse(string, string, number, number)
Удаляет ответ для расширения. (обратимое удаление)
function deleteResponse(publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<void>Параметры
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- questionId
-
number
Определяет вопрос, ответ которого требуется удалить.
- responseId
-
number
Определяет ответ, который нужно удалить.
Возвращаемое значение
Promise<void>
deleteReview(string, string, number)
Удаляет проверку
function deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>Параметры
- pubName
-
string
Имя издателя, публикующего расширение
- extName
-
string
Имя расширения
- reviewId
-
number
Идентификатор проверки, которая должна быть обновлена
Возвращаемое значение
Promise<void>
extensionValidator(AzureRestApiRequestModel)
Конечная точка для проверки того, принадлежит ли издатель Azure расширению для стороннего коммерческого сценария. Azure поддерживает только операции POST и указанную выше подпись не являются типичными для операций 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>Параметры
- azureRestApiRequestModel
- AzureRestApiRequestModel
Все параметры отправляются в тексте запроса
Возвращаемое значение
Promise<void>
fetchDomainToken(string)
function fetchDomainToken(publisherName: string): Promise<string>Параметры
- publisherName
-
string
Возвращаемое значение
Promise<string>
generateKey(string, number)
function generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>Параметры
- keyType
-
string
- expireCurrentSeconds
-
number
Возвращаемое значение
Promise<void>
getAcquisitionOptions(string, string, boolean, boolean)
function getAcquisitionOptions(itemId: string, installationTarget: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean): Promise<AcquisitionOptions>Параметры
- itemId
-
string
- installationTarget
-
string
- testCommerce
-
boolean
- isFreeOrTrialInstall
-
boolean
Возвращаемое значение
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>Параметры
- extensionId
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
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>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
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>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
Promise<ArrayBuffer>
getAssetFromEditExtensionDraft(string, string, string, string)
function getAssetFromEditExtensionDraft(publisherName: string, draftId: string, assetType: string, extensionName: string): Promise<ArrayBuffer>Параметры
- publisherName
-
string
- draftId
-
string
- assetType
-
string
- extensionName
-
string
Возвращаемое значение
Promise<ArrayBuffer>
getAssetFromNewExtensionDraft(string, string, string)
function getAssetFromNewExtensionDraft(publisherName: string, draftId: string, assetType: string): Promise<ArrayBuffer>Параметры
- publisherName
-
string
- draftId
-
string
- assetType
-
string
Возвращаемое значение
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>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- assetType
-
string
- assetToken
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
Promise<ArrayBuffer>
getCategories(string)
function getCategories(languages?: string): Promise<string[]>Параметры
- languages
-
string
Возвращаемое значение
Promise<string[]>
getCategoryDetails(string, string, string)
function getCategoryDetails(categoryName: string, languages?: string, product?: string): Promise<CategoriesResult>Параметры
- categoryName
-
string
- languages
-
string
- product
-
string
Возвращаемое значение
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>Параметры
- product
-
string
- categoryId
-
string
- lcid
-
number
- source
-
string
- productVersion
-
string
- skus
-
string
- subSkus
-
string
- productArchitecture
-
string
Возвращаемое значение
Promise<ProductCategory>
getCertificate(string, string, string)
function getCertificate(publisherName: string, extensionName: string, version?: string): Promise<ArrayBuffer>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
Возвращаемое значение
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>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- flags
- ExtensionQueryFlags
- accountToken
-
string
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
Promise<PublishedExtension>
getExtensionById(string, string, ExtensionQueryFlags)
function getExtensionById(extensionId: string, version?: string, flags?: ExtensionQueryFlags): Promise<PublishedExtension>Параметры
- extensionId
-
string
- version
-
string
- flags
- ExtensionQueryFlags
Возвращаемое значение
Promise<PublishedExtension>
getExtensionDailyStats(string, string, number, Daily, Date)
function getExtensionDailyStats(publisherName: string, extensionName: string, days?: number, aggregate?: Daily, afterDate?: Date): Promise<ExtensionDailyStats>Параметры
- publisherName
-
string
- extensionName
-
string
- days
-
number
- aggregate
- Daily
- afterDate
-
Date
Возвращаемое значение
Promise<ExtensionDailyStats>
getExtensionDailyStatsAnonymous(string, string, string)
Этот идентификатор маршрута или расположения поддерживает только HTTP POST анонимно, чтобы ежедневное представление страницы можно увеличить из клиента Marketplace. Попытка вызова GET на этом маршруте должна привести к исключению. Без этой явной реализации вызов GET на этом общедоступном маршруте вызывает указанную выше реализацию GET GetExtensionDailyStats.
function getExtensionDailyStatsAnonymous(publisherName: string, extensionName: string, version: string): Promise<ExtensionDailyStats>Параметры
- publisherName
-
string
Имя издателя
- extensionName
-
string
Имя расширения
- version
-
string
Версия расширения
Возвращаемое значение
Promise<ExtensionDailyStats>
getExtensionEvents(string, string, number, Date, string, string)
Получение событий установки и удаления расширения. Если указаны оба параметра count и afterDate, число имеет приоритет.
function getExtensionEvents(publisherName: string, extensionName: string, count?: number, afterDate?: Date, include?: string, includeProperty?: string): Promise<ExtensionEvents>Параметры
- publisherName
-
string
Имя издателя
- extensionName
-
string
Имя расширения
- count
-
number
Количество событий для получения, применяется к каждому типу события.
- afterDate
-
Date
Получение событий, которые произошли после этой даты или после нее
- include
-
string
Параметры фильтрации. Поддерживаемые значения: установка, удаление, проверка, приобретение, продажи. По умолчанию требуется получить все типы событий
- includeProperty
-
string
Свойства события для включения. В настоящее время для событий удаления поддерживается только lastContactDetails.
Возвращаемое значение
Promise<ExtensionEvents>
getExtensionReports(string, string, number, number, Date)
Возвращает отчеты о расширении
function getExtensionReports(publisherName: string, extensionName: string, days?: number, count?: number, afterDate?: Date): Promise<any>Параметры
- publisherName
-
string
Имя издателя, публикующего расширение
- extensionName
-
string
Имя расширения
- days
-
number
Отчет последних n дней. Если задано значение afterDate и дней, дни будут иметь приоритет
- count
-
number
Количество возвращаемых событий
- afterDate
-
Date
Используйте, если вы хотите получить события более поздней, чем указанная дата
Возвращаемое значение
Promise<any>
getGalleryUserSettings(string, string)
Получение всех записей параметров для заданной области пользователя или всех пользователей
function getGalleryUserSettings(userScope: string, key?: string): Promise<{[key: string]: any}>Параметры
- userScope
-
string
User-Scope, по которому нужно получить значение. Должно быть "мне" для текущего пользователя или "узла" для всех пользователей.
- key
-
string
Необязательный ключ для фильтрации всех записей
Возвращаемое значение
Promise<{[key: string]: any}>
getPackage(string, string, string, string, boolean, String)
Эта конечная точка попадает при скачивании расширения VSTS из веб-интерфейса
function getPackage(publisherName: string, extensionName: string, version: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- accountToken
-
string
- acceptDefault
-
boolean
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
Promise<ArrayBuffer>
getPublisher(string, number)
function getPublisher(publisherName: string, flags?: number): Promise<Publisher>Параметры
- publisherName
-
string
- flags
-
number
Возвращаемое значение
Promise<Publisher>
getPublisherAsset(string, string)
Получение ресурса издателя, например логотипа в виде потока
function getPublisherAsset(publisherName: string, assetType?: string): Promise<ArrayBuffer>Параметры
- publisherName
-
string
Внутреннее имя издателя
- assetType
-
string
Тип ресурса. Значением по умолчанию является логотип.
Возвращаемое значение
Promise<ArrayBuffer>
getPublisherWithoutToken(string)
function getPublisherWithoutToken(publisherName: string): Promise<Publisher>Параметры
- publisherName
-
string
Возвращаемое значение
Promise<Publisher>
getQuestions(string, string, number, number, Date)
Возвращает список вопросов с их ответами, связанными с расширением.
function getQuestions(publisherName: string, extensionName: string, count?: number, page?: number, afterDate?: Date): Promise<QuestionsResult>Параметры
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- count
-
number
Количество вопросов для получения (по умолчанию — 10).
- page
-
number
Номер страницы, из которого требуется получить набор вопросов.
- afterDate
-
Date
Если это указано, результаты возвращаются, которые были размещены после этой даты
Возвращаемое значение
Promise<QuestionsResult>
getReviews(string, string, number, ReviewFilterOptions, Date, Date)
Возвращает список проверок, связанных с расширением
function getReviews(publisherName: string, extensionName: string, count?: number, filterOptions?: ReviewFilterOptions, beforeDate?: Date, afterDate?: Date): Promise<ReviewsResult>Параметры
- publisherName
-
string
Имя издателя, публикующего расширение
- extensionName
-
string
Имя расширения
- count
-
number
Количество полученных проверок (по умолчанию — 5)
- filterOptions
- ReviewFilterOptions
FilterOptions для фильтрации пустых отзывов etcetera, по умолчанию — нет.
- beforeDate
-
Date
Используйте, если вы хотите получить отзывы старше указанной даты, по умолчанию имеет значение NULL.
- afterDate
-
Date
Используйте, если вы хотите получить проверки более поздней, чем указанная дата, по умолчанию имеет значение NULL.
Возвращаемое значение
Promise<ReviewsResult>
getReviewsSummary(string, string, Date, Date)
Возвращает сводку проверок
function getReviewsSummary(pubName: string, extName: string, beforeDate?: Date, afterDate?: Date): Promise<ReviewSummary>Параметры
- pubName
-
string
Имя издателя, публикующего расширение
- extName
-
string
Имя расширения
- beforeDate
-
Date
Используйте, если вы хотите получить сводку отзывов старше указанной даты, по умолчанию используется значение NULL.
- afterDate
-
Date
Используйте, если вы хотите получить сводку отзывов более новой, чем указанная дата, по умолчанию имеет значение NULL.
Возвращаемое значение
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>Параметры
- product
-
string
- lcid
-
number
- source
-
string
- productVersion
-
string
- skus
-
string
- subSkus
-
string
Возвращаемое значение
Promise<ProductCategoriesResult>
getSigningKey(string)
function getSigningKey(keyType: string): Promise<string>Параметры
- keyType
-
string
Возвращаемое значение
Promise<string>
getVerificationLog(string, string, string, string)
function getVerificationLog(publisherName: string, extensionName: string, version: string, targetPlatform?: string): Promise<ArrayBuffer>Параметры
- publisherName
-
string
- extensionName
-
string
- version
-
string
- targetPlatform
-
string
Возвращаемое значение
Promise<ArrayBuffer>
getVSCodeExtensionLatestVersion(string, string)
Конечная точка для получения последних версий расширения VS Code.
function getVSCodeExtensionLatestVersion(publisherName: string, extensionName: string): Promise<PublishedExtension>Параметры
- publisherName
-
string
Имя издателя запрошенного расширения VS Code.
- extensionName
-
string
Имя расширения.
Возвращаемое значение
Promise<PublishedExtension>
incrementExtensionDailyStat(string, string, string, string, string)
Увеличивает ежедневную статистику, связанную с расширением
function incrementExtensionDailyStat(publisherName: string, extensionName: string, version: string, statType: string, targetPlatform?: string): Promise<void>Параметры
- publisherName
-
string
Имя издателя
- extensionName
-
string
Имя расширения
- version
-
string
Версия расширения
- statType
-
string
Тип статистики для увеличения
- targetPlatform
-
string
Возвращаемое значение
Promise<void>
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
function performEditExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, extensionName: string, draftId: string): Promise<ExtensionDraft>Параметры
- draftPatch
- ExtensionDraftPatch
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
Возвращаемое значение
Promise<ExtensionDraft>
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
function performNewExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, draftId: string): Promise<ExtensionDraft>Параметры
- draftPatch
- ExtensionDraftPatch
- publisherName
-
string
- draftId
-
string
Возвращаемое значение
Promise<ExtensionDraft>
publishExtensionEvents(ExtensionEvents[])
Конечная точка API для публикации событий установки и удаления расширения. Это предназначено для вызова EMS только для отправки данных, связанных с установкой или удалением расширения.
function publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>Параметры
- extensionEvents
Возвращаемое значение
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>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
- extensionName
-
string
- extensionType
-
string
- reCaptchaToken
-
string
- bypassScopeCheck
-
boolean
Возвращаемое значение
Promise<PublishedExtension>
queryAssociatedAzurePublisher(string)
function queryAssociatedAzurePublisher(publisherName: string): Promise<AzurePublisher>Параметры
- publisherName
-
string
Возвращаемое значение
Promise<AzurePublisher>
queryExtensions(ExtensionQuery, string, String)
function queryExtensions(extensionQuery: ExtensionQuery, accountToken?: string, accountTokenHeader?: String): Promise<ExtensionQueryResult>Параметры
- extensionQuery
- ExtensionQuery
- accountToken
-
string
- accountTokenHeader
-
String
Заголовок для передачи маркера учетной записи
Возвращаемое значение
Promise<ExtensionQueryResult>
queryPublishers(PublisherQuery)
function queryPublishers(publisherQuery: PublisherQuery): Promise<PublisherQueryResult>Параметры
- publisherQuery
- PublisherQuery
Возвращаемое значение
Promise<PublisherQueryResult>
reportQuestion(Concern, string, string, number)
Помечает проблему с существующим вопросом для расширения.
function reportQuestion(concern: Concern, pubName: string, extName: string, questionId: number): Promise<Concern>Параметры
- concern
- Concern
Пользователь сообщил о проблеме с вопросом для расширения.
- pubName
-
string
Имя издателя, публикующего расширение.
- extName
-
string
Имя расширения.
- questionId
-
number
Идентификатор вопроса, который необходимо обновить для расширения.
Возвращаемое значение
Promise<Concern>
requestAcquisition(ExtensionAcquisitionRequest)
function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>Параметры
- acquisitionRequest
- ExtensionAcquisitionRequest
Возвращаемое значение
Promise<ExtensionAcquisitionRequest>
sendNotifications(NotificationsData)
Отправка уведомления
function sendNotifications(notificationData: NotificationsData): Promise<void>Параметры
- notificationData
- NotificationsData
Определение данных, необходимых для отправки уведомления
Возвращаемое значение
Promise<void>
setGalleryUserSettings({[key: string]: any}, string)
Настройка всех записей параметров для заданной области пользователя или всех пользователей
function setGalleryUserSettings(entries: {[key: string]: any}, userScope: string): Promise<void>Параметры
- entries
-
{[key: string]: any}
Пара "ключ-значение" всех параметров, которые необходимо задать
- userScope
-
string
User-Scope, по которому нужно получить значение. Должно быть "мне" для текущего пользователя или "узла" для всех пользователей.
Возвращаемое значение
Promise<void>
shareExtension(string, string, string)
function shareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>Параметры
- publisherName
-
string
- extensionName
-
string
- accountName
-
string
Возвращаемое значение
Promise<void>
shareExtensionById(string, string)
function shareExtensionById(extensionId: string, accountName: string): Promise<void>Параметры
- extensionId
-
string
- accountName
-
string
Возвращаемое значение
Promise<void>
shareExtensionWithHost(string, string, string, string)
function shareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>Параметры
- publisherName
-
string
- extensionName
-
string
- hostType
-
string
- hostName
-
string
Возвращаемое значение
Promise<void>
unshareExtension(string, string, string)
function unshareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>Параметры
- publisherName
-
string
- extensionName
-
string
- accountName
-
string
Возвращаемое значение
Promise<void>
unshareExtensionById(string, string)
function unshareExtensionById(extensionId: string, accountName: string): Promise<void>Параметры
- extensionId
-
string
- accountName
-
string
Возвращаемое значение
Promise<void>
unshareExtensionWithHost(string, string, string, string)
function unshareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>Параметры
- publisherName
-
string
- extensionName
-
string
- hostType
-
string
- hostName
-
string
Возвращаемое значение
Promise<void>
updateExtension(any, string, string, string, string, boolean)
Конечная точка REST для обновления расширения.
function updateExtension(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
Имя издателя
- extensionName
-
string
Имя расширения
- extensionType
-
string
- reCaptchaToken
-
string
- bypassScopeCheck
-
boolean
Этот параметр определяет, нужно ли вызывать проверку изменения области.
Возвращаемое значение
Promise<PublishedExtension>
updateExtensionById(string, string)
function updateExtensionById(extensionId: string, reCaptchaToken?: string): Promise<PublishedExtension>Параметры
- extensionId
-
string
- reCaptchaToken
-
string
Возвращаемое значение
Promise<PublishedExtension>
updateExtensionProperties(string, string, PublishedExtensionFlags)
function updateExtensionProperties(publisherName: string, extensionName: string, flags: PublishedExtensionFlags): Promise<PublishedExtension>Параметры
- publisherName
-
string
- extensionName
-
string
- flags
- PublishedExtensionFlags
Возвращаемое значение
Promise<PublishedExtension>
updateExtensionStatistics(ExtensionStatisticUpdate, string, string)
function updateExtensionStatistics(extensionStatisticsUpdate: ExtensionStatisticUpdate, publisherName: string, extensionName: string): Promise<void>Параметры
- extensionStatisticsUpdate
- ExtensionStatisticUpdate
- publisherName
-
string
- extensionName
-
string
Возвращаемое значение
Promise<void>
updatePayloadInDraftForEditExtension(any, string, string, string, String)
function updatePayloadInDraftForEditExtension(content: any, publisherName: string, extensionName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
- extensionName
-
string
- draftId
-
string
- fileName
-
String
Заголовок для передачи имени файла отправленных данных
Возвращаемое значение
Promise<ExtensionDraft>
updatePayloadInDraftForNewExtension(any, string, string, String)
function updatePayloadInDraftForNewExtension(content: any, publisherName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
- draftId
-
string
- fileName
-
String
Заголовок для передачи имени файла отправленных данных
Возвращаемое значение
Promise<ExtensionDraft>
updatePublisher(Publisher, string)
updatePublisherAsset(any, string, string, String)
Обновление ресурса издателя, например логотипа. Он принимает файл ресурса в виде потока октета и имя файла передается в значениях заголовка.
function updatePublisherAsset(content: any, publisherName: string, assetType?: string, fileName?: String): Promise<{[key: string]: string}>Параметры
- content
-
any
Содержимое для отправки
- publisherName
-
string
Внутреннее имя издателя
- assetType
-
string
Тип ресурса. Значением по умолчанию является логотип.
- fileName
-
String
Заголовок для передачи имени файла отправленных данных
Возвращаемое значение
Promise<{[key: string]: string}>
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)
Конечная точка для добавления или изменения членства издателя. В настоящее время поддерживает только добавление и изменение 1 пользователя одновременно Работает только для добавления членов одного клиента.
function updatePublisherMembers(roleAssignments: PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<PublisherRoleAssignment[]>Параметры
- roleAssignments
Список идентификаторов пользователей (адреса электронной почты) и роли, которые необходимо добавить. В настоящее время поддерживается только одна запись.
- publisherName
-
string
Имя или идентификатор издателя, к которому должны быть добавлены пользователи
- limitToCallerIdentityDomain
-
boolean
Следует ли разрешать или не разрешать межтенантные надстройки.
Возвращаемое значение
Promise<PublisherRoleAssignment[]>
updateQuestion(Question, string, string, number)
Обновляет существующий вопрос для расширения.
function updateQuestion(question: Question, publisherName: string, extensionName: string, questionId: number): Promise<Question>Параметры
- question
- Question
Обновленный вопрос, заданный для расширения.
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- questionId
-
number
Идентификатор вопроса, который необходимо обновить для расширения.
Возвращаемое значение
Promise<Question>
updateResponse(Response, string, string, number, number)
Обновляет существующий ответ на заданный вопрос для расширения.
function updateResponse(response: Response, publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<Response>Параметры
- response
- Response
Обновленный ответ, заданный для расширения.
- publisherName
-
string
Имя издателя, публикующего расширение.
- extensionName
-
string
Имя расширения.
- questionId
-
number
Идентификатор вопроса, для которого необходимо обновить ответ для расширения.
- responseId
-
number
Идентификатор ответа, который должен быть обновлен.
Возвращаемое значение
Promise<Response>
updateReview(ReviewPatch, string, string, number)
Обновления или флаги проверки
function updateReview(reviewPatch: ReviewPatch, pubName: string, extName: string, reviewId: number): Promise<ReviewPatch>Параметры
- reviewPatch
- ReviewPatch
Объект ReviewPatch, содержащий изменения, которые будут применены к проверке
- pubName
-
string
Имя издателя, публикующего расширение
- extName
-
string
Имя расширения
- reviewId
-
number
Идентификатор проверки, которая должна быть обновлена
Возвращаемое значение
Promise<ReviewPatch>
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
function updateVSCodeWebExtensionStatistics(itemName: string, version: string, statType: VSCodeWebExtensionStatisicsType): Promise<void>Параметры
- itemName
-
string
- version
-
string
- statType
- VSCodeWebExtensionStatisicsType
Возвращаемое значение
Promise<void>
verifyDomainToken(string)
function verifyDomainToken(publisherName: string): Promise<void>Параметры
- publisherName
-
string
Возвращаемое значение
Promise<void>