使用 JavaScript 客户端 SDK 生成选项卡Microsoft Teams托管体验

JavaScript Microsoft Teams SDK 可帮助你在 Teams 创建托管体验,这意味着在 iframe 中显示应用内容。

SDK 有助于开发具有以下任一功能Teams应用:

例如,SDK 可以使选项卡响应用户在客户端中Teams更改。

入门

根据您的开发首选项执行下列操作之一:

通用 SDK 函数

请参阅下表以了解常用的 SDK 函数。 SDK 参考文档提供了更全面的信息。

基本函数

功能 说明 文档
microsoftTeams.initialize() 初始化 SDK。 必须先调用此函数,然后才能调用任何其他 SDK。 function
microsoftTeams.getContext(callback: (context: Context) 获取正在运行页面的当前状态。 回调检索 Context 对象。 function
context obj
microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string}) 初始化Teams库,并设置选项卡的框架上下文,具体取决于contentUrl 和 websiteUrl。 这可确保在正确的 URL 上运行"转到网站/重新加载"功能。 function
microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string}) 根据 contentUrl websiteUrl 设置选项卡的框架上下文。 这可确保在正确的 URL 上运行"转到网站/重新加载"功能。 function
microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean) 当用户切换选项卡的全屏/窗口视图时注册的处理程序。 function
boolean
microsoftTeams.registerChangeSettingsHandler() 在用户选择启用的选项卡按钮以重新配置选项卡 设置 注册的处理程序。 function
microsoftTeams.getTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters,) 获取应用拥有的选项卡。 回调检索 TabInformation 对象。 TabInstanceParameters 对象是可选参数。 function
tabInfo obj
microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters) 获取用户最近使用的选项卡。 回调检索 TabInformation 对象。 TabInstanceParameters 对象是可选参数。 function
tabInfo obj
tabInstance obj
microsoftTeams.shareDeepLink(deepLinkParameters: DeepLinkParameters) DeepLinkParameters 对象作为输入并共享一个深层链接对话框,用户可以使用该对话框导航到选项卡 中的内容 function
deepLink obj
microsoftTeams.executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string)) 将所需的 deepLink 作为输入,将用户导航到 URL 或触发客户端操作(如打开 安装)Teams。 function
microsoftTeams.navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string)) TabInstance 对象作为输入并导航到指定的选项卡实例。 function
tabInstance obj

身份验证命名空间

功能 说明 文档
microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters) 启动身份验证请求,该请求使用调用方提供的参数打开新窗口。 可选输入值由 AuthenticateParameters 对象 定义。 function
auth obj
microsoftTeams.authentication.notifySuccess(result?: string, callbackUrl?: string) 通知启动身份验证请求的框架请求已成功并关闭身份验证窗口 function
microsoftTeams.authentication.notifyFailure(reason?: string, callbackUrl?: string) 通知启动身份验证请求的帧请求失败并关闭身份验证窗口。 function
microsoftTeams.authentication.getAuthToken(authTokenRequest: AuthTokenRequest) 发送请求Azure AD应用颁发令牌。 如果令牌尚未过期,可以从缓存获取。 否则,请求将发送到 Azure AD以获取新令牌。 function

设置命名空间

功能 说明 文档
microsoftTeams.settings.setValidityState(validityState: boolean) 初始值为 false。 在有效性 状态****为 true 时激活"保存或删除"按钮。 function
microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings) 获取当前实例的设置。 回调检索 设置 对象。 function
settings obj
microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) 配置当前实例的设置。 有效设置由 设置 对象定义 function
settings obj
microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent) 在用户选择"保存"按钮时注册 处理程序。 此处理程序应该用于创建或更新支持内容的基础资源。 function
microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent) 在用户选择"删除"按钮时注册 处理程序。 此处理程序应该用于删除支持内容的基础资源。 function

任务模块命名空间

功能 说明 文档
microsoftTeams.tasks.startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) TaskInfo 对象作为输入,并允许应用打开任务模块。 可选 submitHandler 在任务模块完成时注册。 function
taskInfo obj
microsoftTeams.tasks.submitTask(result?: string | object, appIds?: string | string[]) 提交任务模块。 可选 结果 字符串参数是发送到自动程序或应用的结果,通常为 JSON 对象或序列化;可选的 appIds 字符串或字符串数组参数有助于验证调用是否来自与调用任务模块的 appId 相同的 appId。 function