diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md index ae3fa170dae46546953ebe72b59a638ce90af8e0..d5aac6594b8770371f6009128a45ddab9dad0a68 100644 --- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md +++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md @@ -65,6 +65,8 @@ |renderingMode|表示卡片的渲染模式，取值范围如下：
- autoColor：自动模式，锁屏卡片中心与桌面卡片中心/卡片管理内都可以显示的卡片。
- fullColor：全色模式，桌面卡片中心/卡片管理内可以显示的卡片。
- singleColor：单色模式，锁屏卡片中心内可以显示的卡片。 |字符串|可缺省，缺省值为“fullColor”。| |multiScheduledUpdateTime|表示卡片的多定点刷新的时刻，作为单点刷新的一个附加参数，采用24小时制，精确到分钟，多个时间用英文逗号分隔，最多写24个时间。
**说明：**
multiScheduledUpdateTime需要配合scheduledUpdateTime使用。|字符串|可缺省，缺省时不进行多定点刷新。| |conditionUpdate|表示卡片的支持的条件刷新（仅对系统应用的ArkTS卡片生效）。取值范围如下：
- network：表示支持网络刷新。|字符串|可缺省，缺省值为空字符串。| + |[funInteractionParams](#funinteractionparams标签)| 趣味交互类型互动卡片扩展字段。| 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。| + |[sceneAnimationParams](#sceneanimationparams标签)| 场景动效类型互动卡片扩展字段。| 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。| ## isDynamic标签 @@ -84,7 +86,43 @@ | designWidth | 标识页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省，缺省值为720px。 | | autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省，缺省值为false。 | - 配置示例如下： +## funInteractionParams标签 + +此标签标识趣味交互类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。 + +| 名称 | 类型 | 必填 | 说明 | +|-------------------|-----|----|---------------------------------------------------------------------| +| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为空。 | +| targetBundleName | string | 是 | 趣味交互场景[主包包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。| +| subBundleName | string | 是 | 趣味交互场景[独立分包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。| +| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 | + +## sceneAnimationParams标签 + +此标签标识场景动效类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。 + +| 名称 | 类型 | 必填 | 说明 | +|----------------------------------------|--------|----|----------------------------| +| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称。| +| disabledDesktopBehaviors | 字符串数组 | 否 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 | + + + ```json + { + "forms": [ + { + // ... + "sceneAnimationParams": { + "abilityName": "MyLiveFormExtensionAbility", + "disabledDesktopBehaviors": "LONG_CLICK|DRAG|SWIPE_DESKTOP|PULL_DOWN_SEARCH" + } + } + ] + } + ``` + + +配置示例如下： ```json @@ -114,7 +152,10 @@ "dataProxyEnabled": false, "isDynamic": true, "transparencyEnabled": false, - "metadata": [] + "metadata": [], + "funInteractionParams": { + "targetBundleName": "com.example.funInteraction" + } } ] } diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md index 0f0d2785993df952604fe7fb799814f4af34ef3e..fdb6a38480bbcb7dd0940a072a0265007409c02f 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md +++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md @@ -185,6 +185,24 @@ Waiting for the form addition to the desktop timed out. 服务繁忙，请稍后重试。 +## 16501011 当前卡片不支持互动卡片能力 + +**错误信息** + +The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. + +**错误描述** + +当前卡片不支持互动卡片能力时，系统会报此错误码。 + +**可能原因** + +普通卡片发起互动卡片动效请求，或者当前互动卡片配置错误。 + +**处理步骤** + +检查当前卡片对应[互动卡片配置项sceneAnimationParams](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。 + ## 2293761 内部服务错误 **错误信息** diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md index 618501e5bd03682066675111ede6ab18ef752e05..5fdefb94e7762e682af04f07c6dc244ab4560974 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md +++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md @@ -2885,4 +2885,168 @@ try { console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`); } +``` + +## formHost.on('formOverflow')20+ + +on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): void + +订阅互动卡片动效请求事件。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|----------|--------|---|---------------------------------------| +| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。| +| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 是 | 回调函数，用于卡片使用方对动效请求进行处理。| + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +|-------|-----------------------------------------------------------------------------------------------------------| +| 202 | The application is not a system application. | +| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. | + +**示例：** + +```ts +import { formHost, formInfo } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +try { + formHost.on('formOverflow', (request: formInfo.OverflowRequest) => { + console.log(`formHost on formOverflow, formId is ${request.formId}`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`); +} +``` + +## formHost.off('formOverflow')20+ + +off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>): void + +取消订阅互动卡片动效请求事件。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ |----|----------------------------------------| +| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。 | +| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 否 | 回调函数，对应已订阅互动卡片动效请求。缺省时，表示注销所有已注册互动卡片动效请求事件回调。 | + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +| --- |-----------------------------------------------------------------------------------------------------------| +| 202 | The application is not a system application. | +| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. | + +**示例：** + +```ts +import { formHost, formInfo } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +try { + formHost.off('formOverflow', (request: formInfo.OverflowRequest) => { + console.log(`formHost off formOverflow, formId is ${request.formId}`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`); +} +``` + +## formHost.on('changeSceneAnimationState')20+ + +on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void + +订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- |------------------------------------------------------| +| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。| +| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 是 | 回调函数，用于卡片使用方处理状态切换请求。| + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +|-------|-----------------------------------------------------------------------------------------------------------| +| 202 | The application is not a system application. | +| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. | + +**示例：** + +```ts +import { formHost, formInfo } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +try { + formHost.on('changeSceneAnimationState', (request: formInfo.ChangeSceneAnimationStateRequest): void => { + console.log(`formHost on changeSceneAnimationState, formId is ${request.formId}`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`); +} +``` + +## formHost.off('changeSceneAnimationState')20+ + +off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void + +取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ |----| ------- | +| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。| +| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 否 | 回调函数，对应已订阅互动卡片状态切换请求。缺省时，表示注销所有已注册互动卡片状态切换事件回调。| + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 202 | The application is not a system application. | +| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. | + +**示例：** + +```ts +import { formHost, formInfo } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +try { + formHost.off('changeSceneAnimationState', (request: formInfo.ChangeSceneAnimationStateRequest): void => { + console.log(`formHost off changeSceneAnimationState, formId is ${request.formId}`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`); +} ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md index 11c0d796fe638d3f008eed10c2b38bd68dfd3133..5d600f464f543b7d85508dd975c585723cf1421f 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md +++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md @@ -146,4 +146,59 @@ import { formInfo } from '@kit.FormKit'; | ----------- | ---- | ------------ | | AUTO_COLOR | 0 | 表示自动模式。 | | FULL_COLOR | 1 | 表示全色模式。 | -| SINGLE_COLOR | 2 | 表示单色模式。 | \ No newline at end of file +| SINGLE_COLOR | 2 | 表示单色模式。 | + +## OverflowRequest20+ + +互动卡片动效请求信息。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|----|----|-----| +| formId | string | 是 | 否 | 卡片id。| +| isOverflow | boolean | 是 | 否 | 动效请求类型标记，true 表示互动卡片请求触发动效，false 表示互动卡片请求取消动效。| +| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 是 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp），默认值为空。 | + +## ChangeSceneAnimationStateRequest20+ + +互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|-----|-----|----------------------------------------| +| formId | string | 是 | 否 | 卡片id。 | +| state | number | 是 | 否 | 状态切换请求类型标记：1 表示请求切换为激活态，0 表示请求切换为非激活态。 | + +## FunInteractionParams20+ + +趣味交互卡片配置参数。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|----|-----|--------------------------------------------------------------------------------------------------------------------------------------| +| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为空。 | +| targetBundleName | string | 是 | 否 | 趣味交互场景[主包包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。 | +| subBundleName | string | 是 | 否 | 趣味交互场景趣味交互场景[独立分包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。 | +| keepStateDuration | number | 是 | 是 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 | + +## SceneAnimationParams20+ + +场景动效卡片配置参数。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|------|----|-------------------------------------------------------------------------------------------------------------------------------------------------| +| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方LiveFormExtensionAbility名称。 | +| disabledDesktopBehaviors | string | 是 | 是 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md index d174f5cd17f04a34cbe253cd1ff8219d8c0a546a..3cde86320162bac7ac84c4fa98e49d1b3f855dbf 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md +++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md @@ -197,3 +197,26 @@ import { formInfo } from '@kit.FormKit'; | FORM_DEFAULT | 1 | 表示卡片创建原因为默认创建。 | | FORM_SHARE | 2 | 表示卡片创建原因为共享创建。 | +## OverflowInfo20+ + +互动卡片动效信息。 + +**系统能力：** SystemCapability.Ability.Form + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|------|-----|-----------------------------------| +| area | [Rect](#rect20) | 是 | 否 | 描述溢出动效区域范围，以卡片左上角为原点，单位为vp。 | +| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。 | + +## Rect20+ + +通用矩形区域信息。可用于描述卡片位置、互动卡片动效区域等信息。 + +**系统能力：** SystemCapability.Ability.Form + +| 名称 | 类型 | 只读 | 可选 | 说明 | +|-----|-----|------|-----|-------| +| left | number | 是 | 否 | 描述矩形的左上角顶点的 x 坐标，单位：vp。| +| top | number | 是 | 否 | 描述矩形的左上角顶点的 y 坐标，单位：vp。| +| width | number | 是 | 否 | 描述矩形的宽度，单位：vp。| +| height | number | 是 | 否 | 描述矩形的高度，单位：vp。| \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md index 916f6c32694cc99fffe22d622724f29ce099f9a8..e08ae9c9b5c351e6cddf0406a671e31e0dc3a5ee 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md +++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md @@ -322,4 +322,118 @@ try { } catch (error) { console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); } +``` + +## activateSceneAnimation20+ + +activateSceneAnimation(formId: string): Promise<void> + +互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- |-------| +| formId | string | 是 | 卡片id。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 202 | The application is not a system application. | +| 801 | Capability not supported.function activateSceneAnimation can not work correctly due to limited device capabilities. | +| 16500050 | IPC connection error. | +| 16500060 | Service connection error. | +| 16500100 | Failed to obtain the configuration information. | +| 16501000 | An internal functional error occurred. | +| 16501001 | The ID of the form to be operated does not exist. | +| 16501003 | The form cannot be operated by the current application. | +| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. | + +**示例：** + +```ts +import { formProvider } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +let formId: string = '12400633174999288'; + +try { + formProvider.activateSceneAnimation(formId).then(() => { + console.info('activateSceneAnimation succeed.'); + }).catch((error: BusinessError) => { + console.error(`promise error, code: ${error.code}, message: ${error.message})`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); +} +``` + +## deactivateSceneAnimation20+ + +deactivateSceneAnimation(formId: string): Promise<void> + +互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。 + +**系统能力：** SystemCapability.Ability.Form + +**系统接口：** 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- |-------| +| formId | string | 是 | 卡片id。| + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 202 | The application is not a system application. | +| 801 | Capability not supported.function deactivateSceneAnimation can not work correctly due to limited device capabilities. | +| 16500050 | IPC connection error. | +| 16500060 | Service connection error. | +| 16500100 | Failed to obtain the configuration information. | +| 16501000 | An internal functional error occurred. | +| 16501001 | The ID of the form to be operated does not exist. | +| 16501003 | The form cannot be operated by the current application. | +| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. | + +**示例：** + +```ts +import { formProvider } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +let formId: string = '12400633174999288'; + +try { + formProvider.deactivateSceneAnimation(formId).then(() => { + console.info('deactivateSceneAnimation succeed.'); + }).catch((error: BusinessError) => { + console.error(`promise error, code: ${error.code}, message: ${error.message})`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); +} ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md index 72d13dd8c5041c5fad2a9970652786f2986f3bdd..0d281e9db1c446734d429434334225c5fb160010 100644 --- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md +++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md @@ -594,4 +594,122 @@ try { } catch (error) { console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); } +``` + +## formProvider.requestOverflow20+ + +requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<void> + +卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。 + +**系统能力：** SystemCapability.Ability.Form + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ |--------------------------------------------------------------------| ---- |-----------| +| formId | string | 是 | 卡片id标识。| +| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 动效请求参数信息。| + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. | +| 16500050 | IPC connection error. | +| 16500060 | Service connection error. | +| 16500100 | Failed to obtain the configuration information. | +| 16501000 | An internal functional error occurred. | +| 16501001 | The ID of the form to be operated does not exist. | +| 16501003 | The form cannot be operated by the current application. | +| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. | + +**示例：** + +```ts +import { formInfo, formProvider } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +let formId: string = '12400633174999288'; +let overflowInfo: formInfo.OverflowInfo = { + area: { + left: -10, + top: -10, + width: 180, + height: 180 + }, + duration: 1000, +}; + +try { + formProvider.requestOverflow(formId, overflowInfo).then(() => { + console.info('requestOverflow succeed.'); + }).catch((error: BusinessError) => { + console.error(`promise error, code: ${error.code}, message: ${error.message})`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); +} +``` + +## formProvider.cancelOverflow20+ + +cancelOverflow(formId: string): Promise<void> + +卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。 + +**系统能力：** SystemCapability.Ability.Form + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- |-------| +| formId | string | 是 | 卡片id。| + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. | +| 16500050 | IPC connection error. | +| 16500060 | Service connection error. | +| 16500100 | Failed to obtain the configuration information. | +| 16501000 | An internal functional error occurred. | +| 16501001 | The ID of the form to be operated does not exist. | +| 16501003 | The form cannot be operated by the current application. | +| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. | + +**示例：** + +```ts +import { formProvider } from '@kit.FormKit'; +import { BusinessError } from '@kit.BasicServicesKit'; + +let formId: string = '12400633174999288'; + +try { + formProvider.cancelOverflow(formId).then(() => { + console.info('cancelOverflow succeed.'); + }).catch((error: BusinessError) => { + console.error(`promise error, code: ${error.code}, message: ${error.message})`); + }); +} catch (error) { + console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`); +} ``` \ No newline at end of file