FormExtension


FormExtension

icon-note.gif 说明: 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

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

导入模块

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

权限

属性

系统能力:SystemCapability.Ability.Form

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

onCreate

onCreate(want: Want): formBindingData.FormBindingData

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

系统能力:SystemCapability.Ability.Form

参数:

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

返回值:

类型 说明
formBindingData.FormBindingData 一个formBindingData.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;
    }
}
1
2
3
4
5
6
7
8
9
10
11

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);
    }
}
1
2
3
4
5

FormExtension.onUpdate

onUpdate(formId: string): void

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

系统能力:SystemCapability.Ability.Form

参数:

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

示例:

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);});
    }
}
1
2
3
4
5
6
7
8
9
10
11

FormExtension.onVisibilityChange

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

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

系统能力:SystemCapability.Ability.Form

参数:

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

示例:

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);});
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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);
    }
}
1
2
3
4
5

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);
    }
}
1
2
3
4
5

FormExtension.onConfigurationUpdated

onConfigurationUpdated(config: Configuration): void;

当系统配置更新时调用。

系统能力:SystemCapability.Ability.Form

参数:

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

示例:

class MyFormExtension extends MyFormExtension {
    onConfigurationUpdated(config) {
        console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
    }
}
1
2
3
4
5