formapi

Signed-off-by: N wangkailong <wangkailong6@huawei.com> Change-Id: I30e4fcc6abb169f1994a7a21fa65e4d8323f298b

formapi
Signed-off-by: N wangkailong <wangkailong6@huawei.com> Change-Id: I30e4fcc6abb169f1994a7a21fa65e4d8323f298b
aaebdd48 · yanwenhao · wangkailong · b5f9a711 · aaebdd48 · aaebdd48
2 changed file
--- a/zh-cn/application-dev/reference/apis/Readme-CN.md
+++ b/zh-cn/application-dev/reference/apis/Readme-CN.md
@@ -18,7 +18,7 @@
    - [@ohos.application.abilityLifecycleCallback (AbilityLifecycleCallback)](js-apis-application-abilityLifecycleCallback.md)
    - [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-DataShareExtensionAbility.md)
    - [@ohos.application.EnvironmentCallback (EnvironmentCallback)](js-apis-application-EnvironmentCallback.md)
-    - [@ohos.application.FormExtension (FormExtension)](js-apis-formextension.md)
    - [@ohos.application.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-service-extension-ability.md)
    - [@ohos.application.StartOptions (StartOptions)](js-apis-application-StartOptions.md)
    - [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
@@ -294,6 +294,7 @@
  - [@ohos.uitest (UiTest)](js-apis-uitest.md)
 - 已停止维护的接口
+  - [@ohos.application.FormExtension (FormExtension)](js-apis-formextension.md)
  - [@ohos.application.formHost (FormHost)](js-apis-formhost.md)
  - [@ohos.application.formProvider (FormProvider)](js-apis-formprovider.md)
  - [@ohos.application.formInfo (FormInfo)](js-apis-formInfo.md)

--- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-formextension.md
@@ -3,8 +3,9 @@
 FormExtension模块提供了FormExtension卡片扩展相关接口。
 > **说明：**
-> 
+>
-> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。  
+> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+> 从API version 9 开始不再维护，建议使用[FormExtensionAbility](js-apis-app-form-formextensionability.md)替代。
 > 本模块接口仅可在Stage模型下使用。
 ## 导入模块
@@ -13,10 +14,6 @@ FormExtension模块提供了FormExtension卡片扩展相关接口。
 import FormExtension from '@ohos.application.FormExtension';
 ```
-## 权限
-无
 ## 属性
 **系统能力**：SystemCapability.Ability.Form
@@ -35,32 +32,32 @@ onCreate(want: Want): formBindingData.FormBindingData
 **参数：**
-  | 参数名 | 类型                                   | 必填 | 说明                                                         |
+| 参数名 | 类型                                   | 必填 | 说明                                                         |
-  | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
+| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
-  | want   | [Want](js-apis-application-Want.md) | 是   | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
+| want   | [Want](js-apis-application-Want.md) | 是   | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
 **返回值：**
-  | 类型                                                         | 说明                                                        |
+| 类型                                                         | 说明                                                        |
-  | ------------------------------------------------------------ | ----------------------------------------------------------- |
+| ------------------------------------------------------------ | ----------------------------------------------------------- |
-  | [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 一个formBindingData.FormBindingData对象，卡片要显示的数据。 |
+| [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 |
 **示例：**
-  ```js
+```js
-  import formBindingData from '@ohos.application.formBindingData'
+import formBindingData from '@ohos.application.formBindingData'
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onCreate(want) {
+  onCreate(want) {
-          console.log('FormExtension onCreate, want:' + want.abilityName);
+    console.log('FormExtension onCreate, 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;
-      }
  }
-  ```
+}
+```
 ## FormExtension.onCastToNormal
@@ -72,19 +69,19 @@ onCastToNormal(formId: string): void
 **参数：**
-  | 参数名 | 类型   | 必填 | 说明                     |
+| 参数名 | 类型   | 必填 | 说明                     |
-  | ------ | ------ | ---- | ------------------------ |
+| ------ | ------ | ---- | ------------------------ |
-  | formId | string | 是   | 请求转换为常态的卡片ID。 |
+| formId | string | 是   | 请求转换为常态的卡片标识。 |
 **示例：**
-  ```
+```js
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onCastToNormal(formId) {
+  onCastToNormal(formId) {
-          console.log('FormExtension onCastToNormal, formId:' + formId);
+    console.log('FormExtension onCastToNormal, formId:' + formId);
-      }
  }
-  ```
+}
+```
 ## FormExtension.onUpdate
@@ -96,26 +93,25 @@ onUpdate(formId: string): void
 **参数：**
-  | 参数名 | 类型   | 必填 | 说明               |
+| 参数名 | 类型   | 必填 | 说明               |
-  | ------ | ------ | ---- | ------------------ |
+| ------ | ------ | ---- | ------------------ |
-  | formId | string | 是   | 请求更新的卡片ID。 |
+| formId | string | 是   | 请求更新的卡片ID。 |
 **示例：**
-  ```js
+```js
-  import formBindingData from '@ohos.application.formBindingData'
+import formBindingData from '@ohos.application.formBindingData'
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onUpdate(formId) {
+  onUpdate(formId) {
-          console.log('FormExtension onUpdate, formId:' + formId);
+    console.log('FormExtension onUpdate, formId:' + formId);
-          let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
+    let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
-          this.context.updateForm(formId, obj2)
+    this.context.updateForm(formId, obj2).then((data)=>{
-              .then((data)=>{
+      console.log('FormExtension context updateForm, data:' + data);
-                  console.log('FormExtension context updateForm, data:' + data);
+    }).catch((error) => {
-              }).catch((error) => {
+      console.error('Operation updateForm failed. Cause: ' + error);});
-              console.error('Operation updateForm failed. Cause: ' + error);});
+    }
-      }
+}
-  }
+```
-  ```
 ## FormExtension.onVisibilityChange
@@ -127,30 +123,29 @@ onVisibilityChange(newStatus: { [key: string]: number }): void
 **参数：**
-  | 参数名    | 类型                      | 必填 | 说明                         |
+| 参数名    | 类型                      | 必填 | 说明                         |
-  | --------- | ------------------------- | ---- | ---------------------------- |
+| --------- | ------------------------- | ---- | ---------------------------- |
-  | newStatus | { [key: string]: number } | 是   | 请求修改的卡片ID和可见状态。 |
+| newStatus | { [key: string]: number } | 是   | 请求修改的卡片ID和可见状态。 |
 **示例：**
-  ```js
+```js
-  import formBindingData from '@ohos.application.formBindingData'
+import formBindingData from '@ohos.application.formBindingData'
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onVisibilityChange(newStatus) {
+  onVisibilityChange(newStatus) {
-          console.log('FormExtension onVisibilityChange, newStatus:' + newStatus);
+  console.log('FormExtension onVisibilityChange, 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('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]);
+    console.log('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]);
-              this.context.updateForm(key, obj2)
+    this.context.updateForm(key, obj2).then((data)=>{
-                  .then((data)=>{
+        console.log('FormExtension context updateForm, data:' + data);
-                      console.log('FormExtension context updateForm, data:' + data);
+    }).catch((error) => {
-                  }).catch((error) => {
+        console.error('Operation updateForm failed. Cause: ' + error);});
-                  console.error('Operation updateForm failed. Cause: ' + error);});
+    }
-          }
-      }
  }
-  ```
+}
+```
 ## FormExtension.onEvent
@@ -162,20 +157,20 @@ onEvent(formId: string, message: string): void
 **参数：**
-  | 参数名  | 类型   | 必填 | 说明                   |
+| 参数名  | 类型   | 必填 | 说明                   |
-  | ------- | ------ | ---- | ---------------------- |
+| ------- | ------ | ---- | ---------------------- |
-  | formId  | string | 是   | 请求触发事件的卡片ID。 |
+| formId  | string | 是   | 请求触发事件的卡片标识。 |
-  | message | string | 是   | 事件消息。             |
+| message | string | 是   | 事件消息。             |
 **示例：**
-  ```js
+```js
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onEvent(formId, message) {
+  onEvent(formId, message) {
-          console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
+    console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
-      }
  }
-  ```
+}
+```
 ## FormExtension.onDestroy
@@ -187,19 +182,19 @@ onDestroy(formId: string): void
 **参数：**
-  | 参数名 | 类型   | 必填 | 说明               |
+| 参数名 | 类型   | 必填 | 说明               |
-  | ------ | ------ | ---- | ------------------ |
+| ------ | ------ | ---- | ------------------ |
-  | formId | string | 是   | 请求销毁的卡片ID。 |
+| formId | string | 是   | 请求销毁的卡片标识。 |
 **示例：**
-  ```js
+```js
-  export default class MyFormExtension extends FormExtension {
+export default class MyFormExtension extends FormExtension {
-      onDestroy(formId) {
+  onDestroy(formId) {
-          console.log('FormExtension onDestroy, formId:' + formId);
+    console.log('FormExtension onDestroy, formId:' + formId);
-      }
  }
-  ```
+}
+```
 ## FormExtension.onConfigurationUpdated
@@ -211,19 +206,19 @@ onConfigurationUpdated(config: Configuration): void;
 **参数：**
-  | 参数名 | 类型 | 必填 | 说明 | 
+| 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
+| -------- | -------- | -------- | -------- |
-  | config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | 
+| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 |
 **示例：**
-  ```js
+```js
-  class MyFormExtension extends FormExtension {
+class MyFormExtension extends FormExtension {
-      onConfigurationUpdated(config) {
+  onConfigurationUpdated(config) {
-          console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
+    console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
-      }
  }
-  ```
+}
+```
 ## FormExtension.onAcquireFormState
@@ -235,21 +230,21 @@ onAcquireFormState?(want: Want): formInfo.FormState;
 **参数：**
-  | 参数名 | 类型 | 必填 | 说明 | 
+| 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
+| -------- | -------- | -------- | -------- |
-  | want | [Want](js-apis-application-Want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | 
+| want | [Want](js-apis-application-Want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 |
 **示例：**
-  ```js
+```js
-  import formInfo from '@ohos.application.formInfo'
+import formInfo from '@ohos.application.formInfo'
-  class MyFormExtension extends FormExtension {
+class MyFormExtension extends FormExtension {
-      onAcquireFormState(want) {
+  onAcquireFormState(want) {
-          console.log('FormExtension onAcquireFormState, want:' + want);
+    console.log('FormExtension onAcquireFormState, want:' + want);
-          return formInfo.FormState.UNKNOWN;
+    return formInfo.FormState.UNKNOWN;
-      }
  }
-  ```
+}
+```
 ## FormExtension.onShare
@@ -257,33 +252,33 @@ onShare?(formId: string): {[key: string]: any};
 卡片提供方接收卡片分享的通知接口。
-此接口为系统接口。
+**系统接口**: 此接口为系统接口。
 **系统能力**：SystemCapability.Ability.Form
 **参数：**
-  | 参数名 | 类型 | 必填 | 说明 | 
+| 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
+| -------- | -------- | -------- | -------- |
-  | formId | string | 是   | 卡片标识 |
+| formId | string | 是   | 卡片标识。 |
 **返回值：**
-  | 类型                                                         | 说明                                                        |
+| 类型                                                         | 说明                                                        |
-  | ------------------------------------------------------------ | ----------------------------------------------------------- |
+| ------------------------------------------------------------ | ----------------------------------------------------------- |
-  | {[key: string]: any} | 卡片要分享的数据，由开发者自行决定传入的键值对。 |
+| {[key: string]: any} | 卡片要分享的数据，由开发者自行决定传入的键值对。 |
 **示例：**
-  ```js
+```js
-  class MyFormExtension extends FormExtension {
+class MyFormExtension extends FormExtension {
-      onShare(formId) {
+  onShare(formId) {
-          console.log('FormExtension onShare, formId:' + formId);
+    console.log('FormExtension onShare, 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
+```
\ No newline at end of file