Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 60d62bc0 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!15616 FormExtensionAbility文档同步 

Merge pull request !15616 from wangkailong/formability
上级 916fe61f 6abfe206
显示空白变更内容
内联 并排
Showing with 74 addition and 46 deletion
zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
浏览文件 @ 60d62bc0
# @ohos.app.form.FormExtensionAbility (FormExtensionAbility) # @ohos.app.form.FormExtensionAbility (FormExtensionAbility)
FormExtensionAbility模块提供了卡片扩展相关接口。 FormExtensionAbility为卡片扩展模块，提供卡片创建、销毁、刷新等生命周期回调。
> **说明：** > **说明：**
> >
...@@ -18,8 +18,8 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -18,8 +18,8 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
**系统能力**：SystemCapability.Ability.Form **系统能力**：SystemCapability.Ability.Form
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | | ------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | | context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自[ExtensionContext](js-apis-inner-application-extensionContext.md)。 |
## onAddForm ## onAddForm
...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | | want | [Want](js-apis-application-want.md) | 是 | 当前卡片相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
**返回值：** **返回值：**
...@@ -45,17 +45,19 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -45,17 +45,19 @@ onAddForm(want: Want): formBindingData.FormBindingData
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want) {
console.log('FormExtensionAbility onAddForm, want:' + want.abilityName); console.log('FormExtensionAbility onAddForm, want: ${want.abilityName}');
let dataObj1 = { let dataObj1 = {
temperature:'11c', temperature: '11c',
'time':'11:00' 'time': '11:00'
}; };
let obj1 = formBindingData.createFormBindingData(dataObj1); let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1; return obj1;
} }
} };
``` ```
## onCastToNormalForm ## onCastToNormalForm
...@@ -75,18 +77,20 @@ onCastToNormalForm(formId: string): void ...@@ -75,18 +77,20 @@ onCastToNormalForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId) { onCastToNormalForm(formId) {
console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId); console.log('FormExtensionAbility onCastToNormalForm, formId: ${formId}');
} }
} };
``` ```
## onUpdateForm ## onUpdateForm
onUpdateForm(formId: string): void onUpdateForm(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。 卡片提供方接收更新卡片的通知接口。获取最新数据后调用formProvider的[updateForm](js-apis-app-form-formProvider.md#updateform)接口刷新卡片数据。
**系统能力**：SystemCapability.Ability.Form **系统能力**：SystemCapability.Ability.Form
...@@ -99,17 +103,24 @@ onUpdateForm(formId: string): void ...@@ -99,17 +103,24 @@ onUpdateForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId) { onUpdateForm(formId) {
console.log('FormExtensionAbility onUpdateForm, formId:' + formId); console.log('FormExtensionAbility onUpdateForm, formId: ${formId}');
let obj2 = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); let obj2 = formBindingData.createFormBindingData({
this.context.updateForm(formId, obj2).then((data)=>{ temperature: '22c',
console.log('FormExtensionAbility context updateForm, data:' + data); time: '22:00'
});
formProvider.updateForm(formId, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data: ${data}');
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);}); console.error('Operation updateForm failed. Cause: ${error}');
});
} }
} };
``` ```
## onChangeFormVisibility ## onChangeFormVisibility
...@@ -129,21 +140,28 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void ...@@ -129,21 +140,28 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus) { onChangeFormVisibility(newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, newStatus:' + newStatus); console.log('FormExtensionAbility onChangeFormVisibility, newStatus: ${newStatus}');
let obj2 = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); let obj2 = formBindingData.createFormBindingData({
temperature: '22c',
time: '22:00'
});
for (let key in newStatus) { for (let key in newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, key:' + key + ', value=' + newStatus[key]); console.log('FormExtensionAbility onChangeFormVisibility, key: ${key}, value= ${newStatus[key]}');
this.context.updateForm(key, obj2).then((data)=>{ formProvider.updateForm(key, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data:' + data); console.log('FormExtensionAbility context updateForm, data: ${data}');
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);}); console.error('Operation updateForm failed. Cause: ${error}');
});
} }
} }
} };
``` ```
## onFormEvent ## onFormEvent
...@@ -164,11 +182,13 @@ onFormEvent(formId: string, message: string): void ...@@ -164,11 +182,13 @@ onFormEvent(formId: string, message: string): void
**示例：** **示例：**
```ts ```ts
export default class MyFormExtension extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ', message:' + message); console.log('FormExtensionAbility onFormEvent, formId: ${formId}, message: ${message}');
} }
} };
``` ```
## onRemoveForm ## onRemoveForm
...@@ -188,11 +208,13 @@ onRemoveForm(formId: string): void ...@@ -188,11 +208,13 @@ onRemoveForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId) { onRemoveForm(formId) {
console.log('FormExtensionAbility onRemoveForm, formId:' + formId); console.log('FormExtensionAbility onRemoveForm, formId: ${formId}');
} }
} };
``` ```
## onConfigurationUpdate ## onConfigurationUpdate
...@@ -212,11 +234,13 @@ onConfigurationUpdate(newConfig: Configuration): void; ...@@ -212,11 +234,13 @@ onConfigurationUpdate(newConfig: Configuration): void;
**示例：** **示例：**
```ts ```ts
class MyFormExtensionAbility extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); console.log('onConfigurationUpdate, config: ${JSON.stringify(config)}');
} }
} };
``` ```
## onAcquireFormState ## onAcquireFormState
...@@ -231,18 +255,20 @@ onAcquireFormState?(want: Want): formInfo.FormState; ...@@ -231,18 +255,20 @@ onAcquireFormState?(want: Want): formInfo.FormState;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | | want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括Bundle名称、能力名称、模块名称、卡片名和卡片维度。 |
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formInfo from '@ohos.app.form.formInfo'; import formInfo from '@ohos.app.form.formInfo';
class MyFormExtensionAbility extends FormExtensionAbility {
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState(want) { onAcquireFormState(want) {
console.log('FormExtensionAbility onAcquireFormState, want:' + want); console.log('FormExtensionAbility onAcquireFormState, want: ${want}');
return formInfo.FormState.UNKNOWN; return formInfo.FormState.UNKNOWN;
} }
} };
``` ```
## onShareForm ## onShareForm
...@@ -270,14 +296,16 @@ onShareForm?(formId: string): { [key: string]: any } ...@@ -270,14 +296,16 @@ onShareForm?(formId: string): { [key: string]: any }
**示例：** **示例：**
```ts ```ts
class MyFormExtensionAbility extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm(formId) { onShareForm(formId) {
console.log('FormExtensionAbility onShareForm, formId:' + formId); console.log('FormExtensionAbility onShareForm, formId: ${formId}');
let wantParams = { let wantParams = {
'temperature':'20', 'temperature': '20',
'time':'2022-8-8 09:59', 'time': '2022-8-8 09:59',
}; };
return wantParams; return wantParams;
} }
} };
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或