From 618ff2df496b29c2e07d0af39a9a7d3253ca78eb Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Fri, 7 Apr 2023 15:28:45 +0800 Subject: [PATCH] Modify release the secondary import module of ability Signed-off-by: yuyaozhi --- ...is-app-ability-abilityLifecycleCallback.md | 2 - .../apis/js-apis-app-ability-appRecovery.md | 1 - .../js-apis-inner-ability-abilityResult.md | 6 + .../js-apis-inner-ability-connectOptions.md | 8 +- ...js-apis-inner-ability-dataAbilityHelper.md | 122 +++++--- ...apis-inner-ability-dataAbilityOperation.md | 6 + ...js-apis-inner-ability-dataAbilityResult.md | 101 ++++--- ...pis-inner-ability-startAbilityParameter.md | 8 +- .../apis/js-apis-inner-ability-want.md | 6 + .../apis/js-apis-inner-app-appVersionInfo.md | 6 + .../apis/js-apis-inner-app-context.md | 274 +++++++++++------- .../apis/js-apis-inner-app-processInfo.md | 6 + ...apis-inner-application-abilityDelegator.md | 70 +++-- ...-inner-application-abilityDelegatorArgs.md | 8 +- ...s-apis-inner-application-abilityMonitor.md | 14 +- ...is-inner-application-abilityRunningInfo.md | 6 + ...s-inner-application-abilityStageContext.md | 6 + ...s-inner-application-abilityStageMonitor.md | 3 +- ...apis-inner-application-abilityStateData.md | 6 + .../js-apis-inner-application-appStateData.md | 6 + ...is-inner-application-applicationContext.md | 8 +- ...er-application-applicationStateObserver.md | 6 + .../js-apis-inner-application-baseContext.md | 6 + .../apis/js-apis-inner-application-context.md | 40 ++- ...js-apis-inner-application-errorObserver.md | 8 +- .../js-apis-inner-application-eventHub.md | 6 + ...apis-inner-application-extensionContext.md | 6 + ...-inner-application-extensionRunningInfo.md | 6 + ...-inner-application-formExtensionContext.md | 6 + .../js-apis-inner-application-missionInfo.md | 6 + ...-apis-inner-application-missionListener.md | 6 + ...-apis-inner-application-missionSnapshot.md | 6 + .../js-apis-inner-application-processData.md | 6 + ...is-inner-application-processInformation.md | 6 + ...is-inner-application-processRunningInfo.md | 6 + ...ner-application-serviceExtensionContext.md | 6 + ...s-apis-inner-application-shellCmdResult.md | 10 +- ...apis-inner-application-uiAbilityContext.md | 6 + .../js-apis-inner-wantAgent-triggerInfo.md | 6 + .../js-apis-inner-wantAgent-wantAgentInfo.md | 6 + 40 files changed, 597 insertions(+), 230 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md index e511535d7b..5ff9e7f213 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md @@ -7,14 +7,12 @@ AbilityLifecycleCallback模块提供应用上下文[ApplicationContext](js-apis- > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 - ## 导入模块 ```ts import AbilityLifecycleCallback from '@ohos.app.ability.AbilityLifecycleCallback'; ``` - ## AbilityLifecycleCallback.onAbilityCreate onAbilityCreate(ability: UIAbility): void; diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md index 8a768f9340..a1d0b6d1aa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md @@ -11,7 +11,6 @@ appRecovery模块提供了应用在故障状态下的恢复能力。 import appRecovery from '@ohos.app.ability.appRecovery'; ``` - ## appRecovery.RestartFlag 应用重启标志，[enableAppRecovery](#apprecoveryenableapprecovery)接口重启选项参数，该类型为枚举。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md index bd3e4af851..d120591db8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md @@ -6,6 +6,12 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import ability from '@ohos.ability.ability'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md index 8e08638fac..ccac9612b0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md @@ -2,6 +2,12 @@ 在连接指定的后台服务时作为入参用于接收连接过程中的状态变化，如作为[connectServiceExtensionAbility](js-apis-inner-application-serviceExtensionContext.md#serviceextensioncontextconnectserviceextensionability)的入参连接指定的ServiceExtensionAbility。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 参数名 | 类型 | 必填 | 说明 | @@ -18,7 +24,7 @@ abilityName: 'MyAbility' }; - let connectOptions = { + let connectOptions: common.ConnectOptions = { onConnect(elementName, remote) { console.log('onConnect elementName: ' + elementName); }, diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md index 95098d3299..3eaf81fc83 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md @@ -7,6 +7,12 @@ > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在FA模型下使用。 +## 导入模块 + +```ts +import ability from '@ohos.ability.ability'; +``` + ## 使用说明 使用前根据具体情况引入如下模块 @@ -35,7 +41,7 @@ openFile(uri: string, mode: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); let mode = 'rwt'; @@ -69,7 +75,7 @@ openFile(uri: string, mode: string): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); let mode = 'rwt'; @@ -98,7 +104,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let helper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); function onChangeNotify() { @@ -131,7 +137,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let helper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); function onChangeNotify() { @@ -167,7 +173,7 @@ getType(uri: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.getType('dataability:///com.example.DataAbility', (err, data) => { @@ -199,7 +205,7 @@ getType(uri: string): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.getType('dataability:///com.example.DataAbility').then((data) => { @@ -227,7 +233,7 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback> ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.getFileTypes('dataability:///com.example.DataAbility', @@ -291,7 +297,7 @@ normalizeUri(uri: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.normalizeUri('dataability:///com.example.DataAbility', (err, data) => { @@ -323,7 +329,7 @@ normalizeUri(uri: string): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.normalizeUri('dataability:///com.example.DataAbility',).then((data) => { @@ -350,7 +356,7 @@ denormalizeUri(uri: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.denormalizeUri('dataability:///com.example.DataAbility', (err, data) => { @@ -384,7 +390,7 @@ denormalizeUri(uri: string): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.denormalizeUri('dataability:///com.example.DataAbility',).then((data) => { @@ -411,7 +417,7 @@ notifyChange(uri: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let helper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); helper.notifyChange('dataability:///com.example.DataAbility', (err) => { @@ -443,7 +449,7 @@ notifyChange(uri: string): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); DAHelper.notifyChange('dataability:///com.example.DataAbility').then(() => { @@ -471,7 +477,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); const valueBucket = { @@ -545,7 +551,7 @@ batchInsert(uri: string, valuesBuckets: Array\, callback: Asyn ```ts import featureAbility from '@ohos.ability.featureAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); let cars = new Array({'name': 'roe11', 'age': 21, 'salary': 20.5, 'blobType': 'u8',}, @@ -582,7 +588,7 @@ batchInsert(uri: string, valuesBuckets: Array): Promise\, predicates: dataAbility.DataAbilityP ```ts import featureAbility from '@ohos.ability.featureAbility'; import ohos_data_ability from '@ohos.data.dataAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); let cars=new Array('value1', 'value2', 'value3', 'value4'); @@ -799,13 +805,49 @@ query(uri: string, columns?: Array\, predicates?: dataAbility.DataAbilit ```ts import featureAbility from '@ohos.ability.featureAbility'; import ohos_data_ability from '@ohos.data.dataAbility'; -let DAHelper = featureAbility.acquireDataAbilityHelper( +let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( 'dataability:///com.example.DataAbility' ); let cars = new Array('value1', 'value2', 'value3', 'value4'); let da = new ohos_data_ability.DataAbilityPredicates(); DAHelper.query('dataability:///com.example.DataAbility', cars, da).then((data) => { - console.info('==========================>queryCallback=======================>'); + console.info('query data: ${JSON.stringify(data)}'); +}); +``` + +## DataAbilityHelper.call + +call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\): void + +调用DataAbility的扩展接口（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示待处理的DataAbility。例：'dataability:///com.example.xxx.xxxx' | +| method | string | 是 | 指示被调用的方法名。 | +| arg | string | 是 | 指示需传入的参数。 | +| extras | [PacMap](#pacmap) | 是 | 指示扩展的键值对参数。 | +| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 指示数据操作的回调方法，返回操作结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +let dataAbilityHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( + 'dataability:///com.example.jsapidemo.UserDataAbility' +); +dataAbilityHelper.call('dataability:///com.example.jsapidemo.UserDataAbility', + 'method', 'arg', {'key1':'value1'}, (error, data) => { + if (error && error.code !== 0) { + console.error('call fail, error: ${JSON.stringify(error)}'); + } else { + console.log('call success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -837,8 +879,9 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( - 'dataability:///com.example.jsapidemo.UserDataAbility'); +let dataAbilityHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( + 'dataability:///com.example.jsapidemo.UserDataAbility' +); dataAbilityHelper.call('dataability:///com.example.jsapidemo.UserDataAbility', 'method', 'arg', {'key1':'value1'}).then((data) => { console.info('Operation succeeded: ' + data); @@ -905,13 +948,14 @@ import featureAbility from '@ohos.ability.featureAbility'; // 根据DataAbilityOperation列表选择要对数据库做的操作 let op=new Array(); -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( - 'dataability:///com.example.jsapidemo.UserDataAbility'); -dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', - op, (err, data) => { - if (err) { - console.error('Operation failed. Cause: ' + err); - return; +let dataAbilityHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( + 'dataability:///com.example.jsapidemo.UserDataAbility' +); +dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', op, (error, data) => { + if (error && error.code !== 0) { + console.error('executeBatch fail, error: ${JSON.stringify(error)}'); + } else { + console.log('executeBatch success, data: ${JSON.stringify(data)}'); } console.info('Operation succeeded: ' + data); }); @@ -945,11 +989,11 @@ import featureAbility from '@ohos.ability.featureAbility'; // 根据DataAbilityOperation列表选择要对数据库做的操作 let op=new Array(); -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( - 'dataability:///com.example.jsapidemo.UserDataAbility'); -dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', - op).then((data) => { - console.info('Operation succeeded: ' + data); +let dataAbilityHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper( + 'dataability:///com.example.jsapidemo.UserDataAbility' +); +dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', op).then((data) => { + console.info('executeBatch success, data: ${data}'); }).catch((error) => { console.error('Operation failed. Cause: ' + error); }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md index 80d5622dc2..246d6dff60 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md @@ -7,6 +7,12 @@ > 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本接口仅可在FA模型下使用 +## 导入模块 + +```ts +import ability from '@ohos.ability.ability'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel | 名称 | 类型 | 必填| 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md index e752168d3d..a46a893f96 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md @@ -7,6 +7,12 @@ > 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本接口仅可在FA模型下使用 +## 导入模块 + +```ts +import ability from '@ohos.ability.ability'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel | 名称 | 类型 | 必填 | 说明 | @@ -19,54 +25,57 @@ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let dataAbilityUri = ('dataability:///com.example.myapplication.TestDataAbility'); -let DAHelper; -try { - DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); - if (DAHelper == null) { - console.error('DAHelper is null'); +// 批量执行数据库操作 +function executeBatchOperation() { + let dataAbilityUri = ('dataability:///com.example.myapplication.TestDataAbility'); + let DAHelper: ability.DataAbilityHelper; + try { + DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); + if (DAHelper === null) { + console.error('DAHelper is null'); + } + } catch (err) { + console.error('acquireDataAbilityHelper fail, error: ${JSON.stringify(err)}'); } -} catch (err) { - console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err)); -} -let valueBucket = { - 'name': 'DataAbilityHelperTest', - 'age': 24, - 'salary': 2024.20, -}; -let operations = [ -{ - uri: dataAbilityUri, - type: featureAbility.DataAbilityOperationType.TYPE_INSERT, - valuesBucket: valueBucket, - predicates: null, - expectedCount: 1, - PredicatesBackReferences: {}, - interrupted: true, -}, -{ - uri: dataAbilityUri, - type: featureAbility.DataAbilityOperationType.TYPE_INSERT, - valuesBucket: valueBucket, - predicates: null, - expectedCount: 1, - PredicatesBackReferences: {}, - interrupted: true, -} -]; + let valueBucket = { + 'name': 'DataAbilityHelperTest', + 'age': 24, + 'salary': 2024.20, + }; + let operations = [ + { + uri: dataAbilityUri, + type: featureAbility.DataAbilityOperationType.TYPE_INSERT, + valuesBucket: valueBucket, + predicates: null, + expectedCount: 1, + PredicatesBackReferences: {}, + interrupted: true, + }, + { + uri: dataAbilityUri, + type: featureAbility.DataAbilityOperationType.TYPE_INSERT, + valuesBucket: valueBucket, + predicates: null, + expectedCount: 1, + PredicatesBackReferences: {}, + interrupted: true, + } + ]; -try { - let promise = DAHelper.executeBatch(dataAbilityUri, operations).then((data) => { - for (let i = 0; i < data.length; i++) { - let dataAbilityResult = data[i]; - console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri); - console.log('dataAbilityResult.count: ' + dataAbilityResult.count); - } - }).catch(err => { - console.error('executeBatch error: ' + JSON.stringify(err)); - }); -} catch (err) { - console.error('executeBatch error: ' + JSON.stringify(err)); + try { + DAHelper.executeBatch(dataAbilityUri, operations).then((data) => { + for (let i = 0; i < data.length; i++) { + let dataAbilityResult: ability.DataAbilityResult = data[i]; + console.log('dataAbilityResult.uri: ${dataAbilityResult.uri}'); + console.log('dataAbilityResult.count: ${dataAbilityResult.count}'); + } + }).catch(err => { + console.error('executeBatch error: ${JSON.stringify(err)}'); + }); + } catch (err) { + console.error('executeBatch error: ${JSON.stringify(err)}'); + } } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md index f966f4bd56..4310b503d1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md @@ -7,6 +7,12 @@ > 本接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本接口仅可在FA模型下使用 +## 导入模块 + +```ts +import ability from '@ohos.ability.ability'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel | 名称 | 类型 | 必填 | 说明 | @@ -30,7 +36,7 @@ let abilityStartSetting ={ [featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1, }; -let startAbilityParameter = { +let startAbilityParameter: ability.StartAbilityParameter = { want : Want, abilityStartSetting : abilityStartSetting }; diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md index f408cfa6e6..e3496f4f74 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md @@ -6,6 +6,12 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 > > 本模块首批接口从API version 6开始支持，从API version 9废弃，使用[@ohos.app.ability.Want](js-apis-app-ability-want.md)模块替代。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import Want from '@ohos.app.ability.Want'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md index 97f3298638..e535f3f30c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md @@ -6,6 +6,12 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md index b92863580e..f8064bb1fa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md @@ -7,13 +7,19 @@ Context模块提供了ability或application的上下文的能力，包括允许 > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在FA模型下使用。 +## 导入模块 + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +``` + ## 使用说明 Context对象是在featureAbility中创建实例，并通过featureAbility的[getContext](js-apis-ability-featureAbility.md#featureabilitygetcontext)接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下： ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getOrCreateLocalDir().then((data) => { console.info('getOrCreateLocalDir data: ' + JSON.stringify(data)); }); @@ -39,9 +45,13 @@ getOrCreateLocalDir(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getOrCreateLocalDir((err, data)=>{ - console.info('getOrCreateLocalDir err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getOrCreateLocalDir((error, data)=>{ + if (error && error.code !== 0) { + console.error('getOrCreateLocalDir fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getOrCreateLocalDir success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -67,7 +77,7 @@ getOrCreateLocalDir(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getOrCreateLocalDir().then((data) => { console.info('getOrCreateLocalDir data: ' + JSON.stringify(data)); }); @@ -93,8 +103,8 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async ```ts import featureAbility from '@ohos.ability.featureAbility'; -import bundle from '@ohos.bundle'; -let context = featureAbility.getContext(); +import bundle from '@ohos.bundle.bundleManager'; +let context: featureAbility.Context = featureAbility.getContext(); bundle.getBundleInfo('com.context.test', 1, (err, datainfo) =>{ context.verifyPermission('com.example.permission', {uid:datainfo.uid}, (err, data) =>{ console.info('verifyPermission err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); @@ -123,9 +133,13 @@ verifyPermission(permission: string, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.verifyPermission('com.example.permission', (err, data) =>{ - console.info('verifyPermission err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.verifyPermission('com.example.permission', (error, data) =>{ + if (error && error.code !== 0) { + console.error('verifyPermission fail, error: ${JSON.stringify(error)}'); + } else { + console.log('verifyPermission success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -154,7 +168,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\ { console.info('verifyPermission data: ' + JSON.stringify(data)); @@ -183,7 +197,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number, res ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.requestPermissionsFromUser( ['com.example.permission1', 'com.example.permission2', @@ -223,7 +237,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number): Pr ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.requestPermissionsFromUser( ['com.example.permission1', 'com.example.permission2', @@ -256,9 +270,13 @@ getApplicationInfo(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getApplicationInfo((err, data) => { - console.info('getApplicationInfo err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getApplicationInfo((error, data) => { + if (error && error.code !== 0) { + console.error('getApplicationInfo fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getApplicationInfo success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -282,7 +300,7 @@ getApplicationInfo(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getApplicationInfo().then((data) => { console.info('getApplicationInfo data: ' + JSON.stringify(data)); }); @@ -308,9 +326,13 @@ getBundleName(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getBundleName((err, data) => { - console.info('getBundleName err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getBundleName((error, data) => { + if (error && error.code !== 0) { + console.error('getBundleName fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getBundleName success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -334,7 +356,7 @@ getBundleName(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getBundleName().then((data) => { console.info('getBundleName data: ' + JSON.stringify(data)); }); @@ -358,9 +380,13 @@ getDisplayOrientation(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getDisplayOrientation((err, data) => { - console.info('getDisplayOrientation err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getDisplayOrientation((error, data) => { + if (error && error.code !== 0) { + console.error('getDisplayOrientation fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getDisplayOrientation success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -382,7 +408,7 @@ getDisplayOrientation(): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getDisplayOrientation().then((data) => { console.info('getDisplayOrientation data: ' + JSON.stringify(data)); }); @@ -406,9 +432,13 @@ getExternalCacheDir(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getExternalCacheDir((err, data) => { - console.info('getExternalCacheDir err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getExternalCacheDir((error, data) => { + if (error && error.code !== 0) { + console.error('getExternalCacheDir fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getExternalCacheDir success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -430,7 +460,7 @@ getExternalCacheDir(): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getExternalCacheDir().then((data) => { console.info('getExternalCacheDir data: ' + JSON.stringify(data)); }); @@ -456,10 +486,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal ```ts import featureAbility from '@ohos.ability.featureAbility'; import bundle from '@ohos.bundle'; -let context = featureAbility.getContext(); -let orientation=bundle.DisplayOrientation.UNSPECIFIED -context.setDisplayOrientation(orientation, (err) => { - console.info('setDisplayOrientation err: ' + JSON.stringify(err)); +let context: featureAbility.Context = featureAbility.getContext(); +let orientation = bundle.DisplayOrientation.UNSPECIFIED; +context.setDisplayOrientation(orientation, (error) => { + console.error('setDisplayOrientation fail, error: ${JSON.stringify(error)}'); }); ``` @@ -483,8 +513,8 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; import bundle from '@ohos.bundle'; -let context = featureAbility.getContext(); -let orientation=bundle.DisplayOrientation.UNSPECIFIED +let context: featureAbility.Context = featureAbility.getContext(); +let orientation = bundle.DisplayOrientation.UNSPECIFIED; context.setDisplayOrientation(orientation).then((data) => { console.info('setDisplayOrientation data: ' + JSON.stringify(data)); }); @@ -510,10 +540,10 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -let show=true -context.setShowOnLockScreen(show, (err) => { - console.info('setShowOnLockScreen err: ' + JSON.stringify(err)); +let context: featureAbility.Context = featureAbility.getContext(); +let show = true; +context.setShowOnLockScreen(show, (error) => { + console.error('setShowOnLockScreen fail, error: ${JSON.stringify(error)}'); }); ``` @@ -542,8 +572,8 @@ setShowOnLockScreen(show: boolean): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -let show=true +let context: featureAbility.Context = featureAbility.getContext(); +let show = true; context.setShowOnLockScreen(show).then((data) => { console.info('setShowOnLockScreen data: ' + JSON.stringify(data)); }); @@ -568,10 +598,10 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -let wakeUp=true -context.setWakeUpScreen(wakeUp, (err) => { - console.info('setWakeUpScreen err: ' + JSON.stringify(err)); +let context: featureAbility.Context = featureAbility.getContext(); +let wakeUp = true; +context.setWakeUpScreen(wakeUp, (error) => { + console.error('setWakeUpScreen fail, error: ${JSON.stringify(error)}'); }); ``` @@ -599,8 +629,8 @@ setWakeUpScreen(wakeUp: boolean): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -let wakeUp=true +let context: featureAbility.Context = featureAbility.getContext(); +let wakeUp = true; context.setWakeUpScreen(wakeUp).then((data) => { console.info('setWakeUpScreen data: ' + JSON.stringify(data)); }); @@ -627,9 +657,13 @@ getProcessInfo(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getProcessInfo((err, data) => { - console.info('getProcessInfo err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getProcessInfo((error, data) => { + if (error && error.code !== 0) { + console.error('getProcessInfo fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getProcessInfo success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -653,7 +687,7 @@ getProcessInfo(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getProcessInfo().then((data) => { console.info('getProcessInfo data: ' + JSON.stringify(data)); }); @@ -681,9 +715,13 @@ getElementName(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getElementName((err, data) => { - console.info('getElementName err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getElementName((error, data) => { + if (error && error.code !== 0) { + console.error('getElementName fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getElementName success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -709,7 +747,7 @@ getElementName(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getElementName().then((data) => { console.info('getElementName data: ' + JSON.stringify(data)); }); @@ -733,9 +771,13 @@ getProcessName(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getProcessName((err, data) => { - console.info('getProcessName err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getProcessName((error, data) => { + if (error && error.code !== 0) { + console.error('getProcessName fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getProcessName success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -759,7 +801,7 @@ getProcessName(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getProcessName().then((data) => { console.info('getProcessName data: ' + JSON.stringify(data)); }); @@ -785,9 +827,13 @@ getCallingBundle(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getCallingBundle((err, data) => { - console.info('getCallingBundle err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getCallingBundle((error, data) => { + if (error && error.code !== 0) { + console.error('getCallingBundle fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getCallingBundle success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -811,7 +857,7 @@ getCallingBundle(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getCallingBundle().then((data) => { console.info('getCallingBundle data: ' + JSON.stringify(data)); }); @@ -835,9 +881,13 @@ getCacheDir(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getCacheDir((err, data) => { - console.info('getCacheDir err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getCacheDir((error, data) => { + if (error && error.code !== 0) { + console.error('getCacheDir fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getCacheDir success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -859,7 +909,7 @@ getCacheDir(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getCacheDir().then((data) => { console.info('getCacheDir data: ' + JSON.stringify(data)); }); @@ -883,9 +933,13 @@ getFilesDir(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getFilesDir((err, data) => { - console.info('getFilesDir err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getFilesDir((error, data) => { + if (error && error.code !== 0) { + console.error('getFilesDir fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getFilesDir success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -907,7 +961,7 @@ getFilesDir(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getFilesDir().then((data) => { console.info('getFilesDir data: ' + JSON.stringify(data)); }); @@ -933,9 +987,13 @@ getOrCreateDistributedDir(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getOrCreateDistributedDir((err, data) => { - console.info('getOrCreateDistributedDir err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getOrCreateDistributedDir((error, data) => { + if (error && error.code !== 0) { + console.error('getOrCreateDistributedDir fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getOrCreateDistributedDir success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -959,7 +1017,7 @@ getOrCreateDistributedDir(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getOrCreateDistributedDir().then((data) => { console.info('getOrCreateDistributedDir data: ' + JSON.stringify(data)); }); @@ -983,9 +1041,13 @@ getAppType(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getAppType((err, data) => { - console.info('getAppType err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getAppType((error, data) => { + if (error && error.code !== 0) { + console.error('getAppType fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getAppType success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -1007,7 +1069,7 @@ getAppType(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getAppType().then((data) => { console.info('getAppType data: ' + JSON.stringify(data)); }); @@ -1031,9 +1093,13 @@ getHapModuleInfo(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getHapModuleInfo((err, data) => { - console.info('getHapModuleInfo err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getHapModuleInfo((error, data) => { + if (error && error.code !== 0) { + console.error('getHapModuleInfo fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getHapModuleInfo success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -1055,7 +1121,7 @@ getHapModuleInfo(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getHapModuleInfo().then((data) => { console.info('getHapModuleInfo data: ' + JSON.stringify(data)); }); @@ -1079,9 +1145,13 @@ getAppVersionInfo(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getAppVersionInfo((err, data) => { - console.info('getAppVersionInfo err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getAppVersionInfo((error, data) => { + if (error && error.code !== 0) { + console.error('getAppVersionInfo fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getAppVersionInfo success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -1103,7 +1173,7 @@ getAppVersionInfo(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getAppVersionInfo().then((data) => { console.info('getAppVersionInfo data: ' + JSON.stringify(data)); }); @@ -1127,9 +1197,13 @@ getAbilityInfo(callback: AsyncCallback\): void ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.getAbilityInfo((err, data) => { - console.info('getAbilityInfo err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.getAbilityInfo((error, data) => { + if (error && error.code !== 0) { + console.error('getAbilityInfo fail, error: ${JSON.stringify(error)}'); + } else { + console.log('getAbilityInfo success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -1151,7 +1225,7 @@ getAbilityInfo(): Promise\ ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.getAbilityInfo().then((data) => { console.info('getAbilityInfo data: ' + JSON.stringify(data)); }); @@ -1175,7 +1249,7 @@ getApplicationContext(): Context ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext().getApplicationContext(); +let context: featureAbility.Context = featureAbility.getContext().getApplicationContext(); ``` ## Context.isUpdatingConfigurations7+ @@ -1196,9 +1270,13 @@ isUpdatingConfigurations(callback: AsyncCallback\): void; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); -context.isUpdatingConfigurations((err, data) => { - console.info('isUpdatingConfigurations err: ' + JSON.stringify(err) + 'data: ' + JSON.stringify(data)); +let context: featureAbility.Context = featureAbility.getContext(); +context.isUpdatingConfigurations((error, data) => { + if (error && error.code !== 0) { + console.error('isUpdatingConfigurations fail, error: ${JSON.stringify(error)}'); + } else { + console.log('isUpdatingConfigurations success, data: ${JSON.stringify(data)}'); + } }); ``` @@ -1220,7 +1298,7 @@ isUpdatingConfigurations(): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.isUpdatingConfigurations().then((data) => { console.info('isUpdatingConfigurations data: ' + JSON.stringify(data)); }); @@ -1244,7 +1322,7 @@ printDrawnCompleted(callback: AsyncCallback\): void; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.printDrawnCompleted((err) => { console.error('printDrawnCompleted err: ' + JSON.stringify(err)); }); @@ -1268,7 +1346,7 @@ printDrawnCompleted(): Promise\; ```ts import featureAbility from '@ohos.ability.featureAbility'; -let context = featureAbility.getContext(); +let context: featureAbility.Context = featureAbility.getContext(); context.printDrawnCompleted().then((data) => { console.info('printDrawnCompleted data: ' + JSON.stringify(data)); }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md index 25311ca75c..4a7eb3108b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md @@ -6,6 +6,12 @@ > > 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md index 8304a13322..d6648428a9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md @@ -6,6 +6,12 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + ## 使用说明 通过AbilityDelegatorRegistry中[getAbilityDelegator](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetabilitydelegator)方法获取。 @@ -41,7 +47,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -89,7 +95,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -134,7 +140,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): v **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -184,7 +190,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\; - 示例 ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -229,7 +235,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\) **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; function onAbilityCreateCallback(data) { console.info('onAbilityCreateCallback'); @@ -273,7 +279,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let timeout = 100; function onAbilityCreateCallback(data) { @@ -325,7 +331,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -468,7 +474,7 @@ getCurrentTopAbility(): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -518,7 +524,7 @@ startAbility(want: Want, callback: AsyncCallback\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let want = { bundleName: 'bundleName', abilityName: 'abilityName' @@ -575,7 +581,7 @@ startAbility(want: Want): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let want = { bundleName: 'bundleName', abilityName: 'abilityName' @@ -615,7 +621,7 @@ doAbilityForeground(ability: UIAbility, callback: AsyncCallback\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -661,7 +667,7 @@ doAbilityForeground(ability: UIAbility): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -702,7 +708,7 @@ doAbilityBackground(ability: UIAbility, callback: AsyncCallback\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -748,7 +754,7 @@ doAbilityBackground(ability: UIAbility): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -780,7 +786,7 @@ printSync(msg: string): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -807,7 +813,7 @@ print(msg: string, callback: AsyncCallback\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -841,7 +847,7 @@ print(msg: string): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -870,7 +876,7 @@ executeShellCommand(cmd: string, callback: AsyncCallback\): void **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -900,7 +906,7 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\ **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; let timeout = 100; @@ -975,7 +981,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\): void; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -1018,7 +1024,7 @@ finishTest(msg: string, code: number): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let msg = 'msg'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -1053,7 +1059,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -1138,7 +1144,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -1184,7 +1190,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; **示例：** ```ts -let abilityDelegator; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let monitor = { moduleName: 'moduleName', @@ -1223,7 +1229,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + ## 使用说明 通过AbilityDelegatorRegistry中[getArguments](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetarguments)方法获取。 @@ -28,5 +34,5 @@ AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注 ```ts import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; -let args = AbilityDelegatorRegistry.getArguments(); +let args: AbilityDelegatorRegistry.AbilityDelegatorArgs = AbilityDelegatorRegistry.getArguments(); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md index c2e7e727fb..c37e06946e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md @@ -6,6 +6,12 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方 > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + ## 使用说明 可以作为abilityDelegator中的[addAbilityMonitor](js-apis-inner-application-abilityDelegator.md#addabilitymonitor9)的入参来监听指定Ability的生命周期变化。 @@ -43,9 +49,11 @@ let monitor = { onAbilityCreate: onAbilityCreateCallback }; -let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityMonitor(monitor, (err : any) => { - console.info('addAbilityMonitor callback'); +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityMonitor(monitor, (error : any) => { + if (error && error.code !== 0) { + console.error('addAbilityMonitor fail, error: ${JSON.stringify(error)}'); + } }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md index 20d0ea03a7..dca1531734 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md @@ -6,6 +6,12 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态的定义 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import abilitymanager from '@ohos.app.ability.abilityManager'; +``` + ## 使用说明 通过abilityManager中[getAbilityRunningInfos](js-apis-app-ability-abilityManager.md#getabilityrunninginfos)方法获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md index 1aa125e161..fbee95cc99 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md @@ -9,6 +9,12 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力， > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 使用说明 通过AbilityStage实例来获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md index e26bce07a1..8f750ec63b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md @@ -1,6 +1,7 @@ # AbilityStageMonitor -提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 +提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md index eba70773f6..846c202e4c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md @@ -2,6 +2,12 @@ 定义Ability状态信息，可以通过[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)注册生命周期变化监听后，通过[ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)的onAbilityStateChanged生命周期回调获取。 +## 导入模块 + +```ts +import appManager from '@ohos.application.appManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-appStateData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-appStateData.md index 5cc5df0eaa..b5d8db4e51 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-appStateData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-appStateData.md @@ -2,6 +2,12 @@ 定义应用状态信息，可以通过[getForegroundApplications](js-apis-app-ability-appManager.md#appmanagergetforegroundapplications)获取当前应用的相关信息。 +## 导入模块 + +```ts +import appManager from '@ohos.app.ability.appManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统API**：该接口为系统接口，三方应用不支持调用。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md index cf5d3997b4..7bc37cd463 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md @@ -7,12 +7,18 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力， > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 使用说明 在使用ApplicationContext的功能前，需要通过context的实例获取。 ```ts -let applicationContext = this.context.getApplicationContext(); +let applicationContext: common.ApplicationContext = this.context.getApplicationContext(); ``` ## ApplicationContext.on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md index 1f4cc1e36b..3468d620a6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md @@ -2,6 +2,12 @@ 定义应用状态监听，可以作为[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)的入参监听当前应用的生命周期变化。 +## 导入模块 + +```ts +import appManager from '@ohos.application.appManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统API**：该接口为系统接口，三方应用不支持调用。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md index d4d3f14f60..3ca4fa3135 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md @@ -6,6 +6,12 @@ BaseContext抽象类用于表示继承的子类Context是Stage模型还是FA模 > > 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md index 3fdc30965d..851287ab99 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md @@ -7,6 +7,12 @@ Context模块提供了ability或application的上下文的能力，包括访问 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -49,7 +55,12 @@ createBundleContext(bundleName: string): Context; **示例：** ```ts -let bundleContext = this.context.createBundleContext('com.example.test'); +let bundleContext: common.Context; +try { + bundleContext = this.context.createBundleContext('com.example.test'); +} catch (error) { + console.error('createBundleContext failed, error.code: ${error.code}, error.message: ${error.message}'); +} ``` ## Context.createModuleContext @@ -75,7 +86,16 @@ createModuleContext(moduleName: string): Context; **示例：** ```ts +<<<<<<< HEAD let moduleContext = this.context.createModuleContext('entry'); +======= +let moduleContext: common.Context; +try { + moduleContext = this.context.createModuleContext('entry'); +} catch (error) { + console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}'); +} +>>>>>>> 48a75c8e72 (Modify the secondary import module of ability) ``` ## Context.createModuleContext @@ -102,7 +122,16 @@ createModuleContext(bundleName: string, moduleName: string): Context; **示例：** ```ts +<<<<<<< HEAD let moduleContext = this.context.createModuleContext('com.example.test', 'entry'); +======= +let moduleContext: common.Context; +try { + moduleContext = this.context.createModuleContext('com.example.test', 'entry'); +} catch (error) { + console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}'); +} +>>>>>>> 48a75c8e72 (Modify the secondary import module of ability) ``` ## Context.getApplicationContext @@ -122,7 +151,16 @@ getApplicationContext(): ApplicationContext; **示例：** ```ts +<<<<<<< HEAD let applicationContext = this.context.getApplicationContext(); +======= +let applicationContext: common.Context; +try { + applicationContext = this.context.getApplicationContext(); +} catch (error) { + console.error('getApplicationContext failed, error.code: ${error.code}, error.message: ${error.message}'); +} +>>>>>>> 48a75c8e72 (Modify the secondary import module of ability) ``` ## AreaMode diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md index 2076c9b6a4..e6caa78afe 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md @@ -2,7 +2,13 @@ 定义异常监听，可以作为[errorManager.on](js-apis-app-ability-errorManager.md#errormanageron)的入参监听当前应用发生的异常。 -## onUnhandledException +## 导入模块 + +```ts +import errorManager from '@ohos.app.ability.errorManager'; +``` + +## ErrorObserver.onUnhandledException onUnhandledException(errMsg: string): void; diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md index 80aaeb9298..d15a9318d9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md @@ -7,6 +7,12 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 使用说明 在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md index 250a9c67a2..b5bea38b84 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md @@ -9,6 +9,12 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 属性 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md index 6e978ef3e7..6c03ad93ed 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md @@ -7,6 +7,12 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口均为系统接口，三方应用不支持调用 +## 导入模块 + +```ts +import abilityManager from '@ohos.app.ability.abilityManager'; +``` + ## 使用说明 通过abilityManager中方法获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md index 8e5b4f4022..712f2656df 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md @@ -9,6 +9,12 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 使用说明 在使用FormExtensionContext的功能前，需要通过FormExtension获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md index a35b763703..089302a56f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md @@ -2,6 +2,12 @@ 表示Ability对应的任务信息，可以通过[getMissionInfo](js-apis-app-ability-missionManager.md#missionmanagergetmissioninfo)获取。 +## 导入模块 + +```ts +import missionManager from '@ohos.app.ability.missionManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission **系统API**: 此接口为系统接口，三方应用不支持调用。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md index a3b6c150d2..fc7e9d754e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md @@ -2,6 +2,12 @@ 定义系统任务状态监听，可以通过[registerMissionListener](js-apis-application-missionManager.md#missionmanagerregistermissionlistener)注册。 +## 导入模块 + +```ts +import missionManager from '@ohos.app.ability.missionManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission | 名称 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md index f8fc4f2d46..0e2d83fedf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md @@ -7,6 +7,12 @@ > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口均为系统接口，三方应用不支持调用 +## 导入模块 + +```ts +import missionManager from '@ohos.app.ability.missionManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md index f638be6bd2..cc7947bd6f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md @@ -2,6 +2,12 @@ 定义进程数据，可以通过[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)注册生命周期变化监听后，通过[ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)的onProcessCreated生命周期回调获取。 +## 导入模块 + +```ts +import appManager from '@ohos.app.ability.appManager'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统API**：该接口为系统接口，三方应用不支持调用。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processInformation.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processInformation.md index 5996c50b66..8072fdabfd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processInformation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processInformation.md @@ -6,6 +6,12 @@ ProcessInformation模块提供对进程运行信息进行查询的能力。 > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import appManager from '@ohos.app.ability.appManager'; +``` + ## 使用说明 通过appManager的[getRunningProcessInformation](js-apis-app-ability-appManager.md#appmanagergetrunningprocessinformation9)来获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md index 3a5ee1fad4..e9bc1d3aa8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md @@ -6,6 +6,12 @@ > - 本模块接口从API version 9 开始废弃，建议使用[ProcessInformation9+](js-apis-inner-application-processInformation.md)替代。 > - 本模块首批接口从API version 8 开始支持。 +## 导入模块 + +```ts +import appManager from '@ohos.app.ability.appManager'; +``` + ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md index 5c58e71ebb..ef27a35ae5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md @@ -9,6 +9,12 @@ ServiceExtensionContext模块提供ServiceExtensionAbility具有的能力和接 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 使用说明 在使用ServiceExtensionContext的功能前，需要通过ServiceExtensionAbility子类实例获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md index bd438eae69..bb23f70215 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md @@ -6,6 +6,12 @@ > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | @@ -19,8 +25,8 @@ **示例：** ```ts -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; -let abilityDelegator; +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; +let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator; let cmd = 'cmd'; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md index eff02851ae..15f0510cc5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md @@ -9,6 +9,12 @@ UIAbilityContext模块提供允许访问特定UIAbility的资源的能力，包 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +```ts +import common from '@ohos.app.ability.common'; +``` + ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md index 7d51a7aa49..8a32144ecf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md @@ -2,6 +2,12 @@ 作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的信息。 +## 导入模块 + +```ts +import wantAgent from '@ohos.app.ability.wantAgent'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md index ecfcd0cab0..df7c43d3cc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md @@ -2,6 +2,12 @@ 定义触发WantAgent所需要的信息，可以作为[getWantAgent](js-apis-app-ability-wantAgent.md#wantagentgetwantagent)的入参创建指定的WantAgent对象。 +## 导入模块 + +```ts +import wantAgent from '@ohos.app.ability.wantAgent'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 必填 | 说明 | -- GitLab