共用方式為


GalleryRestClient class

應該使用 (衍生自) 的基類,向 VSS REST API 提出要求

Extends

建構函式

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 發行者是否擁有第三方商務案例的擴充功能。 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)

此路由/位置標識符僅支援 HTTP POST,因此頁面檢視每日統計數據可以從 Marketplace 用戶端遞增。 嘗試在此路由上呼叫 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)

參數

屬性詳細資料

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

傳回

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

傳回

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>

參數

傳回

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

傳回

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

傳回

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

需要更新的檢閱標識碼

傳回

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

傳回

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

accountToken

string

accountTokenHeader

String

用來傳遞帳戶令牌的標頭

傳回

getExtensionById(string, string, ExtensionQueryFlags)

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

參數

extensionId

string

version

string

傳回

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

傳回

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

延伸模組的版本

傳回

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

篩選選項。 支援的值:安裝、卸載、檢閱、取得、銷售。 默認為擷取所有類型的事件

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,則天數會優先

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 篩選掉空白評論 etcetera,預設值為 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

傳回

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

傳回

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

用來傳遞帳戶令牌的標頭

傳回

queryPublishers(PublisherQuery)

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

參數

publisherQuery
PublisherQuery

傳回

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

傳回

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

此參數會決定是否需要叫用範圍變更檢查

傳回

updateExtensionById(string, string)

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

參數

extensionId

string

reCaptchaToken

string

傳回

updateExtensionProperties(string, string, PublishedExtensionFlags)

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

參數

publisherName

string

extensionName

string

傳回

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

必須新增使用者之發行者的名稱/標識符

limitToCallerIdentityDomain

boolean

應允許或不允許跨租使用者附加專案。

傳回

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

傳回

Promise<void>

verifyDomainToken(string)

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

參數

publisherName

string

傳回

Promise<void>