openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 23:30:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix remaining problems

Browse Source 
Signed-off-by: xinking129 <xinxin13@huawei.com>
This commit is contained in:
xinking129 2023-05-10 16:47:17 +08:00
parent 8742fc8ec0
commit 5234000caa
8 changed files with 27 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api/@internal/ets/lifecycle.d.ts vendored
View File

@ -75,7 +75,7 @@ export declare interface LifecycleForm {
/**
* Called when the form provider receives form events from the system.
*
* @param { number } newStatus Indicates the form events occurred. The key in the {@code Map} object indicates
* @param { object } newStatus Indicates the form events occurred. The key in the {@code Map} object indicates
* form ID,and the value indicates the event type, which can be either
* {@link formInfo#VisibilityType#FORM_VISIBLE} or
* {@link formInfo#VisibilityType#FORM_INVISIBLE}.
@ -132,7 +132,7 @@ export declare interface LifecycleForm {
* Called when the system shares the form.
*
* @param { string } formId Indicates the ID of the deleted form.
* @returns { any } Returns the wantParams object.
* @returns { object } Returns the wantParams object.
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @systemapi
* @FAModelOnly

6
api/@ohos.app.ability.UIAbility.d.ts vendored
View File

@ -333,7 +333,7 @@ export default class UIAbility extends Ability {
/**
* Called back when an ability prepares to continue.
*
* @param { Object } wantParam - Indicates the want parameter.
* @param { object } wantParam - Indicates the want parameter.
* @returns { AbilityConstant.OnContinueResult } Return the result of onContinue.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
@ -370,7 +370,7 @@ export default class UIAbility extends Ability {
* Called back when an ability prepares to save.
*
* @param { AbilityConstant.StateType } reason state type when save.
* @param { Object } wantParam Indicates the want parameter.
* @param { object } wantParam Indicates the want parameter.
* @returns { AbilityConstant.OnSaveResult } agree with the current UIAbility status or not.return 0 if ability
* agrees to save data successfully, otherwise errcode.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
@ -382,7 +382,7 @@ export default class UIAbility extends Ability {
/**
* Called back when an ability shares data.
*
* @param { Object } wantParam - Indicates the want parameter.
* @param { object } wantParam - Indicates the want parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
* @since 10

4
api/@ohos.app.ability.abilityManager.d.ts vendored
View File

@ -169,7 +169,7 @@ declare namespace abilityManager {
* Acquire the shared data from target ability.
*
* @param { number } missionId - The missionId of target ability.
* @param { Object } callback - The callback is used to return the params of sharing
* @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback is used to return the params of sharing
* data and result code.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
@ -184,7 +184,7 @@ declare namespace abilityManager {
* Acquire the shared data from target ability.
*
* @param { number } missionId - The missionId of target ability.
* @returns { Object } The promise returned by the function.
* @returns { Promise<{ [key: string]: Object }> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000050 - Internal error.

2
api/@ohos.app.ability.wantAgent.d.ts vendored
View File

@ -414,7 +414,7 @@ declare namespace wantAgent {
/**
* Extra data collected by the common event.
*
* @type { ?Object }
* @type { [key: string]: Object }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/

6
api/@ohos.app.form.FormExtensionAbility.d.ts vendored
View File

@ -74,7 +74,7 @@ export default class FormExtensionAbility {
/**
* Called when the form provider receives form events from the system.
*
* @param { number } newStatus - Indicates the form events occurred. The key in the {@code Map}
* @param { object } newStatus - Indicates the form events occurred. The key in the {@code Map}
* object indicates the form ID, and the value indicates the event
* type, which can be either
* {@link formInfo#VisibilityType#FORM_VISIBLE} or
@ -142,7 +142,7 @@ export default class FormExtensionAbility {
* Called when the system shares the form.
*
* @param { string } formId - Indicates the ID of the form.
* @returns { Object } Returns the wantParams object.
* @returns { object } Returns the wantParams object.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly
@ -154,7 +154,7 @@ export default class FormExtensionAbility {
* Called when the system acquire the form data.
*
* @param { string } formId - Indicates the ID of the form.
* @returns { Object } Returns the wantParams object.
* @returns { object } Returns the wantParams object.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly

24
api/@ohos.app.form.formHost.d.ts vendored
View File

@ -520,7 +520,7 @@ function getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<fo
/**
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
* @permission ohos.permission.REQUIRE_FORM
* @param { AsyncCallback<Array<RunningFormInfo>> } callback - The callback is used to return the RunningFormInfo.
* @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback is used to return the RunningFormInfo.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
@ -536,7 +536,7 @@ function getRunningFormInfos(callback: AsyncCallback<Array<formInfo.RunningFormI
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
* @permission ohos.permission.REQUIRE_FORM
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @returns { Promise<Array<RunningFormInfo>> } Returns the RunningFormInfo.
* @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
@ -659,7 +659,7 @@ function off(type: 'formUninstall', callback?: Callback<string>): void;
* Listens to the event of add form.
* <p>You can use this method to listen to the event of add form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } type - Indicates event type.
* @param { 'formAdd' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running form info.
* @param { string } bundleName - Indicates the bundle name of the form host application.
* @throws { BusinessError } 202 - The application is not a system application.
@ -668,12 +668,12 @@ function off(type: 'formUninstall', callback?: Callback<string>): void;
* @systemapi
* @since 10
*/
function on(type: "formAdd", observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
function on(type: 'formAdd', observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
/**
* Cancels listening to the event of add form.
* <p>You can use this method to cancel listening to the event of add form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } type - Indicates event type.
* @param { 'formAdd' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running form info.
* @param { string } bundleName - Indicates the bundle name of the form host application.
* @throws { BusinessError } 202 - The application is not a system application.
@ -682,13 +682,13 @@ function on(type: "formAdd", observerCallback: Callback<formInfo.RunningFormInfo
* @systemapi
* @since 10
*/
function off(type: "formAdd", observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
function off(type: 'formAdd', observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
/**
* Listens to the event of remove form.
* <p>You can use this method to listen to the event of remove form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } type - Indicates event type.
* @param { 'formRemove' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running form info.
* @param { string } bundleName - Indicates the bundle name of the form host application.
* @throws { BusinessError } 202 - The application is not a system application.
@ -697,13 +697,13 @@ function off(type: "formAdd", observerCallback?: Callback<formInfo.RunningFormIn
* @systemapi
* @since 10
*/
function on(type: "formRemove", observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
function on(type: 'formRemove', observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
/**
* Cancels listening to the event of remove form.
* <p>You can use this method to cancel listening to the event of remove form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } type - Indicates event type.
* @param { 'formRemove' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running form info.
* @param { string } bundleName - Indicates the bundle name of the form host application.
* @throws { BusinessError } 202 - The application is not a system application.
@ -712,7 +712,7 @@ function on(type: "formRemove", observerCallback: Callback<formInfo.RunningFormI
* @systemapi
* @since 10
*/
function off(type: "formRemove", observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
function off(type: 'formRemove', observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void;
/**
* Notify form is Visible
@ -889,7 +889,7 @@ function notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolea
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @param { Object } callback - The callback of acquireFormData.
* @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback of acquireFormData.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16500050 - An IPC connection error happened.
@ -909,7 +909,7 @@ function acquireFormData(formId: string, callback: AsyncCallback<{ [key: string]
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @returns { Object } The promise returned by the function.
* @returns { Promise<{ [key: string]: Object }> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16500050 - An IPC connection error happened.

8
api/@ohos.continuation.continuationManager.d.ts vendored
View File

@ -113,7 +113,7 @@ declare namespace continuationManager {
* @syscap SystemCapability.Ability.DistributedAbilityManager
* @since 8
* @deprecated since 9
* @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceSelected")
* @useinstead ohos.continuation.continuationManager.continuationManager on(type: "deviceSelected")
*/
function on(type: 'deviceConnect', callback: Callback<ContinuationResult>): void;
@ -128,7 +128,7 @@ declare namespace continuationManager {
* @syscap SystemCapability.Ability.DistributedAbilityManager
* @since 8
* @deprecated since 9
* @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceSelected")
* @useinstead ohos.continuation.continuationManager.continuationManager off(type: "deviceSelected")
*/
function off(type: 'deviceConnect', callback?: Callback<ContinuationResult>): void;
@ -142,7 +142,7 @@ declare namespace continuationManager {
* @syscap SystemCapability.Ability.DistributedAbilityManager
* @since 8
* @deprecated since 9
* @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceUnSelected")
* @useinstead ohos.continuation.continuationManager.continuationManager on(type: "deviceUnSelected")
*/
function on(type: 'deviceDisconnect', callback: Callback<string>): void;
@ -156,7 +156,7 @@ declare namespace continuationManager {
* @syscap SystemCapability.Ability.DistributedAbilityManager
* @since 8
* @deprecated since 9
* @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceUnSelected")
* @useinstead ohos.continuation.continuationManager.continuationManager off(type: "deviceUnSelected")
*/
function off(type: 'deviceDisconnect', callback?: Callback<string>): void;

2
api/@ohos.data.dataAbility.d.ts vendored
View File

@ -304,8 +304,6 @@ declare namespace dataAbility {
*
* @param { number } value Indicates the max length of the return list.
* @returns { DataAbilityPredicates } Returns the SQL query statement with the specified DataAbilityPredicates.
* @throws { BusinessError } IllegalPredicateException Throws this exception if DataAbilityPredicates are added
* to a wrong position.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @since 7
*/