GalleryRestClient class

参考

包:: azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

Extends: RestClientBase

构造函数

GalleryRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

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)	为扩展创建新问题。
createResponse(Response, string, string, number)	为扩展的给定问题创建新的响应。
createReview(Review, string, string)	为扩展创建新的评审
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	删除发布者资产（如徽标）
deleteQuestion(string, string, number)	删除现有问题及其针对扩展的所有关联响应。 (软删除)
deleteResponse(string, string, number, number)	删除扩展的响应。 (软删除)
deleteReview(string, string, number)	删除审阅
extensionValidator(AzureRestApiRequestModel)	用于验证 Azure 发布者是否拥有第三方商务方案的扩展的 Rest 终结点。 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
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)	此路由/位置 ID 仅支持匿名 HTTP POST，因此页面视图每日统计信息可以从市场客户端递增。尝试在此路由上调用 GET 应会导致异常。如果没有此显式实现，则在此公共路由上调用 GET 将调用上述 GET 实现 GetExtensionDailyStats。
getExtensionEvents(string, string, number, Date, string, string)	获取扩展的安装/卸载事件。如果同时指定了 count 和 afterDate 参数，则 count 优先。
getExtensionReports(string, string, number, number, Date)	返回扩展报告
getGalleryUserSettings(string, string)	获取给定用户/所有用户范围的所有设置条目
getPackage(string, string, string, string, boolean, String)	从 Web UI 下载 VSTS 扩展时，会命中此终结点
getPublisher(string, number)
getPublisherAsset(string, string)	获取发布者资产（如徽标）作为流
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	返回问题列表及其与扩展关联的响应。
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	返回与扩展关联的评论列表
getReviewsSummary(string, string, Date, Date)	返回评论的摘要
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	递增与扩展相关的每日统计信息
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	用于发布扩展安装/卸载事件的 API 终结点。 EMS 仅在向我们发送与安装/卸载扩展相关的数据时调用。
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	标记对扩展的现有问题的关注。
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	发送通知
setGalleryUserSettings({[key: string]: any}, string)	为给定用户/所有用户范围设置所有设置条目
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 终结点。
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)	更新发布者资产（如徽标）。它接受资产文件作为八进制流，文件名在标头值中传递。
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	用于添加/修改发布者成员身份的终结点。目前仅支持一次添加/修改 1 个用户仅适用于添加同一租户的成员。
updateQuestion(Question, string, string, number)	汇报扩展的现有问题。
updateResponse(Response, string, string, number, number)	汇报扩展的给定问题的现有响应。
updateReview(ReviewPatch, string, string, number)	汇报或标记评审
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

构造函数详细信息

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

参数

options: 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)

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

参数

publisher: Publisher

Promise<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

资产的类型。默认值为“logo”。

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

需要更新的评审的 ID

Promise<void>

extensionValidator(AzureRestApiRequestModel)

用于验证 Azure 发布者是否拥有第三方商务方案的扩展的 Rest 终结点。 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>

getContentVerificationLog(string, string)

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

参数

publisherName: string

extensionName: 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)

此路由/位置 ID 仅支持匿名 HTTP POST，因此页面视图每日统计信息可以从市场客户端递增。尝试在此路由上调用 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 参数，则 count 优先。

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

筛选器选项。支持的值：install、uninstall、review、acquisition、sales。默认为提取所有类型的事件

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 和 days，则 days 将优先

count: number

要返回的事件数

afterDate: Date

如果要提取比指定日期更新的事件，请使用

Promise<any>

getGalleryUserSettings(string, string)

获取给定用户/所有用户范围的所有设置条目

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

参数

userScope: string

User-Scope 获取值。对于当前用户，应为“me”，对于所有用户应为“host”。

key: string

用于筛选所有条目的可选键

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

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

从 Web UI 下载 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

资产的类型。默认值为“logo”。

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 用于筛选出空评论等，默认为 none

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>

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: 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 获取值。对于当前用户，应为“me”，对于所有用户应为“host”。

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)

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

参数

publisher: Publisher

publisherName: string

Promise<Publisher>

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

资产的类型。默认值为“logo”。

fileName: String

用于传递已上传数据的文件名的标头

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

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

用于添加/修改发布者成员身份的终结点。目前仅支持一次添加/修改 1 个用户仅适用于添加同一租户的成员。

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

参数

roleAssignments: PublisherUserRoleAssignmentRef[]

要添加) 和角色 (电子邮件地址的用户标识符列表。目前仅支持一个条目。

publisherName: string

必须向其添加用户的发布者的名称/ID

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

需要更新的评审的 ID

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>

通过

GalleryRestClient class

构造函数

属性

方法

构造函数详细信息

GalleryRestClient(IVssRestClientOptions)

参数

属性详细信息

RESOURCE_AREA_ID

属性值

方法详细信息

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)

参数

返回

createResponse(Response, string, string, number)

参数

返回

createReview(Review, string, string)

参数

返回

createSupportRequest(CustomerSupportRequest)

参数

返回

deleteExtension(string, string, string)

参数

返回

deleteExtensionById(string, string)

参数

返回

deletePublisher(string)

参数

返回

deletePublisherAsset(string, string)

参数

返回

deleteQuestion(string, string, number)

参数

返回

deleteResponse(string, string, number, number)

参数

返回

deleteReview(string, string, number)

参数

返回

extensionValidator(AzureRestApiRequestModel)

参数

返回

fetchDomainToken(string)

参数

返回

generateKey(string, number)

参数