未验证 提交 1cfaf01e 编写于 作者: O openharmony_ci 提交者: Gitee

!2901 Done! 2459:API断链修复+标题修复

Merge pull request !2901 from wusongqing/TR2459
...@@ -51,17 +51,23 @@ deleteForm(formId: string): Promise<void>; ...@@ -51,17 +51,23 @@ deleteForm(formId: string): Promise<void>;
Deletes a widget. This API uses a promise to return the result. After this API is called, the application can no longer use the widget, and the Widget Manager will not retain the widget information. Deletes a widget. This API uses a promise to return the result. After this API is called, the application can no longer use the widget, and the Widget Manager will not retain the widget information.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Parameters**
```js ```js
var formId = "12400633174999288"; var formId = "12400633174999288";
...@@ -144,6 +150,11 @@ SystemCapability.Ability.Form ...@@ -144,6 +150,11 @@ SystemCapability.Ability.Form
| formId | string | Yes | ID of a widget. | | formId | string | Yes | ID of a widget. |
| isReleaseCache | boolean | No | Whether to release the cache.| | isReleaseCache | boolean | No | Whether to release the cache.|
**Return value**
| Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -188,15 +199,21 @@ requestForm(formId: string): Promise<void>; ...@@ -188,15 +199,21 @@ requestForm(formId: string): Promise<void>;
Requests a widget update. This API uses a promise to return the result. Requests a widget update. This API uses a promise to return the result.
**System capability**
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -239,7 +256,11 @@ SystemCapability.Ability.Form ...@@ -239,7 +256,11 @@ SystemCapability.Ability.Form
castTempForm(formId: string): Promise<void>; castTempForm(formId: string): Promise<void>;
Converts a temporary widget to a normal one. This API uses a promise to return the result. Converts a temporary widget to a normal one. This API uses a promise to return the result.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
...@@ -247,9 +268,11 @@ Converts a temporary widget to a normal one. This API uses a promise to return t ...@@ -247,9 +268,11 @@ Converts a temporary widget to a normal one. This API uses a promise to return t
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -294,15 +317,21 @@ notifyVisibleForms(formId: string): Promise<void>; ...@@ -294,15 +317,21 @@ notifyVisibleForms(formId: string): Promise<void>;
Instructs the widget framework to make a widget visible. This API uses a promise to return the result. After this API is called, **onVisibilityChange** is invoked to notify the widget provider. Instructs the widget framework to make a widget visible. This API uses a promise to return the result. After this API is called, **onVisibilityChange** is invoked to notify the widget provider.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -347,15 +376,21 @@ notifyInvisibleForms(formId: string): Promise<void>; ...@@ -347,15 +376,21 @@ notifyInvisibleForms(formId: string): Promise<void>;
Instructs the widget framework to make a widget invisible. This API uses a promise to return the result. After this API is called, **onVisibilityChange** is invoked to notify the widget provider. Instructs the widget framework to make a widget invisible. This API uses a promise to return the result. After this API is called, **onVisibilityChange** is invoked to notify the widget provider.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -400,15 +435,21 @@ enableFormsUpdate(formId: string): Promise<void>; ...@@ -400,15 +435,21 @@ enableFormsUpdate(formId: string): Promise<void>;
Instructs the widget framework to make a widget to be updatable. This API uses a promise to return the result. After this API is called, the widget is in the enabled state and can receive updates from the widget provider. Instructs the widget framework to make a widget to be updatable. This API uses a promise to return the result. After this API is called, the widget is in the enabled state and can receive updates from the widget provider.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -453,15 +494,21 @@ disableFormsUpdate(formId: string): Promise<void>; ...@@ -453,15 +494,21 @@ disableFormsUpdate(formId: string): Promise<void>;
Instructs the widget framework to make a widget not to be updatable. This API uses a promise to return the result. After this API is called, the widget is in the disabled state and cannot receive updates from the widget provider. Instructs the widget framework to make a widget not to be updatable. This API uses a promise to return the result. After this API is called, the widget is in the disabled state and cannot receive updates from the widget provider.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | Yes | ID of a widget.| | formId | string | Yes | ID of a widget.|
**System capability**: **Return value**
SystemCapability.Ability.Form | Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
...@@ -509,6 +556,12 @@ Checks whether the system is ready. This API uses a promise to return the result ...@@ -509,6 +556,12 @@ Checks whether the system is ready. This API uses a promise to return the result
SystemCapability.Ability.Form SystemCapability.Ability.Form
**Return value**
| Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
```js ```js
...@@ -686,7 +739,11 @@ SystemCapability.Ability.Form ...@@ -686,7 +739,11 @@ SystemCapability.Ability.Form
function deleteInvalidForms(formIds: Array&ltstring&gt): Promise<number>; function deleteInvalidForms(formIds: Array&ltstring&gt): Promise<number>;
Deletes invalid widgets from the list. This API uses a promise to return the result. Deletes invalid widgets from the list. This API uses a promise to return the result.
**System capability**:
SystemCapability.Ability.Form
**Parameters** **Parameters**
...@@ -700,10 +757,6 @@ Deletes invalid widgets from the list. This API uses a promise to return the res ...@@ -700,10 +757,6 @@ Deletes invalid widgets from the list. This API uses a promise to return the res
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise<number> | Promise used to return the number of widgets deleted.| | Promise<number> | Promise used to return the number of widgets deleted.|
**System capability**:
SystemCapability.Ability.Form
**Example** **Example**
```js ```js
...@@ -747,7 +800,7 @@ SystemCapability.Ability.Form ...@@ -747,7 +800,7 @@ SystemCapability.Ability.Form
## acquireFormState ## acquireFormState
function acquireFormState(formIds: Array&ltstring&gt): Promise<formInfo.FormStateInfo>; function acquireFormState(want: Want): Promise<FormStateInfo>;
Obtains the widget state. This API uses a promise to return the result. Obtains the widget state. This API uses a promise to return the result.
...@@ -784,7 +837,7 @@ SystemCapability.Ability.Form ...@@ -784,7 +837,7 @@ SystemCapability.Ability.Form
on(type: "formUninstall", callback: Callback<string>): void; on(type: "formUninstall", callback: Callback<string>): void;
Subscribes to the widget state changes. This API uses a callback to return the result. Subscribes to widget uninstall events.
**System capability**: **System capability**:
...@@ -811,7 +864,7 @@ SystemCapability.Ability.Form ...@@ -811,7 +864,7 @@ SystemCapability.Ability.Form
off(type: "formUninstall", callback: Callback<string>): void; off(type: "formUninstall", callback: Callback<string>): void;
Unsubscribes from the widget state changes. This API uses a callback to return the result. Unsubscribes from widget uninstall events.
**System capability**: **System capability**:
...@@ -880,6 +933,12 @@ SystemCapability.Ability.Form ...@@ -880,6 +933,12 @@ SystemCapability.Ability.Form
| formIds | Array<string> | Yes | List of widget IDs.| | formIds | Array<string> | Yes | List of widget IDs.|
| isVisible | boolean | Yes | Whether to be visible.| | isVisible | boolean | Yes | Whether to be visible.|
**Return value**
| Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
```js ```js
...@@ -935,6 +994,12 @@ SystemCapability.Ability.Form ...@@ -935,6 +994,12 @@ SystemCapability.Ability.Form
| formIds | Array<string> | Yes | List of widget IDs.| | formIds | Array<string> | Yes | List of widget IDs.|
| isEnableUpdate | boolean | Yes | Whether to enable update.| | isEnableUpdate | boolean | Yes | Whether to enable update.|
**Return value**
| Type| Description|
| -------- | -------- |
| Promise<void> | Promise used to return the result indicating whether the API is successfully called.|
**Example** **Example**
```js ```js
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册