鸿蒙开发接口Ability框架：【@ohos.application.FormExtension (FormExtension)】

FormExtension

FormExtension模块提供了FormExtension卡片扩展相关接口。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。

导入模块

import FormExtension from '@ohos.application.FormExtension';

权限

无

属性

系统能力 ：SystemCapability.Ability.Form

名称	参数类型	可读	可写	说明
context	[FormExtensionContext]	是	否	FormExtension的上下文环境，继承自ExtensionContext。

鸿蒙开发指导文档：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

onCreate

onCreate(want: Want): formBindingData.FormBindingData

卡片提供方接收创建卡片的通知接口。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
want	[Want]	是	当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。

返回值：

类型	说明
[formBindingData.FormBindingData]	一个formBindingData.FormBindingData对象，卡片要显示的数据。

示例：

import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension {
    onCreate(want) {
        console.log('FormExtension onCreate, want:' + want.abilityName);
        let dataObj1 = {
            temperature:"11c",
            "time":"11:00"
        };
        let obj1 = formBindingData.createFormBindingData(dataObj1);
        return obj1;
    }
}

FormExtension.onCastToNormal

onCastToNormal(formId: string): void

卡片提供方接收临时卡片转常态卡片的通知接口。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求转换为常态的卡片ID。

示例：

export default class MyFormExtension extends FormExtension {
    onCastToNormal(formId) {
        console.log('FormExtension onCastToNormal, formId:' + formId);
    }
}

FormExtension.onUpdate

onUpdate(formId: string): void

卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext]的updateForm接口刷新卡片数据。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求更新的卡片ID。

示例：

import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension {
    onUpdate(formId) {
        console.log('FormExtension onUpdate, formId:' + formId);
        let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
        this.context.updateForm(formId, obj2)
            .then((data)= >{
                console.log('FormExtension context updateForm, data:' + data);
            }).catch((error) = > {
            console.error('Operation updateForm failed. Cause: ' + error);});
    }
}

FormExtension.onVisibilityChange

onVisibilityChange(newStatus: { [key: string]: number }): void

卡片提供方接收修改可见性的通知接口。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
newStatus	{ [key: string]: number }	是	请求修改的卡片ID和可见状态。

示例：

import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension {
    onVisibilityChange(newStatus) {
        console.log('FormExtension onVisibilityChange, newStatus:' + newStatus);
        let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});

        for (let key in newStatus) {
            console.log('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]);
            this.context.updateForm(key, obj2)
                .then((data)= >{
                    console.log('FormExtension context updateForm, data:' + data);
                }).catch((error) = > {
                console.error('Operation updateForm failed. Cause: ' + error);});
        }
    }
}

FormExtension.onEvent

onEvent(formId: string, message: string): void

卡片提供方接收处理卡片事件的通知接口。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求触发事件的卡片ID。
message	string	是	事件消息。

示例：

export default class MyFormExtension extends FormExtension {
    onEvent(formId, message) {
        console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
    }
}

FormExtension.onDestroy

onDestroy(formId: string): void

卡片提供方接收销毁卡片的通知接口。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求销毁的卡片ID。

示例：

export default class MyFormExtension extends FormExtension {
    onDestroy(formId) {
        console.log('FormExtension onDestroy, formId:' + formId);
    }
}

FormExtension.onConfigurationUpdated

onConfigurationUpdated(config: Configuration): void;

当系统配置更新时调用。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
config	[Configuration]	是	表示需要更新的配置信息。

示例：

class MyFormExtension extends FormExtension {
    onConfigurationUpdated(config) {
        console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
    }
}

FormExtension.onAcquireFormState

onAcquireFormState?(want: Want): formInfo.FormState;

卡片提供方接收查询卡片状态通知接口。默认返回卡片初始状态。

系统能力 ：SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
want	[Want]	否	want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。

示例：

import formInfo from '@ohos.application.formInfo'
class MyFormExtension extends FormExtension {
    onAcquireFormState(want) {
        console.log('FormExtension onAcquireFormState, want:' + want);
        return formInfo.FormState.UNKNOWN;
    }
}

审核编辑 黄宇