harmony 鸿蒙@ohos.app.form.formAgent (FormAgent)

2023-10-30
浏览 (468)

@ohos.app.form.formAgent (FormAgent)

FormAgent模块提供了卡片代理相关接口的能力，目前仅包括请求发布卡片。

说明： 本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import formAgent from '@ohos.app.form.formAgent';

requestPublishForm

requestPublishForm(want: Want, callback: AsyncCallback<string>): void

请求发布一张卡片到使用方，使用callbck异步回调。使用方通常为桌面。

需要权限：ohos.permission.AGENT_REQUIRE_FORM

系统能力： SystemCapability.Ability.Form

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
want	Want	是	发布请求。需包含以下字段。 bundleName: 目标卡片bundleName abilityName: 目标卡片ability parameters: - ohos.extra.param.key.form_dimension: 目标卡片规格 - ohos.extra.param.key.form_name: 目标卡片名 - ohos.extra.param.key.module_name: 目标卡片moduleName
callback	AsyncCallback<string>	是	回调函数。返回卡片标识。

错误码：

错误码ID	错误信息
16500050	An IPC connection error happened.
16500100	Failed to obtain the configuration information.
16501000	An internal functional error occurred.

以上错误码的详细介绍请参见卡片错误码。

示例：

import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base';

let want: Want = {
  bundleName: 'com.ohos.exampledemo',
  abilityName: 'FormAbility',
  parameters: {
    'ohos.extra.param.key.form_dimension': 2,
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.module_name': 'entry'
  }
};
try {
  formAgent.requestPublishForm(want, (error: Base.BusinessError, data: string) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
      return;
    }
    console.log(`formAgent requestPublishForm, form ID is: ${JSON.stringify(data)}`);
  });
} catch (error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message})`);
}

requestPublishForm

requestPublishForm(want: Want): Promise<string>

请求发布一张卡片到使用方，使用Promise异步回调。使用方通常为桌面。

需要权限：ohos.permission.AGENT_REQUIRE_FORM

系统能力： SystemCapability.Ability.Form

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
want	Want	是	发布请求。需包含以下字段。 bundleName: 目标卡片bundleName abilityName: 目标卡片ability parameters: - ohos.extra.param.key.form_dimension: 目标卡片规格 - ohos.extra.param.key.form_name: 目标卡片名 - ohos.extra.param.key.module_name: 目标卡片moduleName

返回值：

类型	说明
Promise<string>	Promise对象。返回卡片标识。

错误码：

错误码ID	错误信息
16500050	An IPC connection error happened.
16500100	Failed to obtain the configuration information.
16501000	An internal functional error occurred.

以上错误码的详细介绍请参见卡片错误码。

示例：

import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base';

let want: Want = {
  bundleName: 'com.ohos.exampledemo',
  abilityName: 'FormAbility',
  parameters: {
    'ohos.extra.param.key.form_dimension': 2,
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.module_name': 'entry'
  }
};
try {
  formAgent.requestPublishForm(want).then((data: string) => {
    console.log(`formAgent requestPublishForm success, form ID is : ${JSON.stringify(data)}`);
  }).catch((error: Base.BusinessError) => {
    console.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message})`);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/5f5413a11fb54f219ac063eb9528ffc8

热门推荐

1、直接访问google.com
2、 - 优质文章
3、 gate.io
4、 harmony 鸿蒙hdc使用指导
5、 harmony 鸿蒙初识ArkTS语言
6、 flink kafka connector scan.startup.mode 的几个选项
7、 harmony 鸿蒙ArkUI组件（ArkTS）开发常见问题
8、 golang
9、 openharmony
10、 Vue中input框自动聚焦

Loading...