azure-devops-extension-sdk package

類別

XDMChannel	表示畫面格\檔之間的通訊通道在多個運算\方法呼叫之間保持「運作」
XDMObjectRegistry	針對 XDM 公開的物件目錄

介面

ContextIdentifier
GlobalizationContext
IExtensionContext	目前延伸模組的識別碼
IExtensionInitOptions	擴充功能初始化的選項 -- 傳遞至 DevOps.init ()
IHostContext	目前 DevOps 主機 (組織) 的相關資訊
IPageContext	放置於每個網頁的全域內容
ITeamContext	目前 DevOps 小組的相關資訊
IUserContext	目前使用者的相關資訊
IJsonRpcMessage	表示框架之間的遠端程序呼叫 (rpc) 。
ISerializationSettings	與跨 iframe 界限序列化資料相關的設定。
IXDMChannel	單一 XDM 通道的介面
IXDMChannelManager	每個目標框架/視窗保留的 XDM 通道登錄
IXDMObjectRegistry	XDM 通道可叫用的 XDM 物件登錄

列舉

HostType

DevOps 主機層級

函數

applyTheme({[varName: string]: string})	將主題變數套用至目前的檔
getAccessToken()	擷取存取權杖，以允許呼叫其他 DevOps 服務
getAppToken()	擷取可用來識別目前使用者的權杖
getConfiguration()	從父框架取得在初始交握中傳遞的組態資料
getContributionId()	取得第一次造成此延伸模組載入之貢獻的相關資訊。
getExtensionContext()	取得擁有所裝載內容的延伸模組相關內容
getHost()	取得主機 (的相關資訊，也就是 Azure DevOps 組織) 頁面的目標
getPageContext()	取得主機頁面的相關內容
getService<T>(string)	取得具有指定貢獻識別碼的參與。傳回的參與有方法可在該貢獻內取得已註冊的物件。
getTeamContext()	取得頁面目標小組的相關資訊
getUser()	取得目前使用者的相關資訊
getWebContext()	取得有關 Web 的內容
init(IExtensionInitOptions)	使用主視窗起始交握。
notifyLoadFailed(string | Error)	通知主機擴充功能無法載入
notifyLoadSucceeded()	通知主機延伸模組已成功載入 (停止顯示載入指標)
ready()	註冊在初始設定/交握完成之後呼叫的回呼。 如果初始設定已完成，則會在目前呼叫堆疊的結尾叫用回呼。
register<T>(string, T)	註冊物件 (實例或 Factory 方法，) 此延伸模組公開給主機框架。
resize(number, number)	要求父視窗根據目前的延伸模組大小調整此延伸模組的容器大小。
unregister(string)	移除這個延伸模組公開至主機框架的物件。

函式詳細資料

applyTheme({[varName: string]: string})

將主題變數套用至目前的檔

function applyTheme(themeData: {[varName: string]: string})

參數

themeData

{[varName: string]: string}

getAccessToken()

擷取存取權杖，以允許呼叫其他 DevOps 服務

function getAccessToken(): Promise<string>

傳回

Promise<string>

getAppToken()

擷取可用來識別目前使用者的權杖

function getAppToken(): Promise<string>

傳回

Promise<string>

getConfiguration()

從父框架取得在初始交握中傳遞的組態資料

function getConfiguration(): {[key: string]: any}

傳回

{[key: string]: any}

getContributionId()

取得第一次造成此延伸模組載入之貢獻的相關資訊。

function getContributionId(): string

傳回

string

getExtensionContext()

取得擁有所裝載內容的延伸模組相關內容

function getExtensionContext(): IExtensionContext

傳回

IExtensionContext

getHost()

取得主機 (的相關資訊，也就是 Azure DevOps 組織) 頁面的目標

function getHost(): IHostContext

傳回

IHostContext

getPageContext()

取得主機頁面的相關內容

function getPageContext(): IPageContext

傳回

IPageContext

getService<T>(string)

取得具有指定貢獻識別碼的參與。傳回的參與有方法可在該貢獻內取得已註冊的物件。

function getService<T>(contributionId: string): Promise<T>

參數

contributionId

string

要取得之貢獻的識別碼

傳回

Promise<T>

getTeamContext()

取得頁面目標小組的相關資訊

function getTeamContext(): ITeamContext

傳回

ITeamContext

getUser()

取得目前使用者的相關資訊

function getUser(): IUserContext

傳回

IUserContext

getWebContext()

取得有關 Web 的內容

function getWebContext(): IWebContext

傳回

IWebContext

init(IExtensionInitOptions)

使用主視窗起始交握。

function init(options?: IExtensionInitOptions): Promise<void>

參數

options

IExtensionInitOptions

擴充功能的初始化選項。

傳回

Promise<void>

notifyLoadFailed(string | Error)

通知主機擴充功能無法載入

function notifyLoadFailed(e: string | Error): Promise<void>

參數

e

string | Error

傳回

Promise<void>

notifyLoadSucceeded()

通知主機延伸模組已成功載入 (停止顯示載入指標)

function notifyLoadSucceeded(): Promise<void>

傳回

Promise<void>

ready()

註冊在初始設定/交握完成之後呼叫的回呼。 如果初始設定已完成，則會在目前呼叫堆疊的結尾叫用回呼。

function ready(): Promise<void>

傳回

Promise<void>

register<T>(string, T)

註冊物件 (實例或 Factory 方法，) 此延伸模組公開給主機框架。

function register<T>(instanceId: string, instance: T)

參數

instanceId

string

已註冊物件的唯一識別碼

instance

T

可以是： (1) 物件實例，或 (2) 採用選擇性內容資料的函式，並傳回物件實例。

resize(number, number)

要求父視窗根據目前的延伸模組大小調整此延伸模組的容器大小。

function resize(width?: number, height?: number)

參數

width

number

選擇性寬度，預設為 scrollWidth

height

number

選擇性高度，預設為 scrollHeight

unregister(string)

移除這個延伸模組公開至主機框架的物件。

function unregister(instanceId: string)

參數

instanceId

string

已註冊物件的唯一識別碼