azure-devops-extension-sdk package

类

XDMChannel	表示帧\document 保持活动状态（跨多个 funtion\method 调用）之间的通信通道
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)	获取具有给定贡献 ID 的贡献。返回的贡献具有一个方法，用于获取该贡献中的已注册对象。
getTeamContext()	获取有关页面所面向的团队的信息
getUser()	获取有关当前用户的信息
getWebContext()	获取有关 Web 的上下文
init(IExtensionInitOptions)	启动与主机窗口的握手。
notifyLoadFailed(string | Error)	通知主机扩展加载失败
notifyLoadSucceeded()	通知主机扩展已成功加载 (停止显示加载指示器)
ready()	注册初始设置/握手完成后调用的回调。 如果初始设置已完成，则会在当前调用堆栈的末尾调用回调。
register<T>(string, T)	) 此扩展向主机帧公开的对象 (实例或工厂方法注册。
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)

获取具有给定贡献 ID 的贡献。返回的贡献具有一个方法，用于获取该贡献中的已注册对象。

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

参数

contributionId

string

要获取的贡献的 ID

返回

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)

) 此扩展向主机帧公开的对象 (实例或工厂方法注册。

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

参数

instanceId

string

已注册对象的唯一 ID

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

已注册对象的唯一 ID