azure-devops-extension-sdk package
接口
| ContextIdentifier | |
| GlobalizationContext | |
| IExtensionContext |
当前扩展的标识符 |
| IExtensionInitOptions |
扩展初始化选项 -- 传递给 DevOps.init() |
| IHostContext |
有关当前 DevOps 主机(组织)的信息 |
| IPageContext |
放置在每个网页上的全局上下文 |
| ITeamContext |
有关当前 DevOps 团队的信息 |
| IUserContext |
有关当前用户的信息 |
枚举
| HostType |
DevOps 主机级别 |
函数
| apply |
将主题变量应用于当前文档 |
| get |
获取访问令牌,该令牌将允许对其他 DevOps 服务进行调用 |
| get |
获取可用于识别当前用户的 Token |
| get |
从父帧获取初始握手中传递的配置数据 |
| get |
获取有关首次导致此扩展加载的贡献的信息。 |
| get |
获取有关拥有所托管内容的扩展的上下文 |
| get |
获取有关主机 (的信息,即页面所针对的 Azure DevOps 组织) |
| get |
获取有关主机页面的上下文 |
| get |
获取具有给定贡献 ID 的贡献。返回的贡献具有获取该贡献中已注册对象的方法。 |
| get |
获取有关页面所针对的团队的信息 |
| get |
获取有关当前用户的信息 |
| get |
获取有关 Web 的上下文 |
| init(IExtension |
启动与主机窗口的握手。 |
| notify |
通知主机扩展加载失败 |
| notify |
通知主机扩展已成功加载(停止显示加载指示器) |
| 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()
获取可用于识别当前用户的 Token
function getAppToken(): Promise<string>
返回
Promise<string>
getConfiguration()
从父帧获取初始握手中传递的配置数据
function getConfiguration(): {[key: string]: any}
返回
{[key: string]: any}
getContributionId()
获取有关首次导致此扩展加载的贡献的信息。
function getContributionId(): string
返回
string
getExtensionContext()
getHost()
getPageContext()
getService<T>(string)
获取具有给定贡献 ID 的贡献。返回的贡献具有获取该贡献中已注册对象的方法。
function getService<T>(contributionId: string): Promise<T>
参数
- contributionId
-
string
要获取的贡献的 ID
返回
Promise<T>
getTeamContext()
getUser()
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
可选 width,默认为 scrollWidth
- height
-
number
可选 height,默认为 scrollHeight
unregister(string)
删除此扩展向主机框架公开的对象。
function unregister(instanceId: string)
参数
- instanceId
-
string
已注册对象的唯一 ID