文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
开发与测试开放能力API应用框架Ability Kit(程序框架服务)ArkTS API接口依赖的元素及定义applicationAgentHostProxy

AgentHostProxy

Phone24+PC/2in124+Tablet24+TV24+Wearable24+

AgentHostProxy用于从AgentExtensionAbility服务端向客户端发送数据或安全认证请求。

说明
  • 本模块首批接口从API version 24开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
  • 本模块接口仅可在Stage模型下使用。
  • 本模块接口需要在主线程中使用,不支持在Worker、TaskPool等子线程中使用。

导入模块

收起
自动换行
深色代码主题
复制
  1. import { common } from '@kit.AbilityKit';

AgentHostProxy

Phone24+PC/2in124+Tablet24+TV24+Wearable24+

sendData

Phone24+PC/2in124+Tablet24+TV24+Wearable24+

sendData(data: string): void

AgentExtensionAbility服务端给客户端发送数据。

元服务API:从 API version 24开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AgentRuntime.Core

参数:

展开
参数名 类型 必填 说明
data string 待发送到AgentExtensionAbility客户端的数据。

错误码:

以下错误码详细介绍请参考通用错误码元能力子系统错误码

展开
错误码ID 错误信息
35600002 Failed to send the IPC message.

示例:

收起
自动换行
深色代码主题
复制
  1. import { common, AgentExtensionAbility } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. const TAG: string = '[AgentExtensionAbility] ';
  4. export default class MyAgentExtensionAbility extends AgentExtensionAbility {
  5. // 数据发送处理
  6. onData(proxy: common.AgentHostProxy, data: string) {
  7. console.info(TAG + `onData ${data}`);
  8. try {
  9. // 发送数据到AgentExtensionAbility的客户端
  10. proxy.sendData('Hello Client');
  11. } catch (err) {
  12. let code = (err as BusinessError).code;
  13. let msg = (err as BusinessError).message;
  14. console.error(`${TAG} sendData failed, err code: ${code}, err msg: ${msg}.`);
  15. }
  16. }
  17. }

authorize

Phone24+PC/2in124+Tablet24+TV24+Wearable24+

authorize(handshakeData: string): void

AgentExtensionAbility服务端给客户端发送安全认证请求。

元服务API:从 API version 24开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AgentRuntime.Core

参数:

展开
参数名 类型 必填 说明
handshakeData string 待发送到客户端的安全认证数据。

错误码:

以下错误码详细介绍请参考通用错误码元能力子系统错误码

展开
错误码ID 错误信息
35600002 Failed to send the IPC message.

示例:

收起
自动换行
深色代码主题
复制
  1. import { common, AgentExtensionAbility } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. const TAG: string = '[AgentExtensionAbility] ';
  4. export default class MyAgentExtensionAbility extends AgentExtensionAbility {
  5. // 安全认证处理
  6. onAuth(proxy: common.AgentHostProxy, handshakeData: string) {
  7. console.info(TAG + `onAuth ${handshakeData}`);
  8. try {
  9. // 发送认证数据到AgentExtensionAbility的客户端
  10. proxy.authorize('handshake_token');
  11. } catch (err) {
  12. let code = (err as BusinessError).code;
  13. let msg = (err as BusinessError).message;
  14. console.error(`${TAG} authorize failed, err code: ${code}, err msg: ${msg}.`);
  15. }
  16. }
  17. }
在 开发与测试 开放能力API 中进行搜索
请输入您想要搜索的关键词