From d2dbf8cc8a7387a48a0b41dfed46efc4a9ab9292 Mon Sep 17 00:00:00 2001 From: Gloria Date: Mon, 8 May 2023 18:04:12 +0800 Subject: [PATCH] Update docs against 17211+17051 Signed-off-by: wusongqing --- ...is-app-ability-abilityDelegatorRegistry.md | 6 +- .../apis/js-apis-app-ability-appManager.md | 18 +- ...apis-inner-application-abilityDelegator.md | 288 ++++++++++++++++-- ...s-apis-inner-application-abilityMonitor.md | 10 +- ...is-inner-application-abilityRunningInfo.md | 8 +- ...s-inner-application-abilityStageMonitor.md | 5 +- ...is-inner-application-processInformation.md | 8 +- ...s-apis-inner-application-shellCmdResult.md | 10 +- 8 files changed, 300 insertions(+), 53 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md b/en/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md index 7661408529..54785d5ddb 100644 --- a/en/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md +++ b/en/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md @@ -53,10 +53,10 @@ let want = { abilityName: 'EntryAbility' }; abilityDelegator.startAbility(want, (err) => { - if (!err || err.code === 0) { - console.log('Success start ability.'); - } else { + if (err) { console.error('Failed start ability, error: ${JSON.stringify(err)}'); + } else { + console.log('Success start ability.'); } }); ``` diff --git a/en/application-dev/reference/apis/js-apis-app-ability-appManager.md b/en/application-dev/reference/apis/js-apis-app-ability-appManager.md index f3e739c76a..2cc4bb1b4d 100644 --- a/en/application-dev/reference/apis/js-apis-app-ability-appManager.md +++ b/en/application-dev/reference/apis/js-apis-app-ability-appManager.md @@ -40,7 +40,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error import appManager from '@ohos.app.ability.appManager'; appManager.isRunningInStabilityTest((err, flag) => { - if (err && err.code !== 0) { + if (err) { console.error('isRunningInStabilityTest fail, err: ${JSON.stringify(err)}'); } else { console.log('The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}'); @@ -146,7 +146,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error import appManager from '@ohos.app.ability.appManager'; appManager.isRamConstrainedDevice((err, data) => { - if (err && err.code !== 0) { + if (err) { console.error('isRamConstrainedDevice fail, err: ${JSON.stringify(err)}'); } else { console.log('The result of isRamConstrainedDevice is: ${JSON.stringify(data)}'); @@ -216,7 +216,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error import appManager from '@ohos.app.ability.appManager'; appManager.getAppMemorySize((err, data) => { - if (err && err.code !== 0) { + if (err) { console.error('getAppMemorySize fail, err: ${JSON.stringify(err)}'); } else { console.log('The size of app memory is: ${JSON.stringify(data)}'); @@ -290,7 +290,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error import appManager from '@ohos.app.ability.appManager'; appManager.getRunningProcessInformation((err, data) => { - if (err && err.code !== 0) { + if (err) { console.error('getRunningProcessInformation fail, err: ${JSON.stringify(err)}'); } else { console.log('The process running information is: ${JSON.stringify(data)}'); @@ -489,7 +489,7 @@ try { // 2. Deregister the application state observer. function unregisterApplicationStateObserverCallback(err) { - if (err && err.code !== 0) { + if (err) { console.error('unregisterApplicationStateObserverCallback fail, err: ${JSON.stringify(err)}'); } else { console.log('unregisterApplicationStateObserverCallback success.'); @@ -612,7 +612,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error import appManager from '@ohos.app.ability.appManager'; function getForegroundApplicationsCallback(err, data) { - if (err && err.code !== 0) { + if (err) { console.error('getForegroundApplicationsCallback fail, err: ${JSON.stringify(err)}'); } else { console.log('getForegroundApplicationsCallback success, data: ${JSON.stringify(data)}'); @@ -745,7 +745,7 @@ import appManager from '@ohos.app.ability.appManager'; let bundleName = 'bundleName'; let accountId = 0; function killProcessWithAccountCallback(err, data) { - if (err && err.code !== 0) { + if (err) { console.error('killProcessWithAccountCallback fail, err: ${JSON.stringify(err)}'); } else { console.log('killProcessWithAccountCallback success.'); @@ -788,7 +788,7 @@ import appManager from '@ohos.app.ability.appManager'; let bundleName = 'bundleName'; function killProcessesByBundleNameCallback(err, data) { - if (err && err.code !== 0) { + if (err) { console.error('killProcessesByBundleNameCallback fail, err: ${JSON.stringify(err)}'); } else { console.log('killProcessesByBundleNameCallback success.'); @@ -884,7 +884,7 @@ import appManager from '@ohos.app.ability.appManager'; let bundleName = 'bundleName'; function clearUpApplicationDataCallback(err, data) { - if (err && err.code !== 0) { + if (err) { console.error('clearUpApplicationDataCallback fail, err: ${JSON.stringify(err)}'); } else { console.log('clearUpApplicationDataCallback success.'); diff --git a/en/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md b/en/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md index 550e888888..ecefd737a3 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md @@ -6,6 +6,12 @@ The **AbilityDelegator** module provides APIs for managing **AbilityMonitor** in > > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. +## Modules to Import + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + ## Usage An **AbilityDelegator** object is obtained by calling [getAbilityDelegator](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetabilitydelegator) in **AbilityDelegatorRegistry**. @@ -30,10 +36,18 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | Yes | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) instance.| | callback | AsyncCallback\ | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | AddAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback, data: ${JSON.stringify(data)}'); @@ -70,10 +84,18 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | AddAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -105,10 +127,18 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | Yes | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) instance.| | callback | AsyncCallback\ | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | RemoveAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -145,10 +175,18 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | RemoveAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + - Example ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -180,10 +218,18 @@ Waits for the **Ability** instance that matches the **AbilityMonitor** instance | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | Yes | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) instance.| | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -196,7 +242,7 @@ let monitor = { abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator.waitAbilityMonitor(monitor, (error : any, data : any) => { - if (error && error.code !== 0) { + if (error) { console.error('waitAbilityMonitor fail, error: ${JSON.stringify(error)}'); } else { console.log('waitAbilityMonitor success, data: ${JSON.stringify(data)}'); @@ -220,10 +266,18 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo | timeout | number | No | Maximum waiting time, in milliseconds. | | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let timeout = 100; function onAbilityCreateCallback(data) { @@ -268,10 +322,18 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo | ----------------------------------------------------------- | -------------------------- | | Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | Promise used to return the **Ability** instance.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -305,7 +367,7 @@ Obtains the application context. **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); let context = abilityDelegator.getAppContext(); @@ -334,7 +396,7 @@ Obtains the lifecycle state of an ability. **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -360,10 +422,18 @@ Obtains the top ability of this application. This API uses an asynchronous callb | -------- | ------------------------------------------------------------ | ---- | ------------------ | | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | Yes | Callback used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | GetCurrentTopAbility failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -387,10 +457,18 @@ Obtains the top ability of this application. This API uses a promise to return t | ----------------------------------------------------------- | -------------------------------------- | | Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | Promise used to return the top ability.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | GetCurrentTopAbility failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -415,10 +493,30 @@ Starts an ability. This API uses an asynchronous callback to return the result. | want | [Want](js-apis-application-want.md) | Yes | **Want** parameter for starting the ability. | | callback | AsyncCallback\ | Yes | Callback used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000001 | The specified ability does not exist. | +| 16000002 | Incorrect ability type. | +| 16000004 | Can not start invisible component. | +| 16000005 | The specified process does not have the permission. | +| 16000006 | Cross-user operations are not allowed. | +| 16000008 | The crowdtesting application expires. | +| 16000009 | An ability cannot be started or stopped in Wukong mode. | +| 16000010 | The call with the continuation flag is forbidden. | +| 16000011 | The context does not exist. | +| 16000050 | Internal error. | +| 16000053 | The ability is not on the top of the UI. | +| 16000055 | Installation-free timed out. | +| 16200001 | The caller has been released. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let want = { bundleName: 'bundleName', abilityName: 'abilityName' @@ -450,10 +548,30 @@ Starts an ability. This API uses a promise to return the result. | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000001 | The specified ability does not exist. | +| 16000002 | Incorrect ability type. | +| 16000004 | Can not start invisible component. | +| 16000005 | The specified process does not have the permission. | +| 16000006 | Cross-user operations are not allowed. | +| 16000008 | The crowdtesting application expires. | +| 16000009 | An ability cannot be started or stopped in Wukong mode. | +| 16000010 | The call with the continuation flag is forbidden. | +| 16000011 | The context does not exist. | +| 16000050 | Internal error. | +| 16000053 | The ability is not on the top of the UI. | +| 16000055 | Installation-free timed out. | +| 16200001 | The caller has been released. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let want = { bundleName: 'bundleName', abilityName: 'abilityName' @@ -480,10 +598,18 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses an | ability | UIAbility | Yes | Target ability. | | callback | AsyncCallback\ | Yes | Callback used to return the result.
\- **true**: The operation is successful.
\- **false**: The operation failed.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | DoAbilityForeground failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -516,10 +642,18 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses a p | ----------------- | ------------------------------------------------------------ | | Promise\ | Promise used to return the result.
\- **true**: The operation is successful.
\- **false**: The operation failed.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | DoAbilityForeground failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -547,10 +681,18 @@ Schedules the lifecycle state of an ability to **Background**. This API uses an | ability | UIAbility | Yes | Target ability. | | callback | AsyncCallback\ | Yes | Callback used to return the result.
\- **true**: The operation is successful.
\- **false**: The operation failed.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | DoAbilityBackground failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -583,10 +725,18 @@ Schedules the lifecycle state of an ability to **Background**. This API uses a p | ----------------- | ------------------------------------------------------------ | | Promise\ | Promise used to return the result.
\- **true**: The operation is successful.
\- **false**: The operation failed.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | DoAbilityBackground failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -616,7 +766,7 @@ Prints log information to the unit test console. **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -641,7 +791,7 @@ Prints log information to the unit test console. This API uses an asynchronous c **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -673,7 +823,7 @@ Prints log information to the unit test console. This API uses a promise to retu **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -700,7 +850,7 @@ Executes a shell command. This API uses an asynchronous callback to return the r **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -728,7 +878,7 @@ Executes a shell command with the timeout period specified. This API uses an asy **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; let timeout = 100; @@ -762,7 +912,7 @@ Executes a shell command with the timeout period specified. This API uses a prom **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; let timeout = 100; @@ -788,10 +938,18 @@ Finishes the test and prints log information to the unit test console. This API | code | number | Yes | Log code. | | callback | AsyncCallback\ | Yes | Callback used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | FinishTest failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -821,10 +979,18 @@ Finishes the test and prints log information to the unit test console. This API | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | FinishTest failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -848,10 +1014,18 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | Yes | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) instance.| | callback | AsyncCallback\ | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | AddAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -884,10 +1058,18 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | AddAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -915,10 +1097,18 @@ Removes an **AbilityStageMonitor** instance from the application memory. This AP | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | Yes | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) instance.| | callback | AsyncCallback\ | Yes | Callback used to return the result. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | RemoveAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -951,10 +1141,18 @@ Removes an **AbilityStageMonitor** object from the application memory. This API | -------------- | ------------------- | | Promise\ | Promise used to return the result.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | RemoveAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -982,10 +1180,18 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | Yes | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) instance.| | callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -1023,10 +1229,18 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A | -------------- | ------------------- | | Promise\ | Promise used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned.| +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -1059,10 +1273,18 @@ Waits a period of time for an **AbilityStage** instance that matches the conditi | timeout | number | No | Maximum waiting time, in milliseconds.| | callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned. | +**Error codes** + +| ID| Error Message| +| ------- | -------- | +| 16000100 | WaitAbilityStageMonitor failed. | + +For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md). + **Example** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let timeout = 100; function onAbilityCreateCallback(data) { diff --git a/en/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md b/en/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md index e64c3175c7..476fb18d73 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md @@ -6,6 +6,12 @@ The **AbilityMonitor** module provides monitors for abilities that meet specifie > > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +## Modules to Import + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + ## Usage **AbilityMonitor** can be used as an input parameter of [addAbilityMonitor](js-apis-inner-application-abilityDelegator.md#addabilitymonitor9) in **abilityDelegator** to listen for lifecycle changes of an ability. @@ -43,9 +49,9 @@ let monitor = { onAbilityCreate: onAbilityCreateCallback }; -let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator.addAbilityMonitor(monitor, (error : any) => { - if (error && error.code !== 0) { + if (error) { console.error('addAbilityMonitor fail, error: ${JSON.stringify(error)}'); } }); diff --git a/en/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md b/en/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md index f041998eb6..337f71f715 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md @@ -6,6 +6,12 @@ The **AbilityRunningInfo** module defines the running information and state of a > > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. +## Modules to Import + +```ts +import abilitymanager from '@ohos.app.ability.abilityManager'; +``` + ## Usage The ability running information is obtained by calling [getAbilityRunningInfos](js-apis-app-ability-abilityManager.md#getabilityrunninginfos) in **abilityManager**. @@ -31,7 +37,7 @@ The ability running information is obtained by calling [getAbilityRunningInfos]( import abilitymanager from '@ohos.app.ability.abilityManager'; abilitymanager.getAbilityRunningInfos((error, data) => { - if (error && error.code !== 0) { + if (error) { console.error('getAbilityRunningInfos fail, error: ${JSON.stringify(error)}'); } else { console.log('getAbilityRunningInfos success, data: ${JSON.stringify(data)}'); diff --git a/en/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md b/en/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md index 90fa9dc102..c462bb3e3e 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md @@ -1,6 +1,7 @@ # AbilityStageMonitor -The **AbilityStageMonitor** module provides conditions for matching **AbilityStage** instances. The most recently matched **AbilityStage** instance is saved in an **AbilityStageMonitor** instance. +The **AbilityStageMonitor** module provides conditions for matching **AbilityStage** instances. The most recently matched **AbilityStage** instance is saved in an **AbilityStageMonitor** instance. + **System capability**: SystemCapability.Ability.AbilityRuntime.Core @@ -20,7 +21,7 @@ let monitor = { let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => { - if (error && error.code !== 0) { + if (error) { console.error('waitAbilityStageMonitor fail, error: ${JSON.stringify(error)}'); } else { console.log('waitAbilityStageMonitor success, data: ${JSON.stringify(data)}'); diff --git a/en/application-dev/reference/apis/js-apis-inner-application-processInformation.md b/en/application-dev/reference/apis/js-apis-inner-application-processInformation.md index d2ee664b5f..3c3822f6ca 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-processInformation.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-processInformation.md @@ -6,6 +6,12 @@ The **ProcessInformation** module defines the running information of a process. > > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +## Modules to Import + +```ts +import appManager from '@ohos.app.ability.appManager'; +``` + ## How to Use The process information is obtained by calling [getRunningProcessInformation](js-apis-app-ability-appManager.md#appmanagergetrunningprocessinformation9) of the **appManager** module. @@ -14,7 +20,7 @@ The process information is obtained by calling [getRunningProcessInformation](js import appManager from '@ohos.app.ability.appManager'; appManager.getRunningProcessInformation((error, data) => { - if (error && error.code !== 0) { + if (error) { console.error('getRunningProcessInformation fail, error: ${JSON.stringify(error)}'); } else { console.log('getRunningProcessInformation success, data: ${JSON.stringify(data)}'); diff --git a/en/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md b/en/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md index ca376d9776..1692916d93 100644 --- a/en/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md +++ b/en/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md @@ -6,6 +6,12 @@ The **ShellCmdResult** module provides the shell command execution result. > > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. +## Modules to Import + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + **System capability**: SystemCapability.Ability.AbilityRuntime.Core | Name | Type | Readable| Writable| Description | @@ -20,12 +26,12 @@ The result is obtained by calling [executeShellCommand](js-apis-inner-applicatio **Example** ```ts import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator.executeShellCommand(cmd, (error: any, data: any) => { - if (error && error.code !== 0) { + if (error) { console.error('executeShellCommand fail, error: ${JSON.stringify(error)}'); } else { console.log('executeShellCommand success, data: ${JSON.stringify(data)}'); -- GitLab