diff --git a/OAT.xml b/OAT.xml index 59b222c66c936f6d1284c6d1cded6f8cc95f1e25..23f7ee1c6a4bbd0a0fc4e65dd810fc904ced5005 100644 --- a/OAT.xml +++ b/OAT.xml @@ -38,13 +38,13 @@ - + - + diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md index 9e41b825a57e3e3fcb26954fab0ffbec80e24a07..a777c221d83cef40636b022bd075b000a661ffe9 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -22,6 +22,7 @@ SystemCapability.BundleManager.BundleFramework | ohos.permission.GET_BUNDLE_INFO | normal | 查询指定应用信息 | | ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 | | ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 | +| ohos.permission.MANAGE_DISPOSED_APP_STATUS | system_core | 可设置和查询应用的处置状态 | 权限等级参考[权限等级说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E) @@ -1692,6 +1693,133 @@ bundle.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataNa }) ``` +## bundle.setDisposedStatus9+ + +setDisposedStatus(bundleName: string, status: number, callback: AsyncCallback\): void; + +以异步方法根据给定的bundleName和status来设置对应应用的处置状态，使用callback形式返回结果。 + +**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力：** SystemCapability.BundleManager.BundleFramework + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------------- | ---------------------------------- | ---- | ---------------------------------------- | +| bundleName | string | 是 | 表示要被设置处置状态的应用包名。 | +| status | number | 是 | 表示要设置的处置状态值。该值预留用于应用市场设置应用的处置状态，默认为0，不做处置。 | +| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，无返回值。 | + +**示例：** + +```js +let bundleName = 'com.ohos.camera'; +let status = 1; +const caller = function callback(err, data) { + console.error('Operation err is: ' + err); + console.error('Operation result is: ' + data); +} +bundle.setDisposedStatus(bundleName, status, caller) +``` + +## bundle.setDisposedStatus9+ + +setDisposedStatus(bundleName: string, status: number): Promise\; + +以异步方法根据给定的bundleName和status来设置对应应用的处置状态，使用Promise形式返回结果。 + +**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力：** SystemCapability.BundleManager.BundleFramework + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------------- | ---------------------------------- | ---- | ---------------------------------------- | +| bundleName | string | 是 | 表示要被设置处置状态的应用包名。 | +| status | number | 是 | 表示要设置的处置状态值。该值预留用于应用市场设置应用的处置状态，默认为0，不做处置。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------- | ------------------------------ | +| Promise\ | Promise形式，无返回值。 | + +**示例：** + +```js +let bundleName = 'com.ohos.camera'; +let status = 1; + +bundle.setDisposedStatus(bundleName, status).then(data=>{ + console.error('Operation result is: ' + data); +}).catch(err=>{ + console.error('Operation err is: ' + err); +}) +``` + +## bundle.getDisposedStatus9+ + +getDisposedStatus(bundleName: string,, callback: AsyncCallback\): void; + +以异步方法根据给定的bundleName来获取对应应用的处置状态，使用callback形式返回结果。 +**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力：** SystemCapability.BundleManager.BundleFramework + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------------- | ---------------------------------- | ---- | ---------------------------------------- | +| bundleName | string | 是 | 表示要获取处置状态的应用包名。 | +| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回应用的处置状态值。 | + +**示例：** + +```js +let bundleName = 'com.ohos.camera'; +const caller = function callback(err, data) { + console.error('Operation err is: ' + err); + console.error('Operation result is: ' + data); +} +bundle.getDisposedStatus(bundleName, caller) +``` + +## bundle.getDisposedStatus9+ + +getDisposedStatus(bundleName: string, status: number): Promise\; + +以异步方法根据给定的bundleName来获取对应应用的处置状态，使用Promise形式返回结果。 + +**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力：** SystemCapability.BundleManager.BundleFramework + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------------- | ---------------------------------- | ---- | ---------------------------------------- | +| bundleName | string | 是 | 表示要获取处置状态的应用包名。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------- | ------------------------------ | +| Promise\ | Promise返回应用的处置状态。 | + +**示例：** + +```js +let bundleName = 'com.ohos.camera'; + +bundle.getDisposedStatus(bundleName).then(data=>{ + console.error('Operation result is: ' + data); +}).catch(err=>{ + console.error('Operation err is: ' + err); +}) +``` + ## InstallErrorCode **系统能力:** SystemCapability.BundleManager.BundleFramework diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 43817fb330aef78abdc1cd95e05487c393121daf..b2bc9f02d7d4e08663d0f20daf45fabbca0ea3c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -1,18 +1,12 @@ # Context模块 -Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等并且只能通过ability获得。 +Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。 > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在FA模型下使用。 -## 导入模块 - -```js -import featureAbility from '@ohos.ability.featureAbility' -``` - ## 使用说明 Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下： diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index 044d596f09a0a1fe602670020e1e19d818f6b2f3..469b56a35c9d3931ea9db0638957e8e60f8e8750 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -9,11 +9,6 @@ AbilityContext模块提供允许访问特定于ability的资源的能力，包 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 - -```js -import Ability from '@ohos.application.Ability' -``` ## 使用说明 在使用AbilityContext的功能前，需要通过Ability子类实例获取。 @@ -27,7 +22,6 @@ class MainAbility extends Ability { } ``` - ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -36,7 +30,7 @@ class MainAbility extends Ability { | -------- | -------- | -------- | -------- | -------- | | abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | - +| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 表示配置信息。 | ## AbilityContext.startAbility @@ -46,6 +40,8 @@ startAbility(want: Want, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**: 此接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -75,6 +71,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**: 此接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -108,6 +106,8 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**: 此接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -237,6 +237,128 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityRes }) ``` +## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数，返回Ability结果。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + this.context.startAbilityWithAccount(want, accountId, (err, data) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + console.log('---------- startAbilityWithAccount success, data: -----------', data); + }); + ``` + + +## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\): void; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityForResultWithAccount(want, accountId, options, (err) => { + console.log('---------- startAbilityForResultWithAccount fail, err: -----------', err); + }); + ``` + + + ## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<AbilityResult> | 返回一个Promise，包含Ability结果。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityForResultWithAccount(want, accountId, options) + .then((data) => { + console.log('---------- startAbilityForResultWithAccount success, data: -----------', data); + }) + .catch((err) => { + console.log('---------- startAbilityForResultWithAccount fail, err: -----------', err); + }) + ``` + ## AbilityContext.terminateSelf @@ -348,6 +470,149 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>; ) ``` +## AbilityContext.connectAbility + +connectAbility(want: Want, options: ConnectOptions): number; + +使用AbilityInfo.AbilityType.SERVICE模板将当前能力连接到一个能力。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 否 | 远端对象实例。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回Ability连接的结果code。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var options = { + onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.log('----------- onFailed -----------') } + } + const result = this.context.connectAbility(want, options); + console.log('----------- connectAbilityResult: ------------', result); + ``` + + +## AbilityContext.connectAbilityWithAccount + +connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; + +使用AbilityInfo.AbilityType.SERVICE模板和account将当前能力连接到一个能力。 + +**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 否 | 远端对象实例。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回Ability连接的结果code。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.log('----------- onFailed -----------') } + } + const result = this.context.connectAbilityWithAccount(want, accountId, options); + console.log('----------- connectAbilityResult: ------------', result); + ``` + +## AbilityContext.disconnectAbility + +disconnectAbility(connection: number): Promise\; + +已成功连接接口。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| connection | number | 是 | 连接的能力的数字代码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```js + var connectionNumber = 0; + this.context.disconnectAbility(connectionNumber).then((data) => { + console.log('disconnectAbility success, data: ', data); + }).catch((err) => { + console.log('disconnectAbility fail, err: ', err); + }); + ``` + +## AbilityContext.disconnectAbility + +disconnectAbility(connection: number, callback:AsyncCallback\): void; + +已成功连接接口。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| connection | number | 是 | 连接的能力的数字代码。 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**示例：** + + ```js + var connectionNumber = 0; + this.context.disconnectAbility(connectionNumber, (err) => { + console.log('---------- disconnectAbility fail, err: -----------', err); + }); + ``` ## AbilityContext.startAbilityByCall @@ -390,6 +655,120 @@ startAbilityByCall(want: Want): Promise<Caller>; } ``` +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + this.context.startAbilityWithAccount(want, accountId, (err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }); + ``` + + +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityWithAccount(want, accountId, options, (err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }); + ``` + + +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\; + +根据account启动Ability（Promise形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityWithAccount(want, accountId, options) + .then((data) => { + console.log('---------- startAbilityWithAccount success, data: -----------', data); + }) + .catch((err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }) + ``` ## AbilityContext.requestPermissionsFromUser @@ -503,6 +882,117 @@ setMissionLabel(label: string): Promise<void> console.log('failed:' + JSON.stringify(error)); }); ``` +## AbilityContext.setMissionIcon + +setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\): void; + +设置当前ability的任务标签。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| icon | image.PixelMap | 是 | 在最近的任务中显示的能力图标。 | +| callback | AsyncCallback\ | 是 | 指定的回调函数的结果。 | + +**示例：** + + ```js + import image from '@ohos.multimedia.image' + var imagePixelMap; + var color = new ArrayBuffer(0); + var initializationOptions = { + size: { + height: 100, + width: 100 + } + }; + image.createPixelMap(color, initializationOptions) + .then((data) => { + imagePixelMap = data; + }) + .catch((err) => { + console.log('--------- createPixelMap fail, err: ---------', err) + }); + this.context.setMissionIcon(imagePixelMap, (err) => { + console.log('---------- setMissionIcon fail, err: -----------', err); + }) + ``` + + +## AbilityContext.setMissionIcon + +setMissionIcon(icon: image.PixelMap): Promise\; + +设置当前ability的任务标签。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| icon | image.PixelMap | 是 | 在最近的任务中显示的能力图标。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```js + import image from '@ohos.multimedia.image' + var imagePixelMap; + var color = new ArrayBuffer(0); + var initializationOptions = { + size: { + height: 100, + width: 100 + } + }; + image.createPixelMap(color, initializationOptions) + .then((data) => { + imagePixelMap = data; + }) + .catch((err) => { + console.log('--------- createPixelMap fail, err: ---------', err) + }); + this.context.setMissionIcon(imagePixelMap) + .then((data) => { + console.log('-------------- setMissionIcon success, data: -------------', data); + }) + .catch((err) => { + console.log('-------------- setMissionIcon fail, err: -------------', err); + }); + ``` +## AbilityContext.restoreWindowStage + +restoreWindowStage(localStorage: LocalStorage) : void; + +恢复ability中的window stage数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 | + +**示例：** + + ```js + var storage = new LocalStorage(); + this.context.restoreWindowStage(storage); + ``` ## AbilityContext.isTerminating diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index 7d398275e4ac9d3b41f1bf7fc7eb78b82573eba6..698af4590f2a22283de0edd494860f25186f5313 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -14,61 +14,63 @@ import wantConstant from '@ohos.ability.wantConstant' ## wantConstant.Action -**系统能力**：SystemCapability.Ability.AbilityBase +want操作的常数。 -权限列表。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 | +| 名称 | 值 | 描述 | | ------------ | ------------------ | ---------------------- | -| ACTION_HOME | ohos.want.action.home | 无 | -| ACTION_DIAL | ohos.want.action.dial | 无 | -| ACTION_SEARCH | ohos.want.action.search | 无 | -| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 无 | -| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 无 | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 无 | -| ACTION_SET_ALARM | ohos.want.action.setAlarm | 无 | -| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 无 | -| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 无 | -| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 无 | -| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 无 | -| ACTION_SEND_SMS | ohos.want.action.sendSms | 无 | -| ACTION_CHOOSE | ohos.want.action.choose | 无 | -| ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | 无 | -| ACTION_VIDEO_CAPTUR8+ | ohos.want.action.videoCapture | 无 | -| ACTION_SELECT | ohos.want.action.select | 无 | -| ACTION_SEND_DATA | ohos.want.action.sendData | 无 | -| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 无 | -| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 无 | -| ACTION_VIEW_DATA | ohos.want.action.viewData | 无 | -| ACTION_EDIT_DATA | ohos.want.action.editData | 无 | -| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 无 | -| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 无 | -| ACTION_FILE_SELECT7+ | ohos.action.fileSelect | 无 | -| PARAMS_STREAM7+ | ability.params.stream | 无 | -| ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | 无 | +| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 | +| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 | +| ACTION_SEARCH | ohos.want.action.search | 指示启动页面搜索功能的操作。 | +| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。 | +| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 指示启动管理已安装应用程序的页面功能的操作。 | +| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 指示启动显示指定应用程序详细信息的页面功能的操作。 | +| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操做作。 | +| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 指示启动显示所有警报的页面功能的操作时钟。 | +| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 指示启动用于使闹钟睡眠的页面功能的操作。 | +| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 指示启动删除闹钟的页面功能的操作。 | +| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 指示启动页面功能以关闭计时器的操作。 | +| ACTION_SEND_SMS | ohos.want.action.sendSms | 指示启动发送sms的页面功能的操作。 | +| ACTION_CHOOSE | ohos.want.action.choose | 指示启动页面功能以打开联系人或图片的操作。 | +| ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 | +| ACTION_VIDEO_CAPTUR8+ | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 | +| ACTION_SELECT | ohos.want.action.select | 指示显示应用程序选择对话框的操作。 | +| ACTION_SEND_DATA | ohos.want.action.sendData | 指示发送单个数据记录的操作。 | +| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 指示发送多个数据记录的操作。 | +| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 指示请求媒体扫描仪扫描文件并将文件添加到媒体库的操作。 | +| ACTION_VIEW_DATA | ohos.want.action.viewData | 指示查看数据的操作。 | +| ACTION_EDIT_DATA | ohos.want.action.editData | 指示编辑数据的操作。 | +| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 指示将使用连接选取显示的选项的操作。 | +| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 指示与连接选取显示的选项一起使用时的字符序列对话框标题。 | +| ACTION_FILE_SELECT7+ | ohos.action.fileSelect | 指示选择文件的操作。 | +| PARAMS_STREAM7+ | ability.params.stream | 指示与连接发送数据一起使用时，包含与意图相关联的数据流的URI。 | +| ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 | +| ACTION_MARKER_DOWNLOAD | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的行为。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | ## wantConstant.Entity -**系统能力**：SystemCapability.Ability.AbilityBase +want实体的常数。 -权限列表。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 | +| 名称 | 值 | 描述 | | ------------ | ------------------ | ---------------------- | -| ENTITY_DEFAULT | entity.system.default | 无 | -| ENTITY_HOME | entity.system.homel | 无 | -| ENTITY_VOICE | ENTITY_VOICE | 无 | -| ENTITY_BROWSABLE | entity.system.browsable | 无 | -| ENTITY_VIDEO | entity.system.video | 无 | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 无 | +| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 | +| ENTITY_HOME | entity.system.homel | 指示主屏幕实体。 | +| ENTITY_VOICE | entity.system.voice | 表示语音交互实体。 | +| ENTITY_BROWSABLE | entity.system.browsable | 指示浏览器类别。 | +| ENTITY_VIDEO | entity.system.video | 指示视频类别。 | + +## wantConstant.Flags -## flags说明 +Flags说明。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 名称 | 参数 | 描述 | +| 名称 | 值 | 描述 | | ------------------------------------ | ---------- | ------------------------------------------------------------ | | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 | | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 | @@ -76,10 +78,10 @@ import wantConstant from '@ohos.ability.wantConstant' | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 | | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 | | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。 | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 | | FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md index 99ab605979e57a0e95ed1b1f00b5e9040ee5a9c6..1f252068811dfc1a90dfc1b0a64d72e363fd057a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md @@ -26,8 +26,6 @@ Ability生命周期状态。 | BACKGROUND | 3 | 表示Ability处于后台状态。 | | DESTROY | 4 | 表示Ability处于已销毁状态。 | - - ## AbilityDelegatorRegistry.getAbilityDelegator getAbilityDelegator(): AbilityDelegator diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md index b34141cb8f47bed2a49ecf8ce3c372407ab4fff1..cefd91183d63b3cceb4b0d88bfca8693ca64947d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md @@ -29,7 +29,6 @@ Ability的状态信息。 | FOREGROUNDING | 11 | 表示ability为foregrounding状态。 | | BACKGROUNDING | 12 | 表示ability为backgrounding状态。 | - ## updateConfiguration updateConfiguration(config: Configuration, callback: AsyncCallback\): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md index d3e9d1618b990e56f30178fc3721f861982a9869..33b9ff847ac76c6f00d67e2734547894aa287344 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md @@ -6,12 +6,6 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态进行设 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 - -```js -import abilitymanager from '@ohos.application.abilityManager'; -``` - ## 使用说明 通过abilityManager中getAbilityRunningInfos方法获取。 @@ -36,21 +30,4 @@ abilitymanager.getAbilityRunningInfos((err,data) => { | uid | number | 是 | 否 | 用户ID。 | | processName | string | 是 | 否 | 进程名称。 | | startTime | number | 是 | 否 | Ability启动时间。 | -| abilityState | [abilityManager.AbilityState](#abilitymanagerabilitystate) | 是 | 否 | Ability状态。 | - - -## abilityManager.AbilityState - -Ability的状态信息。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| INITIAL | 0 | 表示ability为initial状态。| -| FOREGROUND | 9 | 表示ability为foreground状态。 | -| BACKGROUND | 10 | 表示ability为background状态。 | -| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 | -| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 | +| abilityState | [abilityManager.AbilityState](js-apis-abilityManager.md#abilityState) | 是 | 否 | Ability状态。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md index 17a9f3117084a44bc32b9845ef50f6206c62d98f..58c966eb524c7afc9ad190c0c66d00d10b18e979 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md @@ -9,12 +9,6 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力， > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 - -```js -import AbilityStage from '@ohos.application.AbilityStage'; -``` - ## 使用说明 通过AbilityStage实例来获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md index 60eb7d35a855c2e2643fd39a545d32a4e67a3c0f..921399592847aa98a25c669ceaa8c00043bc7726 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md @@ -1,29 +1,40 @@ # MissionSnapshot -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -任务对应的任务快照。 - -## 导入模块 +MissionSnapshot模块提供设置与任务对应的任务快照的任务元素名称的能力。 -``` -import missionManager from '@ohos.application.missionManager' -``` +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口均为系统接口，三方应用不支持调用 ## 使用说明 -使用前需要提前引入对应模块。 +通过missionManager中的getMissionSnapShot来获取。 -``` +```js import ElementName from '@ohos.bundle'; import image from '@ohos.multimedia.image'; +import missionManager from '@ohos.application.missionManager' + + missionManager.getMissionInfos("", 10, (error, missions) => { + console.log("getMissionInfos is called, error.code = " + error.code); + console.log("size = " + missions.length); + console.log("missions = " + JSON.stringify(missions)); + var id = missions[0].missionId; + + missionManager.getMissionSnapShot("", id, (error, snapshot) => { + console.log("getMissionSnapShot is called, error.code = " + error.code); + console.log("bundleName = " + snapshot.ability.bundleName); + }) + }) ``` ## MissionSnapshot 表示任务对应的任务快照的枚举。 - | 名称 | 参数类型 | 可读 | 可写 | 说明 | +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 | | snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index 8acd7c78ebeccc01c78e9ec68064e3cb07088012..490875a5bbf1666db2b07847fdb7c73aff0803e0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -29,8 +29,6 @@ import Ability from '@ohos.application.Ability'; | lastRequestWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability最后请求时的参数。| | callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| - - ## Ability.onCreate onCreate(want: Want, param: AbilityConstant.LaunchParam): void; diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md index 359882ab4b4ae039f377dd2290f918fa809c4866..7cfd7e629fcc4a11848ecae9d1cf444cf8730d48 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -6,10 +6,16 @@ AbilityDelegator提供添加用于监视指定能力的生命周期状态更改 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 +## 使用说明 +通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。 ```js import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' + +var abilityDelegator; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); + ``` ## AbilityDelegator diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md index 27983fe5f46c6ec66121cc432c63df7a909aefaa..3c585bdd09536059377027115a5c85e561674196 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md @@ -6,10 +6,14 @@ AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 +## 使用说明 + +通过AbilityDelegatorRegistry中getArguments方法获取。 ```js import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' + +var args = AbilityDelegatorRegistry.getArguments(); ``` ## AbilityDelegatorArgs diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md index 4e811b1b27213c17fbbf857e0b03939248f85dab..433a6791f0eef5fd2d7ad3c6859b132802e5c524 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md @@ -6,10 +6,27 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方 > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 +## 使用说明 + +通过abilityDelegator中的addAbilityMonitor来设置。 ```js import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +var abilityDelegator; + +function onAbilityCreateCallback(data) { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityMonitor(monitor, (err : any) => { + console.info("addAbilityMonitor callback"); +}); ``` ## AbilityMonitor diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md index 5793ca319a11b3535c9033e235da4dbf4ab39e33..0c99a3285c4df433024d51a5b026828ce31a6689 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md @@ -7,12 +7,6 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力， > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 - -``` -import Ability from '@ohos.application.Ability'; -``` - ## 使用说明 在使用ApplicationContext的功能前，需要通过context的实例获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md index 7e5da9c6e1855ceaeb572708e623c936488a96b6..30c6f587627d5e6dfc25f6460487e6fa73ae7cce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-context.md @@ -9,15 +9,20 @@ Context模块提供开发者运行代码的上下文环境的能力，包括查 提供开发者运行代码的上下文环境，包括应用信息、ResourceManager等信息。 -## 导入模块 -``` -import AbilityContext from '@ohos.application.Ability'; -``` - ## 使用说明 通过AbilityContext等继承实现。 + ```js +import AbilityContext from '@ohos.application.Ability' + class MainAbility extends AbilityContext { + onWindowStageCreate(windowStage) { + let test = "com.example.test"; + let context = this.context.createBundleContext(test); + } + } +``` + ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -30,12 +35,11 @@ import AbilityContext from '@ohos.application.Ability'; | tempDir | string | 是 | 否 | 应用的临时文件路径。 | | filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 | | databaseDir | string | 是 | 否 | 获取本地数据存储路径。 | -| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。 | | bundleCodeDir | string | 是 | 否 | 应用安装路径。 | | distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 | | eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。| | area | [AreaMode](#areamode) | 是 | 是 | 文件分区。| - +| preferencesDir | string | 是 | 是 | 指示应用程序首选项目录。| ## Context.createBundleContext diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md deleted file mode 100644 index e3c09553f8fb08bbc14c4f15448470311cbf6428..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -# MissionInfo - -MissionInfo模块提供对与Ability相对应的任务信息进行设置和查询的能力。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```js -import MissionInfo from '@ohos.application.missionInfo' -``` - -## MissionInfo - -表示Ability对应任务信息的枚举。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| missionId | number | 是 | 是 | 表示任务ID。| -| runningState | number | 是 | 是 | 表示运行状态。 | -| lockedState | boolean | 是 | 是 | 表示锁定状态。 | -| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 | -| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 | -| label | string | 是 | 是 | 表示任务的标签。 | -| iconPath | string | 是 | 是 | 表示任务的图标路径。 | -| continuable | boolean | 是 | 是 | 表示任务是否可以继续。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md index 18be172e57a68bca06c4d363b22704f4eb32fd39..ae8f7c42862086343031cddbc6fb0a81ccee88d7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md @@ -6,16 +6,28 @@ ShellCmdResult模块提供Shell命令执行结果的能力。 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 +## 使用说明 + +通过abilityDelegator中的executeShellCommand方法来获取。 ```js import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +var abilityDelegator; +var cmd = "cmd"; +var timeout = 100; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { + console.info("executeShellCommand promise"); +}); ``` ## ShellCmdResult Shell命令执行结果 +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | ------ | ---- | ---- | ------------------------------------------------------------ | | stdResult | string | 是 | 是 | 标准输出内容
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index c0ca7eb3c9beedf11d021d23ccfa24a972e20d1a..c5dc74cc9c70950a3591d980ab77455cc384436f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -6,8 +6,6 @@ appManager模块提供服务功能的能力，包括查询当前是否处于稳 > > 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -App管理。 - ## 导入模块 ```js @@ -208,6 +206,388 @@ getProcessRunningInfos(callback: AsyncCallback\>): vo }) ``` +## appManager.registerApplicationStateObserver8+ + +registerApplicationStateObserver(observer: ApplicationStateObserver): number; + +注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observer | ApplicationStateObserver | 否 | 返回观察者的数字代码。 | + +**示例：** + + ```js + var applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('------------ onForegroundApplicationChanged -----------', appStateData); + }, + onAbilityStateChanged(abilityStateData) { + console.log('------------ onAbilityStateChanged -----------', abilityStateData); + }, + onProcessCreated(processData) { + console.log('------------ onProcessCreated -----------', processData); + }, + onProcessDied(processData) { + console.log('------------ onProcessDied -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); + + ``` +## appManager.unregisterApplicationStateObserver8+ + +unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\): void; + +取消注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observerId | number | 否 | 表示观察者的编号代码。 | +| callback | AsyncCallback\ | 否 | 表示指定的回调方法。 | + +**示例：** + + ```js + var observerId = 100; + + function unregisterApplicationStateObserverCallback(err) { + if (err) { + console.log('------------ unregisterApplicationStateObserverCallback ------------', err); + } + } + app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback); + ``` + +## appManager.unregisterApplicationStateObserver8+ + +unregisterApplicationStateObserver(observerId: number): Promise\; + +取消注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observerId | number | 否 | 表示观察者的编号代码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```js + var observerId = 100; + + app.unregisterApplicationStateObserver(observerId) + .then((data) => { + console.log('----------- unregisterApplicationStateObserver success ----------', data); + }) + .catch((err) => { + console.log('----------- unregisterApplicationStateObserver fail ----------', err); + }) + ``` + +## appManager.getForegroundApplications8+ + +getForegroundApplications(callback: AsyncCallback\>): void; + +获取前台进程的应用程序。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 否 | 表示应用的状态数据。 | + +**示例：** + + ```js + function getForegroundApplicationsCallback(err, data) { + if (err) { + console.log('--------- getForegroundApplicationsCallback fail ---------', err); + } else { + console.log('--------- getForegroundApplicationsCallback success ---------', data) + } + } + app.getForegroundApplications(getForegroundApplicationsCallback); + ``` + +## appManager.getForegroundApplications8+ + +getProcessRunningInfos(): Promise\>; + +获取前台进程的应用程序。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 返回进程运行信息的数组。 | + +**示例：** + + ```js + app.getForegroundApplications() + .then((data) => { + console.log('--------- getForegroundApplications success -------', data); + }) + .catch((err) => { + console.log('--------- getForegroundApplications fail -------', err); + }) + ``` + +## appManager.killProcessWithAccount8+ + +killProcessWithAccount(bundleName: string, accountId: number): Promise\ + +切断account进程（Promise形式）。 + +**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 应用包名。 | + | accountId | number | 是 | account的Id。 | + +**示例：** + +```js +var bundleName = 'bundleName'; +var accountId = 0; +app.killProcessWithAccount(bundleName, accountId) + .then((data) => { + console.log('------------ killProcessWithAccount success ------------', data); + }) + .catch((err) => { + console.log('------------ killProcessWithAccount fail ------------', err); + }) +``` + + +## appManager.killProcessWithAccount8+ + +killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\): void + +切断account进程（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 应用包名。 | + | accountId | number | 是 | account的Id。 | + | callback | AsyncCallback\ | 是 | 切断account进程的回调函数。 | + +**示例：** + +```js +var bundleName = 'bundleName'; +var accountId = 0; +function killProcessWithAccountCallback(err, data) { + if (err) { + console.log('------------- killProcessWithAccountCallback fail, err: --------------', err); + } else { + console.log('------------- killProcessWithAccountCallback success, data: --------------', data); + } +} +app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); +``` + +## appManager.killProcessesByBundleName8+ + +killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); + +通过包名终止进程。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 否 | 表示包名。 | +| callback | AsyncCallback\ | 否 | 表示指定的回调方法。 | + +**示例：** + + ```js + var bundleName = 'bundleName'; + function killProcessesByBundleNameCallback(err, data) { + if (err) { + console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); + } else { + console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); + } + } + app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); + ``` + +## appManager.killProcessesByBundleName8+ + +killProcessesByBundleName(bundleName: string): Promise\; + +通过包名终止进程。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 否 | 表示包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```js +var bundleName = 'bundleName'; +app.killProcessesByBundleName(bundleName) + .then((data) => { + console.log('------------ killProcessesByBundleName success ------------', data); + }) + .catch((err) => { + console.log('------------ killProcessesByBundleName fail ------------', err); + }) + + ``` + +## appManager.clearUpApplicationData8+ + +clearUpApplicationData(bundleName: string, callback: AsyncCallback); + +通过包名清除应用数据。 + +**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 否 | 表示包名。 | +| callback | AsyncCallback\ | 否 | 表示指定的回调方法。 | + +**示例：** + + ```js + var bundleName = 'bundleName'; + function clearUpApplicationDataCallback(err, data) { + if (err) { + console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); + } else { + console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); + } + } + app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); + + ``` + +## appManager.clearUpApplicationData8+ + +clearUpApplicationData(bundleName: string): Promise; + +通过包名清除应用数据。 + +**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 否 | 表示包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```js + var bundleName = 'bundleName'; + app.clearUpApplicationData(bundleName) + .then((data) => { + console.log('------------ clearUpApplicationData success ------------', data); + }) + .catch((err) => { + console.log('------------ clearUpApplicationData fail ------------', err); + }) + + ``` + ## ProcessRunningInfo **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md index aaa6ddbd2e4d7faae3c4442da6fd0bad19b735b7..4923e4f50d8d1d831cb17d2e02b0fa68c81e11fb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md @@ -17,26 +17,28 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | -| name | string | 是 | 否 | 应用程序的名称 | -| description | string | 是 | 否 | 应用程序的描述 | -| descriptionId | number | 是 | 否 | 应用程序的描述id | -| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序，默认为false | -| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true | -| label | string | 是 | 否 | 应用程序的标签 | -| labelId | string | 是 | 否 | 应用程序的标签id | -| icon | string | 是 | 否 | 应用程序的图标 | -| iconId | string | 是 | 否 | 应用程序的图标id | -| process | string | 是 | 否 | 应用程序的进程，如果不设置，默认为包的名称 | -| supportedModes | number | 是 | 否 | 应用程序支持的运行模式 | -| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径 | -| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限 | -| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息 | -| entryDir | string | 是 | 否 | 应用程序的文件保存路径 | -| codePath8+ | string | 是 | 否 | 应用程序的安装目录 | -| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息 | -| metadata9+ | Map\> | 是 | 否 | 应用程序的元信息 | -| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除 | -| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId | -| uid8+ | number | 是 | 否 | 应用程序的uid | -| entityType8+ | string | 是 | 否 | 应用程序的实体类型 | -| fingerprint9+ | string | 是 | 否 | 应用程序的签名证书指纹信息，即开发者申请的签名证书的sha256值 | \ No newline at end of file +| name | string | 是 | 否 | 应用程序的名称。 | +| description | string | 是 | 否 | 应用程序的描述。 | +| descriptionId | number | 是 | 否 | 应用程序的描述id。 | +| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序，默认为false。 | +| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true。 | +| label | string | 是 | 否 | 应用程序的标签。 | +| labelId | string | 是 | 否 | 应用程序的标签id。 | +| icon | string | 是 | 否 | 应用程序的图标。 | +| iconId | string | 是 | 否 | 应用程序的图标id。 | +| process | string | 是 | 否 | 应用程序的进程，如果不设置，默认为包的名称。 | +| supportedModes | number | 是 | 否 | 应用程序支持的运行模式。 | +| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径。 | +| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。 | +| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息。 | +| entryDir | string | 是 | 否 | 应用程序的文件保存路径。 | +| codePath8+ | string | 是 | 否 | 应用程序的安装目录。 | +| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息。 | +| metadata9+ | Map\> | 是 | 否 | 应用程序的元信息。 | +| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除。 | +| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId。 | +| uid8+ | number | 是 | 否 | 应用程序的uid。 | +| entityType8+ | string | 是 | 否 | 应用程序的实体类型。 | +| fingerprint9+ | string | 是 | 否 | 应用程序的签名证书指纹信息，即开发者申请的签名证书的sha256值。 | +| appDistributionType9+ | string | 是 | 否 | 应用程序签名证书的分发类型，分为：app_gallery、enterprise、os_integration和crowdtesting。 | +| appProvisionType9+ | string | 是 | 否 | 应用程序签名证书文件的类型，分为debug和release两种类型。| \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md index a18629eaecd6bcafb67900422c06ccd40ff9c5ca..5f8b00ee1195fe7bcd3e9213495f19ccec278d95 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md @@ -5,12 +5,6 @@ > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在FA模型下使用。 -## 导入模块 - -```js -import featureAbility from "@ohos.ability.featureAbility"; -``` - ## 使用说明 使用前根据具体情况引入如下模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md index 276f5a7ec4dd740376a1b628df7ee48227f86760..2a2ff2060ab6415a6e82d60944c73bb5673220cb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md @@ -7,12 +7,6 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 - -```js -import Ability from '@ohos.application.Ability' -``` - ## 使用说明 ​在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md index a63042c67ff250f58f996a30c7753d7e8810bcbc..9add67e43afa65b78f549df61a81eb3548f4883f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -9,14 +9,6 @@ ExtensionContext模块提供扩展的上下文的能力，包括允许访问特 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -Extension的上下文环境，继承自Context。 - -## 导入模块 - -```js -import FormExtension from '@ohos.application.FormExtension'; -``` - ## 属性 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md index 015ddd475088159a64a05e87170c56f8995877e3..567ddc878cdef8fcdb4d0eb2e62c2ac25c813056 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -5,13 +5,7 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行 > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -## 导入模块 - -```js -import abilitymanager from '@ohos.application.abilityManager'; -``` +> 本模块接口均为系统接口，三方应用不支持调用 ## 使用说明 @@ -25,8 +19,7 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { }); ``` - -### 属性 +## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md index 749d2431d1748d499513d8b0b69bf49ec9af93f6..569ad0bb9169c6a48537f884f363d5638d958caa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md @@ -216,7 +216,6 @@ featureAbility.startAbilityForResult( mykey7: true, }, }, - requestCode: 2, }, ).then((data) => { console.info("==========================>startAbilityForResult=======================>"); @@ -507,9 +506,11 @@ connectAbility(request: Want, options:ConnectOptions): number | 名称 | 类型 | 必填 | 描述 | | ------- | -------------- | ---- | --------------------- | | request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | -| options | ConnectOptions | 是 | 被指定的回调方法。 | +| options | [ConnectOptions](#connectoptions) | 是 | 被指定的回调方法。 | -**Want类型说明：** +## Want + +want类型说明 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase @@ -519,7 +520,9 @@ connectAbility(request: Want, options:ConnectOptions): number | bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名。 | | abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名。 | -**ConnectOptions类型说明：** +## ConnectOptions + +ConnectOptions类型说明 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -937,10 +940,10 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 | | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 | | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。 | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 | | FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md index 80fc6ed023a69e45d1bd50ca37d460cde2649799..9bbf04875bd5a84e69463c22a7126df497567a6f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md @@ -9,11 +9,9 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 +## 使用说明 -```js -import FormExtension from '@ohos.application.FormExtension'; -``` +FormExtensionContext模块是FormExtension的上下文环境，继承自ExtensionContext。 ## FormExtensionContext.updateForm diff --git a/zh-cn/application-dev/reference/apis/js-apis-formhost.md b/zh-cn/application-dev/reference/apis/js-apis-formhost.md index 414274cbd0ac62eafaa2dba3c15557d71477bc58..1ab09e60020c9bef5761f041bb1dbd4f57133cc8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formhost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formhost.md @@ -857,7 +857,7 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g 获取卡片状态 -**需要权限**：ohos.permission.REQUIRE_FORM和ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED. **系统能力**：SystemCapability.Ability.Form diff --git a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md index 47ab7b437fe78dcd281968c1a4232e09448221d6..11d26b8696f7cdbaf638778496c0529042e5d9ec 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md @@ -7,12 +7,6 @@ PermissionRequestResult模块提供了权限请求结果的能力。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 - -```js -import Ability from '@ohos.application.Ability' -``` - ## 使用说明 通过AbilityContext实例来获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md index 52d89a799d5dfec2d4291cc35e50545cfc9274ef..0d5ceb5c8c30bb70fb506922a60613cf48e16475 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md @@ -6,12 +6,6 @@ ProcessRunningInfo模块提供对进程运行信息进行设置和查询的能 > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 - -```js -import appManager from '@ohos.application.appManager' -``` - ## 使用说明 通过appManager来获取。 @@ -23,7 +17,6 @@ appManager.getProcessRunningInfos((error,data) => { }); ``` - ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md index ea3d2a2db301f5c1e951539ff08bbcbf51890c03..06d3dd5de92d06ce2c417213d7cde1da87116e1e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md @@ -198,11 +198,13 @@ onReconnect(want: Want): void; } ``` -## ServiceExtensionAbility.onReconnect +## ServiceExtensionAbility.onConfigurationUpdated onConfigurationUpdated(config: Configuration): void; -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 **参数：** @@ -213,7 +215,7 @@ onConfigurationUpdated(config: Configuration): void; **示例：** ```js - class myAbility extends Ability { + class ServiceExt extends ServiceExtension { onConfigurationUpdated(config) { console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); } @@ -226,7 +228,9 @@ dump(params: Array\): Array\; 转储客户端信息时调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 **参数：** @@ -237,7 +241,7 @@ dump(params: Array\): Array\; **示例：** ```js - class myAbility extends Ability { + class ServiceExt extends ServiceExtension { dump(params) { console.log('dump, params:' + JSON.stringify(params)); return ["params"] diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md index 9fb036aae8215ce1177a817dd813b11a6d80157e..745bf28da406c55cc01430cc1424ab539df3ca2c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md @@ -9,11 +9,19 @@ ServiceExtensionContext模块提供ServiceExtension具有的能力和接口， > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -## 导入模块 +## 使用说明 -``` -import ExtensionContext from '@ohos.application.ServiceExtensionAbility'; -``` +ServiceExtensionContext模块是ServiceExtension的上下文环境，继承自ExtensionContext。 + +## 属性 + +表示访问应用程序资源的能力。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| resourceManager | resmgr.ResourceManager; | 是 | 否 | ResourceManager对象。 | ## startAbility @@ -49,8 +57,7 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; ``` - -## ServiceExtensionContext.startAbility +## startAbility startAbility(want: Want): Promise<void>; @@ -89,8 +96,149 @@ startAbility(want: Want): Promise<void>; }); } } + ``` - +## startAbility + +startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void + +启动Ability。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var options = { + windowMode: 0, + }; + this.context.startAbility(want, options, (error) => { + console.log("error.code = " + error.code) + }) + ``` + +## ServiceExtensionContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + this.context.startAbilityWithAccount(want, accountId, (err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }); + ``` + + +## ServiceExtensionContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityWithAccount(want, accountId, options, (err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }); + ``` + + +## ServiceExtensionContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\; + +根据account启动Ability（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0, + }; + this.context.startAbilityWithAccount(want, accountId, options) + .then((data) => { + console.log('---------- startAbilityWithAccount success, data: -----------', data); + }) + .catch((err) => { + console.log('---------- startAbilityWithAccount fail, err: -----------', err); + }) ``` @@ -158,7 +306,6 @@ terminateSelf(): Promise<void>; ``` - ## ServiceExtensionContext.connectAbility connectAbility(want: Want, options: ConnectOptions): number; @@ -174,7 +321,7 @@ connectAbility(want: Want, options: ConnectOptions): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | + | options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | **返回值：** @@ -197,6 +344,47 @@ connectAbility(want: Want, options: ConnectOptions): number; let connection = this.context.connectAbility(want,options); ``` +## ServiceExtensionContext.connectAbilityWithAccount + +connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; + +使用AbilityInfo.AbilityType.SERVICE模板和account将当前能力连接到一个能力。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 需要启动的accountId。 | +| options | ConnectOptions | 否 | 远端对象实例。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回Ability连接的结果code。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var accountId = 100; + var options = { + onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.log('----------- onFailed -----------') } + } + const result = this.context.connectAbilityWithAccount(want, accountId, options); + console.log('----------- connectAbilityResult: ------------', result); + ``` ## ServiceExtensionContext.disconnectAbility @@ -229,10 +417,8 @@ disconnectAbility(connection: number, callback:AsyncCallback<void>): void; } } - ``` - ## ServiceExtensionContext.disconnectAbility disconnectAbility(connection: number): Promise<void>; @@ -270,17 +456,4 @@ disconnectAbility(connection: number): Promise<void>; } } - ``` - - -## ConnectOptions - -ConnectOptions数据结构。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 说明 | -| -------- | -------- | -| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | -| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | -| onFailed(code: number) | 连接失败时回调该接口。 | + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md index 16af31809b99bb5c82fda82a5e44267ec07fd553..541eae28b2029524bd1949eeb209aa3d3d411ca7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md +++ b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md @@ -14,8 +14,6 @@ TestRunner模块提供了框架测试的能力。包括准备单元测试环境 import TestRunner from '@ohos.application.testRunner' ``` - - ## TestRunner.onPrepare onPrepare(): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md index c1691d1baee58caadd4794e1c88e5de6b82b3c03..cc7ab27f03338f1a03c04d13836ee9882b151761 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md @@ -6,15 +6,12 @@ uriPermissionManager模块提供了Uri权限管理的能力。 > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 - ``` import UriPermissionManager from '@ohos.application.uriPermissionManager'; ``` - ## uriPermissionManager.verifyUriPermission verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback<number>): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-webgl.md b/zh-cn/application-dev/reference/apis/js-apis-webgl.md old mode 100644 new mode 100755 index 7c78bce3a03b144ab19fddc775674f390b7378f6..01b09c70a8f9c917344b8f49d4595a067fdda1cd --- a/zh-cn/application-dev/reference/apis/js-apis-webgl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webgl.md @@ -1,11 +1,13 @@ -# webgl - -> **说明：** -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +# WebGL +WebGL提供图形绘制的能力，包括对当前绘制图形的位置、颜色等进行处理。 WebGL标准图形API，对应OpenGL ES 2.0特性集。更多信息请参考[WebGL™标准](https://www.khronos.org/registry/webgl/specs/latest/1.0/)。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 调用方式 diff --git a/zh-cn/application-dev/reference/apis/js-apis-webgl2.md b/zh-cn/application-dev/reference/apis/js-apis-webgl2.md old mode 100644 new mode 100755 index 413090964f3841d1efa8c14df0684f5a5293f207..03ebd9544fb947bd0c96a7e26c9505c60fab9c78 --- a/zh-cn/application-dev/reference/apis/js-apis-webgl2.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webgl2.md @@ -1,11 +1,13 @@ -# webgl2 - -> **说明：** -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +# WebGL2 +WebGL2支持图形的绘制，包括对当前绘制图形的位置、颜色等进行处理，其中相对WebGL来说对渲染管道和着色语言进行了增强。 WebGL标准图形API，对应OpenGL ES 3.0特性集。更多信息请参考[WebGL™标准](https://www.khronos.org/registry/webgl/specs/latest/2.0/)。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 调用方式 diff --git a/zh-cn/device-dev/subsystems/subsys-data-storage-guide.md b/zh-cn/device-dev/subsystems/subsys-data-storage-guide.md index 95e273f55e4d046db071815cd94629fff667cd4e..edadbed8f145320327af3d3f1cdb158df1428ae4 100755 --- a/zh-cn/device-dev/subsystems/subsys-data-storage-guide.md +++ b/zh-cn/device-dev/subsystems/subsys-data-storage-guide.md @@ -42,17 +42,17 @@ | 类名 | 方法名 | 描述 | | --- | ----- | ----| -| Preferences | bool GetBool(const std::string &key, bool defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | std::string GetString(const std::string &key, const std::string &defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | bool GetBool(const std::string &key, bool defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | float GetFloat(const std::string &key, float defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | double GetDouble(const std::string &key, double defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | int64_t GetLong(const std::string &key, int64_t defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | -| Preferences | std::set\ GetStringSet(const std::string &key, std::set\ &defValue); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | int GetInt(const std::string &key, const int defValue = 0); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | std::string GetString(const std::string &key, const std::string &defValue = {}); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | bool GetBool(const std::string &key, const bool defValue = false); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | float GetFloat(const std::string &key, const float defValue = 0); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | double GetDouble(const std::string &key, const double defValue = 0); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | int64_t GetLong(const std::string &key, const int64_t defValue = 0); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | +| Preferences | std::set\ GetStringSet(const std::string &key, const std::set\ &defValue = {}); | key：要获取的存储key名称，不能为空。
defValue：若获取失败或value不存在返回此默认值。
返回值：value。 | **数据持久化** -通过执行flush或者flushSync方法，应用可以将缓存的数据再次写回文本文件中进行持久化存储。 +通过执行Flush()或者FlushSync()方法，应用可以将缓存的数据再次写回文本文件中进行持久化存储。 **表 5** 轻量级数据数据持久化接口 @@ -122,14 +122,13 @@ 5. 数据持久化。 - 应用存入数据到Preferences实例后，可以通过flush或者flushSync方法将Preferences实例回写到文件中。 + 应用存入数据到Preferences实例后，可以通过Flush()或者FlushSync()方法将Preferences实例回写到文件中。 ```C++ int err = pref->FlushSync(); EXPECT_EQ(ret, E_OK); ``` - 6. 订阅数据变化。 应用订阅数据变化需要指定PreferencesObserver作为回调方法。订阅的key的值发生变更后，当执行flush或者flushSync方法时，PreferencesObserver被触发回调。不再需要PreferencesObserver时请注销。 @@ -144,7 +143,7 @@ std::atomic_int notifyTimes; static const std::vector NOTIFY_KEYS_VECTOR; }; - + PreferencesObserverCounter::~PreferencesObserverCounter() {} void PreferencesObserverCounter::OnChange(Preferences &preferences, const std::string &key) @@ -156,7 +155,7 @@ } } } - + const std::vector PreferencesObserverCounter::NOTIFY_KEYS_VECTOR = { PreferencesTest::KEY_TEST_INT_ELEMENT, PreferencesTest::KEY_TEST_LONG_ELEMENT, PreferencesTest::KEY_TEST_FLOAT_ELEMENT, PreferencesTest::KEY_TEST_BOOL_ELEMENT, PreferencesTest::KEY_TEST_STRING_ELEMENT }; @@ -167,17 +166,17 @@ std::shared_ptr counter = std::make_shared(); pref->RegisterObserver(counter); // 注册数据变化的回调。 - + pref->PutString(PreferencesTest::KEY_TEST_STRING_ELEMENT, "test"); pref->Flush(); // 触发执行counter的onChanged回调方法。 EXPECT_EQ(static_cast(counter.get())->notifyTimes, 1); - + /* same value */ pref->PutInt(PreferencesTest::KEY_TEST_INT_ELEMENT, 2); pref->PutString(PreferencesTest::KEY_TEST_STRING_ELEMENT, "test"); pref->Flush(); EXPECT_EQ(static_cast(counter.get())->notifyTimes, 2); - + pref->UnRegisterObserver(counter); // 注销注册数据变化的回调。 ``` @@ -192,4 +191,3 @@ EXPECT_EQ(ret, E_OK); ``` - diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md index 76fe19299fec25e5bee2f28065284d9aa547eb04..ee728783b73f236f22b73073454d2a7004bdacb4 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md @@ -5,152 +5,160 @@ 目前在系统的/system/bin目录下预置了hisysevent工具，开发者可以通过此工具实时订阅HiSysEvent事件及查询历史HiSysEvent事件。 - ## 实时订阅HiSysEvent事件相关命令 - 实时订阅HiSysEvent事件的基础命令： - -``` -hisysevent -r -``` + ``` + hisysevent -r + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -r | 以缺省设置实时订阅HiSysEvent事件，在此种订阅方式下有任何实时HiSysEvent事件产生，都会在控制台上打印此HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -r | 以缺省设置实时订阅HiSysEvent事件，在此种订阅方式下有任何实时HiSysEvent事件产生，都会在控制台上打印此HiSysEvent事件 | - 打开调试模式： - -``` -hisysevent -r -d -``` + ``` + hisysevent -r -d + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -d | 在调试模式下实时订阅HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -d | 在调试模式下实时订阅HiSysEvent事件 | - 通过事件标签方式实时订阅HiSysEvent事件： - -``` -hisysevent -r -t [-c [WHOLE_WORD|PREFIX|REGULAR]] -``` + ``` + hisysevent -r -t [-c [WHOLE_WORD|PREFIX|REGULAR]] + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -t | 设置实时订阅的HiSysEvent事件标签，用来过滤订阅的HiSysEvent事件。 | -| -c | 设置实时订阅的HiSysEvent事件标签匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则。 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -t | 设置实时订阅的HiSysEvent事件标签，用来过滤订阅的HiSysEvent事件。 | + | -c | 设置实时订阅的HiSysEvent事件标签匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则。 | -命令实例： + 命令实例： - -``` -# hisysevent -r -t "TAG" -c PREFIX {"domain_":"ARKUI","name_":"UI_BLOCK_6S","type_":1,"time_":1501940269812,"tz_":"+0000","tag_":"TAG1","pid_":1428,"tid_":1452,"uid_":10001,"level_":"CRITICAL","info_":""} -# hisysevent -r -t "TAw{0,1}" -c REGULAR {"domain_":"WINDOWMANAGER","name_":"NO_FOCUS_WINDOW","type_":1,"time_":1501940269802,"tz_":"+0000","tag_":"TAG","pid_":1428,"tid_":1433,"uid_":10001,"level_":"CRITICAL","info_":""} {"domain_":"ARKUI","name_":"UI_BLOCK_6S","type_":1,"time_":1501940269812,"tz_":"+0000","tag_":"TAG1","pid_":1428,"tid_":1452,"uid_":10001,"level_":"CRITICAL","info_":""} -# hisysevent -r -t "TAw+" -c REGULAR {"domain_":"WINDOWMANAGER","name_":"NO_FOCUS_WINDOW","type_":1,"time_":1501940269802,"tz_":"+0000","tag_":"TAG","pid_":1428,"tid_":1433,"uid_":10001,"level_":"CRITICAL","info_":""} {"domain_":"ARKUI","name_":"UI_BLOCK_6S","type_":1,"time_":1501940269812,"tz_":"+0000","tag_":"TAG1","pid_":1428,"tid_":1452,"uid_":10001,"level_":"CRITICAL","info_":""} -``` + ``` + # hisysevent -r -t "STA" -c PREFIX + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501963670809,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805200750","HAPPEN_TIME":1501963670809,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"4973863135535405472","info_":""} + # hisysevent -r -t "STAw{0,6}" -c REGULAR + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501963793206,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805200953","HAPPEN_TIME":1501963793206,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"16367997008075110557","info_":""} + # hisysevent -r -t "STA\w+" -c REGULAR + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501963863393,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201103","HAPPEN_TIME":1501963863393,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"5522352691813553392","info_":""} + ``` - 通过事件领域及事件名称的方式实时订阅HiSysEvent事件： - -``` -hisysevent -r -o -n [-c [WHOLE_WORD|PREFIX|REGULAR]] -``` + ``` + hisysevent -r -o -n [-c [WHOLE_WORD|PREFIX|REGULAR]] + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -o | 设置实时订阅的HiSysEvent事件领域，用来过滤订阅的HiSysEvent事件。 | -| -n | 设置实时订阅的HiSysEvent事件名称，用来过滤订阅的HiSysEvent事件。 | -| -c | 设置实时订阅的HiSysEvent事件领域及事件名称的匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则。 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -o | 设置实时订阅的HiSysEvent事件领域，用来过滤订阅的HiSysEvent事件。 | + | -n | 设置实时订阅的HiSysEvent事件名称，用来过滤订阅的HiSysEvent事件。 | + | -c | 设置实时订阅的HiSysEvent事件领域及事件名称的匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则。 | -命令实例： + 命令实例： - -``` -# hisysevent -r -o "DOMAINA" -n "EVENTNAMEA" -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":1501940269802,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -# hisysevent -r -o "DOMAw{0,10}" -n "EVENTw+" -c REULAR -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":1501940269802,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} {"domain_":"DOMAINABC","name_":"EVENTNAMEABC","type_":1,"time_":1501940269938,"tz_":"+0000","pid_":1428,"tid_":1336,"uid_":10002,"level_":"CRITICAL","info_":""} -# hisysevent -r -o "DOMAw{0,10}" -c REGULAR -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":1501940269802,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} {"domain_":"DOMAINABC","name_":"EVENTNAMEABC","type_":1,"time_":1501940269938,"tz_":"+0000","pid_":1428,"tid_":1336,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINABC","name_":"EVENTNAMEB","type_":1,"time_":1501940279938,"tz_":"+0000","pid_":1428,"tid_":1344,"uid_":10002,"level_":"CRITICAL","info_":""} -``` + ``` + # hisysevent -r -o "RELIABILITY" -n "APP_FREEZE" + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501963989773,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201309","HAPPEN_TIME":1501963989773,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"16367997008075110557","info_":""} + # hisysevent -r -o "RELIABI\w{0,8}" -n "APP_FREEZE" -c REGULAR + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964144383,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201544","HAPPEN_TIME":1501964144383,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"13456525196455104060","info_":""} + # hisysevent -r -o "RELIABI\w+" -c REGULAR + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964193466,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201633","HAPPEN_TIME":1501964193466,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"12675246910904037271","info_":""} + ``` -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** + > 当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。 ## 查询历史HiSysEvent事件相关命令 - 查询历史HiSysEvent事件的基础命令： - -``` -hisysevent -l -``` + ``` + hisysevent -l + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -l | 以缺省设置查询历史HiSysEvent事件，此次查询会返回最近不多于1000条的HiSysEvent事件。 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -l | 以缺省设置查询历史HiSysEvent事件，此次查询会返回最近不多于1000条的HiSysEvent事件。 | - 通过设置开始/结束时间，过滤查询历史HiSysEvent事件的结果的命令： - -``` -hisysevent -l -s -e -``` + ``` + hisysevent -l -s -e + ``` -选项说明： + 选项说明： - | 选项名称 | 功能说明 | -| -------- | -------- | -| -s | 设置查询历史HiSysEvent事件的开始时间，此次查询只会返回不早于该时间点的HiSysEvent事件。 | -| -e | 设置查询历史HiSysEvent事件的结束时间，此次查询只会返回不晚于该时间点的HiSysEvent事件。 | + | 选项名称 | 功能说明 | + | -------- | -------- | + | -s | 设置查询历史HiSysEvent事件的开始时间，此次查询只会返回不早于该时间点的HiSysEvent事件。 | + | -e | 设置查询历史HiSysEvent事件的结束时间，此次查询只会返回不晚于该时间点的HiSysEvent事件。 | -命令实例： + 命令实例： - -``` -# hisysevent -l -s 20207388633 -e 20207389000 -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388633,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388634,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388900,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207389000,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -``` + ``` + # hisysevent -l -s 1501964222980 -e 1501964222996 + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964222980,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201702","HAPPEN_TIME":1501964222980,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"10435592800188571430","info_":""} + {"domain_":"GRAPHIC","name_":"NO_DRAW","type_":1,"time_":1501964222980,"tz_":"+0000","pid_":1505,"tid_":1585,"uid_":10002,"PID":1505,"UID":10002,"ABILITY_NAME":"","MSG":"It took 1957104259905ns to draw, UI took 0ns to draw, RSRenderThread took 8962625ns to draw, RSRenderThread dropped 0 UI Frames","level_":"MINOR","id_":"1708287249901948387","info_":"isResolved,eventId:0"} + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964222994,"tz_":"+0000","pid_":623,"tid_":1445,"uid_":1201,"SUB_EVENT_TYPE":"NO_DRAW","EVENT_TIME":"20170805201702","MODULE":"NO_DRAW","PNAME":"NO_DRAW","REASON":"NO_DRAW","DIAG_INFO":"","STACK":"SUMMARY:\n","HIVIEW_LOG_FILE_PATHS":["/data/log/faultlog/faultlogger/appfreeze-NO_DRAW-10002-20170805201702"],"DOMAIN":"GRAPHIC","STRING_ID":"NO_DRAW","PID":1505,"UID":10002,"PACKAGE_NAME":"NO_DRAW","PROCESS_NAME":"","MSG":"It took 1956945826265ns to draw, UI took 0ns to draw, RSRenderThread took 9863293ns to draw, RSRenderThread dropped 0 UI Frames\n","level_":"CRITICAL","tag_":"STABILITY","id_":"10448522101019619655","info_":""} + ``` - 通过设置最大数量值，限制查询历史HiSysEvent事件的数量： - -``` -hisysevent -l -m -``` - -选项说明： - - | 选项名称 | 功能说明 | -| -------- | -------- | -| -m | 设置查询历史HiSysEvent事件的数量，有效值范围[0,1000]，此次查询返回的HiSysEvent事件数目不会多于此值。 | - -命令实例： - - -``` -# hisysevent -l -s 20207388633 -e 20207389000 -m 3 -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388634,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388900,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207389000,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -# hisysevent -l -m 2 -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388633,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -{"domain_":"DOMAINA","name_":"EVENTNAMEA","type_":1,"time_":20207388634,"tz_":"+0000","pid_":1428,"tid_":1333,"uid_":10002,"level_":"CRITICAL","info_":""} -``` + ``` + hisysevent -l -m + ``` + + 选项说明： + + | 选项名称 | 功能说明 | + | -------- | -------- | + | -m | 设置查询历史HiSysEvent事件的数量，有效值范围[0,1000]，此次查询返回的HiSysEvent事件数目不会多于此值。 | + + 命令实例： + + ``` + # hisysevent -l -s 1501964222980 -e 1501964222996 -m 1 + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964222980,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201702","HAPPEN_TIME":1501964222980,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"10435592800188571430","info_":""} + ``` + +## 系统事件合法性校验模式 + +- 打开系统事件合法性校验模式 + + ``` + hisysevent -v + ``` + + 选项说明： + + | 选项名称 | 功能说明 | + | -------- | -------- | + | -v | 配合订阅命令-r及查询命令-l使用，当打开事件合法性校验模式，系统事件包含的非法内容会标记为红色高亮显示。 | + + 命令实例： + + ``` + # hisysevent -v -l -s 1501964222980 -e 1501964222996 + # 因为HAPPEN_TIME与VERSION没有在事件领域RELIABILITY所属的事件名称APP_FREEZE下进行yaml文件配置，属于非法内容，所以这两个键会被高亮显示为红色. + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964222980,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805201702","HAPPEN_TIME":1501964222980,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"10435592800188571430","info_":""} + # hisysevent -v -r -o "RELIABILITY" -n "APP_FREEZE" + {"domain_":"RELIABILITY","name_":"APP_FREEZE","type_":1,"time_":1501964644584,"pid_":1505,"uid_":10002,"FAULT_TYPE":"4","MODULE":"com.ohos.screenlock","REASON":"NO_DRAW","SUMMARY":"SUMMARY:\n","LOG_PATH":"/data/log/faultlog/faultlogger/appfreeze-com.ohos.screenlock-10002-20170805202404","HAPPEN_TIME":1501964644584,"VERSION":"1.0.0","level_":"CRITICAL","tag_":"STABILITY","id_":"11097868872446282676","info_":""} + ``` \ No newline at end of file