提交 f185aa3c 编写于 作者: G Gloria

Update docs against 14165+14771+14276 and more

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 8baaf999
...@@ -10,7 +10,7 @@ The **Ability** module provides all level-2 module APIs for developers to export ...@@ -10,7 +10,7 @@ The **Ability** module provides all level-2 module APIs for developers to export
## Modules to Import ## Modules to Import
```ts ```ts
import ability from '@ohos.ability.ability' import ability from '@ohos.ability.ability';
``` ```
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
......
# @ohos.ability.dataUriUtils (dataUriUtils) # @ohos.ability.dataUriUtils (DataUriUtils)
The **DataUriUtils** module provides APIs to process URI objects. You can use the APIs to attach an ID to the end of a given URI and obtain, delete, or update the ID attached to the end of a given URI. This module will be replaced by the **app.ability.dataUriUtils** module in the near future. You are advised to use the **[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)** module. The **DataUriUtils** module provides APIs to process URI objects. You can use the APIs to attach an ID to the end of a given URI and obtain, delete, or update the ID attached to the end of a given URI. This module will be replaced by the **app.ability.dataUriUtils** module in the near future. You are advised to use the **[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)** module.
...@@ -35,7 +35,7 @@ Obtains the ID attached to the end of a given URI. ...@@ -35,7 +35,7 @@ Obtains the ID attached to the end of a given URI.
**Example** **Example**
```ts ```ts
let id = dataUriUtils.getId("com.example.dataUriUtils/1221"); let id = dataUriUtils.getId('com.example.dataUriUtils/1221');
``` ```
...@@ -66,9 +66,9 @@ Attaches an ID to the end of a given URI. ...@@ -66,9 +66,9 @@ Attaches an ID to the end of a given URI.
```ts ```ts
let id = 1122; let id = 1122;
let uri = dataUriUtils.attachId( let uri = dataUriUtils.attachId(
"com.example.dataUriUtils", 'com.example.dataUriUtils',
id, id,
) );
``` ```
...@@ -96,7 +96,7 @@ Deletes the ID from the end of a given URI. ...@@ -96,7 +96,7 @@ Deletes the ID from the end of a given URI.
**Example** **Example**
```ts ```ts
let uri = dataUriUtils.deleteId("com.example.dataUriUtils/1221") let uri = dataUriUtils.deleteId('com.example.dataUriUtils/1221');
``` ```
...@@ -127,7 +127,7 @@ Updates the ID in a given URI. ...@@ -127,7 +127,7 @@ Updates the ID in a given URI.
```ts ```ts
let id = 1122; let id = 1122;
let uri = dataUriUtils.updateId( let uri = dataUriUtils.updateId(
"com.example.dataUriUtils/1221", 'com.example.dataUriUtils/1221',
id id
) );
``` ```
...@@ -9,7 +9,7 @@ The **ErrorCode** module defines the error codes that may be returned when an ab ...@@ -9,7 +9,7 @@ The **ErrorCode** module defines the error codes that may be returned when an ab
## Modules to Import ## Modules to Import
```ts ```ts
import errorCode from '@ohos.ability.errorCode' import errorCode from '@ohos.ability.errorCode';
``` ```
## ErrorCode ## ErrorCode
......
...@@ -41,24 +41,24 @@ Observe the following when using this API: ...@@ -41,24 +41,24 @@ Observe the following when using this API:
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.startAbility( featureAbility.startAbility(
{ {
want: want:
{ {
action: "", action: '',
entities: [""], entities: [''],
type: "", type: '',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri: "" uri: ''
}, },
}, },
(err, data) => { (err, data) => {
console.info("startAbility err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('startAbility err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
} }
); );
``` ```
...@@ -94,24 +94,24 @@ Observe the following when using this API: ...@@ -94,24 +94,24 @@ Observe the following when using this API:
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.startAbility( featureAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri: "" uri: ''
}, },
} }
).then((data) => { ).then((data) => {
console.info("startAbility data: " + JSON.stringify(data)); console.info('startAbility data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -145,8 +145,8 @@ Observe the following when using this API: ...@@ -145,8 +145,8 @@ Observe the following when using this API:
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
``` ```
...@@ -154,7 +154,10 @@ var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( ...@@ -154,7 +154,10 @@ var dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
Starts an ability. After the ability is started, you can call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability and return the result to the caller. If an exception occurs, for example, the ability is killed, exception information is returned to the caller. This API uses an asynchronous callback to return the result. Starts an ability. This API uses an asynchronous callback to return the result when the ability is terminated. The following situations may be possible for a started ability:
- Normally, you can call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability. The result is returned to the caller.
- If an exception occurs, for example, the ability is killed, an exception message, in which **resultCode** is **-1**, is returned to the caller.
- If different applications call this API to start an ability that uses the sington mode and then call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability, the normal result is returned to the last caller, and an exception message, in which **resultCode** is **-1**, is returned to others.
Observe the following when using this API: Observe the following when using this API:
- If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission. - If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission.
...@@ -174,24 +177,24 @@ Observe the following when using this API: ...@@ -174,24 +177,24 @@ Observe the following when using this API:
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.startAbilityForResult( featureAbility.startAbilityForResult(
{ {
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri:"" uri:''
}, },
}, },
(err, data) => { (err, data) => {
console.info("startAbilityForResult err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('startAbilityForResult err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
} }
); );
``` ```
...@@ -200,7 +203,10 @@ featureAbility.startAbilityForResult( ...@@ -200,7 +203,10 @@ featureAbility.startAbilityForResult(
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
Starts an ability. After the ability is started, you can call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability and return the result to the caller. If an exception occurs, for example, the ability is killed, exception information is returned to the caller. This API uses a promise to return the result. Starts an ability. This API uses a promise to return the result when the ability is terminated. The following situations may be possible to an ability after it is started:
- Normally, you can call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability. The result is returned to the caller.
- If an exception occurs, for example, the ability is killed, an exception message, in which **resultCode** is **-1**, is returned to the caller.
- If different applications call this API to start an ability that uses the sington mode and then call [terminateSelfWithResult](#featureabilityterminateselfwithresult7) to terminate the ability, the normal result is returned to the last caller, and an exception message, in which **resultCode** is **-1**, is returned to others.
Observe the following when using this API: Observe the following when using this API:
- If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission. - If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission.
...@@ -225,35 +231,35 @@ Observe the following when using this API: ...@@ -225,35 +231,35 @@ Observe the following when using this API:
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.startAbilityForResult( featureAbility.startAbilityForResult(
{ {
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri:"", uri:'',
parameters: parameters:
{ {
mykey0: 1111, mykey0: 1111,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "xxxxxxxxxxxxxxxxxxxxxx", mykey3: 'xxxxxxxxxxxxxxxxxxxxxx',
mykey4: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], mykey6: ['aaaaaa', 'bbbbb', 'ccccccccccc'],
mykey7: true, mykey7: true,
}, },
}, },
}, },
).then((data) => { ).then((data) => {
console.info("startAbilityForResult data: " + JSON.stringify(data)); console.info('startAbilityForResult data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -276,35 +282,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe ...@@ -276,35 +282,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.terminateSelfWithResult( featureAbility.terminateSelfWithResult(
{ {
resultCode: 1, resultCode: 1,
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri:"", uri:'',
parameters: { parameters: {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey6: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey7: true, mykey7: true,
} }
}, },
}, },
(err) => { (err) => {
console.info("err: " + JSON.stringify(err)) console.error('err: ${JSON.stringify(err)}');
} }
); );
``` ```
...@@ -333,35 +339,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe ...@@ -333,35 +339,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
featureAbility.terminateSelfWithResult( featureAbility.terminateSelfWithResult(
{ {
resultCode: 1, resultCode: 1,
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
/* In the FA model, abilityName consists of package and ability names. */ /* In the FA model, abilityName consists of package and ability names. */
abilityName: "com.example.myapplication.secondAbility", abilityName: 'com.example.myapplication.secondAbility',
uri:"", uri:'',
parameters: { parameters: {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey6: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey7: true, mykey7: true,
} }
}, },
} }
).then((data) => { ).then((data) => {
console.info("==========================>terminateSelfWithResult=======================>"); console.info('==========================>terminateSelfWithResult=======================>');
}); });
``` ```
...@@ -384,7 +390,7 @@ Checks whether the main window of this ability has the focus. This API uses an a ...@@ -384,7 +390,7 @@ Checks whether the main window of this ability has the focus. This API uses an a
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.hasWindowFocus((err, data) => { featureAbility.hasWindowFocus((err, data) => {
console.info("hasWindowFocus err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('hasWindowFocus err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -407,7 +413,7 @@ Checks whether the main window of this ability has the focus. This API uses a pr ...@@ -407,7 +413,7 @@ Checks whether the main window of this ability has the focus. This API uses a pr
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.hasWindowFocus().then((data) => { featureAbility.hasWindowFocus().then((data) => {
console.info("hasWindowFocus data: " + JSON.stringify(data)); console.info('hasWindowFocus data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -430,7 +436,7 @@ Obtains the Want corresponding to the ability to start. This API uses an asynchr ...@@ -430,7 +436,7 @@ Obtains the Want corresponding to the ability to start. This API uses an asynchr
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.getWant((err, data) => { featureAbility.getWant((err, data) => {
console.info("getWant err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getWant err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -453,7 +459,7 @@ Obtains the Want corresponding to the ability to start. This API uses a promise ...@@ -453,7 +459,7 @@ Obtains the Want corresponding to the ability to start. This API uses a promise
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.getWant().then((data) => { featureAbility.getWant().then((data) => {
console.info("getWant data: " + JSON.stringify(data)); console.info('getWant data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -475,9 +481,9 @@ Obtains the application context. ...@@ -475,9 +481,9 @@ Obtains the application context.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext() let context = featureAbility.getContext();
context.getBundleName((err, data) => { context.getBundleName((err, data) => {
console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getBundleName err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -501,7 +507,7 @@ Terminates this ability. This API uses an asynchronous callback to return the re ...@@ -501,7 +507,7 @@ Terminates this ability. This API uses an asynchronous callback to return the re
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.terminateSelf( featureAbility.terminateSelf(
(err) => { (err) => {
console.info("err: " + JSON.stringify(err)) console.error('err: ${JSON.stringify(err)}');
} }
) )
``` ```
...@@ -525,7 +531,7 @@ Terminates this ability. This API uses a promise to return the result. ...@@ -525,7 +531,7 @@ Terminates this ability. This API uses a promise to return the result.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.terminateSelf().then((data) => { featureAbility.terminateSelf().then((data) => {
console.info("==========================>terminateSelf=======================>"); console.info('==========================>terminateSelf=======================>');
}); });
``` ```
...@@ -562,19 +568,19 @@ Observe the following when using this API: ...@@ -562,19 +568,19 @@ Observe the following when using this API:
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}')
} }
function onFailedCallback(code){ function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('featureAbilityTest ConnectAbility onFailed errCode : ${code}')
} }
var connectId = featureAbility.connectAbility( let connectId = featureAbility.connectAbility(
{ {
deviceId: "", deviceId: '',
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "com.ix.ServiceAbility.ServiceAbilityA", abilityName: 'com.ix.ServiceAbility.ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -605,18 +611,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses an asynch ...@@ -605,18 +611,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses an asynch
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}');
} }
function onFailedCallback(code){ function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('featureAbilityTest ConnectAbility onFailed errCode : ${code}');
} }
var connectId = featureAbility.connectAbility( let connectId = featureAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "com.ix.ServiceAbility.ServiceAbilityA", abilityName: 'com.ix.ServiceAbility.ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -624,11 +630,10 @@ var connectId = featureAbility.connectAbility( ...@@ -624,11 +630,10 @@ var connectId = featureAbility.connectAbility(
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
var result = featureAbility.disconnectAbility(connectId,
(error) => { featureAbility.disconnectAbility(connectId, (err) => {
console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code) console.error('featureAbilityTest disconnectAbility err: ${JSON.stringify(err)}');
}, });
);
``` ```
## featureAbility.disconnectAbility<sup>7+</sup> ## featureAbility.disconnectAbility<sup>7+</sup>
...@@ -657,18 +662,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses a promise ...@@ -657,18 +662,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses a promise
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}');
} }
function onFailedCallback(code){ function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('featureAbilityTest ConnectAbility onFailed errCode : ${code}');
} }
var connectId = featureAbility.connectAbility( let connectId = featureAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "com.ix.ServiceAbility.ServiceAbilityA", abilityName: 'com.ix.ServiceAbility.ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -678,9 +683,9 @@ var connectId = featureAbility.connectAbility( ...@@ -678,9 +683,9 @@ var connectId = featureAbility.connectAbility(
); );
featureAbility.disconnectAbility(connectId).then((data) => { featureAbility.disconnectAbility(connectId).then((data) => {
console.log('data : ' + data); console.log('data: ${data)}';
}).catch((error)=>{ }).catch((error)=>{
console.log('featureAbilityTest result errCode : ' + error.code); console.error('featureAbilityTest result errCode : ${error.code}');
}); });
``` ```
...@@ -703,7 +708,7 @@ Obtains the window corresponding to this ability. This API uses an asynchronous ...@@ -703,7 +708,7 @@ Obtains the window corresponding to this ability. This API uses an asynchronous
```ts ```ts
featureAbility.getWindow((err, data) => { featureAbility.getWindow((err, data) => {
console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data)); console.info('getWindow err: ${JSON.stringify(err)}, data: ${typeof(data)}');
}); });
``` ```
...@@ -725,7 +730,7 @@ Obtains the window corresponding to this ability. This API uses a promise to ret ...@@ -725,7 +730,7 @@ Obtains the window corresponding to this ability. This API uses a promise to ret
```ts ```ts
featureAbility.getWindow().then((data) => { featureAbility.getWindow().then((data) => {
console.info("getWindow data: " + typeof(data)); console.info('getWindow data: ${typeof(data)}');
}); });
``` ```
...@@ -745,8 +750,8 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED ...@@ -745,8 +750,8 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
| ---------------------------------------- | ---- | ---------------------------------------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | The PageAbility is in an undefined window display mode.| | WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | The PageAbility is in an undefined window display mode.|
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | The PageAbility is in full screen mode. | | WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | The PageAbility is in full screen mode. |
| WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | The PageAbility is displayed in the primary window when it is in split-screen mode.| | WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | The left screen in horizontal direction or the upper screen in vertical direction is the primary window.|
| WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101 | The PageAbility is displayed in the secondary window when it is in split-screen mode.| | WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101 | The right screen in horizontal direction or the lower screen in vertical direction is the secondary window.|
| WINDOW_MODE_FLOATING<sup>7+</sup> | 102 | The PageAbility is displayed in floating window mode.| | WINDOW_MODE_FLOATING<sup>7+</sup> | 102 | The PageAbility is displayed in floating window mode.|
...@@ -766,9 +771,9 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -766,9 +771,9 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
| Name | Value | Description | | Name | Value | Description |
| ---------------------------- | --------------- | ---------------------------------------- | | ---------------------------- | --------------- | ---------------------------------------- |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | Ability window size.| | BOUNDS_KEY<sup>7+</sup> | 'abilityBounds' | Ability window size.|
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | Ability window display mode.| | WINDOW_MODE_KEY<sup>7+</sup> | 'windowMode' | Ability window display mode.|
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | Display device ID.| | DISPLAY_ID_KEY<sup>7+</sup> | 'displayId' | Display device ID.|
## ErrorCode ## ErrorCode
......
...@@ -14,7 +14,7 @@ The ParticleAbility module is used to perform operations on abilities of the Dat ...@@ -14,7 +14,7 @@ The ParticleAbility module is used to perform operations on abilities of the Dat
## Modules to Import ## Modules to Import
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
``` ```
## particleAbility.startAbility ## particleAbility.startAbility
...@@ -40,27 +40,27 @@ Observe the following when using this API: ...@@ -40,27 +40,27 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
import wantConstant from '@ohos.ability.wantConstant' import wantConstant from '@ohos.ability.wantConstant';
particleAbility.startAbility( particleAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.Data", bundleName: 'com.example.Data',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
uri: "" uri: ''
}, },
}, },
(error, result) => { (error, result) => {
console.log('particleAbility startAbility errCode:' + error + 'result:' + result) console.error('particleAbility startAbility errCode: ${JSON.stringify(error)}, result: ${JSON.stringify(result)}');
}, },
) );
``` ```
## particleAbility.startAbility ## particleAbility.startAbility
...@@ -91,25 +91,25 @@ Observe the following when using this API: ...@@ -91,25 +91,25 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
import wantConstant from '@ohos.ability.wantConstant' import wantConstant from '@ohos.ability.wantConstant';
particleAbility.startAbility( particleAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: 'action.system.home',
entities: ["entity.system.home"], entities: ['entity.system.home'],
type: "MIMETYPE", type: 'MIMETYPE',
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: '',
bundleName: "com.example.Data", bundleName: 'com.example.Data',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
uri: "" uri: ''
}, },
}, },
).then((data) => { ).then((data) => {
console.info("particleAbility startAbility"); console.info('particleAbility startAbility');
}); });
``` ```
...@@ -130,13 +130,13 @@ Terminates this ParticleAbility. This API uses an asynchronous callback to retur ...@@ -130,13 +130,13 @@ Terminates this ParticleAbility. This API uses an asynchronous callback to retur
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
particleAbility.terminateSelf( particleAbility.terminateSelf(
(error, result) => { (error, result) => {
console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result) console.log('particleAbility terminateSelf errCode: ${JSON.stringify(error)}, result: ${JSON.stringify(result)}');
} }
) );
``` ```
## particleAbility.terminateSelf ## particleAbility.terminateSelf
...@@ -156,10 +156,10 @@ Terminates this ParticleAbility. This API uses a promise to return the result. ...@@ -156,10 +156,10 @@ Terminates this ParticleAbility. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
particleAbility.terminateSelf().then((data) => { particleAbility.terminateSelf().then((data) => {
console.info("particleAbility terminateSelf"); console.info('particleAbility terminateSelf');
}); });
``` ```
...@@ -194,10 +194,10 @@ Observe the following when using this API: ...@@ -194,10 +194,10 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
var uri = ""; let uri = '';
particleAbility.acquireDataAbilityHelper(uri) particleAbility.acquireDataAbilityHelper(uri);
``` ```
...@@ -228,17 +228,17 @@ import wantAgent from '@ohos.app.ability.wantAgent'; ...@@ -228,17 +228,17 @@ import wantAgent from '@ohos.app.ability.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error('Operation failed cause: ${JSON.stringify(err)}');
} else { } else {
console.info("Operation succeeded"); console.info('Operation succeeded');
} }
} }
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
} }
], ],
operationType: wantAgent.OperationType.START_ABILITY, operationType: wantAgent.OperationType.START_ABILITY,
...@@ -248,8 +248,8 @@ let wantAgentInfo = { ...@@ -248,8 +248,8 @@ let wantAgentInfo = {
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let basicContent = { let basicContent = {
title: "title", title: 'title',
text: "text" text: 'text'
}; };
let notificationContent = { let notificationContent = {
contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
...@@ -298,8 +298,8 @@ import wantAgent from '@ohos.app.ability.wantAgent'; ...@@ -298,8 +298,8 @@ import wantAgent from '@ohos.app.ability.wantAgent';
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
} }
], ],
operationType: wantAgent.OperationType.START_ABILITY, operationType: wantAgent.OperationType.START_ABILITY,
...@@ -309,8 +309,8 @@ let wantAgentInfo = { ...@@ -309,8 +309,8 @@ let wantAgentInfo = {
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let basicContent = { let basicContent = {
title: "title", title: 'title',
text: "text" text: 'text'
}; };
let notificationContent = { let notificationContent = {
contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
...@@ -322,9 +322,9 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { ...@@ -322,9 +322,9 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
}; };
let id = 1; let id = 1;
particleAbility.startBackgroundRunning(id, request).then(() => { particleAbility.startBackgroundRunning(id, request).then(() => {
console.info("Operation succeeded"); console.info('Operation succeeded');
}).catch((err) => { }).catch((err) => {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error('Operation failed cause: ${JSON.stringify(err)}');
}); });
}); });
...@@ -351,9 +351,9 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -351,9 +351,9 @@ import particleAbility from '@ohos.ability.particleAbility';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error('Operation failed cause: ${JSON.stringify(err)}');
} else { } else {
console.info("Operation succeeded"); console.info('Operation succeeded');
} }
} }
...@@ -381,9 +381,9 @@ Requests to cancel a continuous task from the system. This API uses a promise to ...@@ -381,9 +381,9 @@ Requests to cancel a continuous task from the system. This API uses a promise to
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
particleAbility.cancelBackgroundRunning().then(() => { particleAbility.cancelBackgroundRunning().then(() => {
console.info("Operation succeeded"); console.info('Operation succeeded');
}).catch((err) => { }).catch((err) => {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error('Operation failed cause: ${JSON.stringify(err)}');
}); });
``` ```
...@@ -413,25 +413,25 @@ Observe the following when using this API: ...@@ -413,25 +413,25 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc';
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}');
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ${code}');
} }
var connId = particleAbility.connectAbility( let connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "ServiceAbilityA", abilityName: 'ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -441,9 +441,9 @@ var connId = particleAbility.connectAbility( ...@@ -441,9 +441,9 @@ var connId = particleAbility.connectAbility(
); );
particleAbility.disconnectAbility(connId).then((data) => { particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); console.log(' data: ${data}');
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ${error.code}');
}); });
``` ```
...@@ -468,21 +468,21 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -468,21 +468,21 @@ import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}');
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ${code}');
} }
var connId = particleAbility.connectAbility( let connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "ServiceAbilityA", abilityName: 'ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -492,8 +492,7 @@ var connId = particleAbility.connectAbility( ...@@ -492,8 +492,7 @@ var connId = particleAbility.connectAbility(
); );
particleAbility.disconnectAbility(connId, (err) => { particleAbility.disconnectAbility(connId, (err) => {
console.log("particleAbilityTest disconnectAbility err====>" console.log('particleAbilityTest disconnectAbility err: ${JSON.stringify(err)}');
+ ("json err=") + JSON.stringify(err));
}); });
``` ```
...@@ -519,21 +518,21 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -519,21 +518,21 @@ import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ${element.deviceId}');
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ${code}');
} }
var connId = particleAbility.connectAbility( let connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: 'com.ix.ServiceAbility',
abilityName: "ServiceAbilityA", abilityName: 'ServiceAbilityA',
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -543,9 +542,9 @@ var connId = particleAbility.connectAbility( ...@@ -543,9 +542,9 @@ var connId = particleAbility.connectAbility(
); );
particleAbility.disconnectAbility(connId).then((data) => { particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); console.log(' data: ${data}');
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ${error.code}');
}); });
``` ```
......
...@@ -44,7 +44,7 @@ Enumerates the action constants of the **Want** object. **action** specifies the ...@@ -44,7 +44,7 @@ Enumerates the action constants of the **Want** object. **action** specifies the
| INTENT_PARAMS_INTENT | ability.want.params.INTENT | Action of displaying selection options with an action selector. | | INTENT_PARAMS_INTENT | ability.want.params.INTENT | Action of displaying selection options with an action selector. |
| INTENT_PARAMS_TITLE | ability.want.params.TITLE | Title of the character sequence dialog box used with the action selector. | | INTENT_PARAMS_TITLE | ability.want.params.TITLE | Title of the character sequence dialog box used with the action selector. |
| ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | Action of selecting a file. | | ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | Action of selecting a file. |
| PARAMS_STREAM<sup>7+</sup> | ability.params.stream | URI of the data stream associated with the target when the data is sent. | | PARAMS_STREAM<sup>7+</sup> | ability.params.stream | URI of the data stream associated with the target when the data is sent. The value must be an array of the string type. |
| ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | Action of providing the OAuth service. | | ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | Action of providing the OAuth service. |
| ACTION_APP_ACCOUNT_AUTH <sup>9+</sup> | account.appAccount.action.auth | Action of providing the authentication service. | | ACTION_APP_ACCOUNT_AUTH <sup>9+</sup> | account.appAccount.action.auth | Action of providing the authentication service. |
| ACTION_MARKET_DOWNLOAD <sup>9+</sup> | ohos.want.action.marketDownload | Action of downloading an application from the application market.<br>**System API**: This is a system API and cannot be called by third-party applications. | | ACTION_MARKET_DOWNLOAD <sup>9+</sup> | ohos.want.action.marketDownload | Action of downloading an application from the application market.<br>**System API**: This is a system API and cannot be called by third-party applications. |
......
...@@ -28,7 +28,7 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -28,7 +28,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); console.log('onConfigurationUpdate, config: ${JSON.stringify(config)}');
} }
} }
``` ```
...@@ -55,7 +55,7 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -55,7 +55,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level: ${JSON.stringify(level)}');
} }
} }
``` ```
...@@ -64,7 +64,7 @@ const config = { ...@@ -64,7 +64,7 @@ const config = {
language: 'Zh-Hans', // Simplified Chinese. language: 'Zh-Hans', // Simplified Chinese.
colorMode: COLOR_MODE_LIGHT, // Light theme. colorMode: COLOR_MODE_LIGHT, // Light theme.
direction: DIRECTION_VERTICAL, // Vertical direction. direction: DIRECTION_VERTICAL, // Vertical direction.
screenDensity: SCREEN_DENSITY_SDPI, // The screen resolution is SDPI. screenDensity: SCREEN_DENSITY_SDPI, // The screen pixel density is 'sdpi'.
displayId: 1, // The application is displayed on the display with ID 1. displayId: 1, // The application is displayed on the display with ID 1.
hasPointerDevice: true, // A pointer device is connected. hasPointerDevice: true, // A pointer device is connected.
}; };
...@@ -76,7 +76,7 @@ try { ...@@ -76,7 +76,7 @@ try {
} else { } else {
console.log('updateConfiguration success.'); console.log('updateConfiguration success.');
} }
}) });
} catch (paramError) { } catch (paramError) {
console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}'); console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
} }
...@@ -121,7 +121,7 @@ const config = { ...@@ -121,7 +121,7 @@ const config = {
language: 'Zh-Hans', // Simplified Chinese. language: 'Zh-Hans', // Simplified Chinese.
colorMode: COLOR_MODE_LIGHT, // Light theme. colorMode: COLOR_MODE_LIGHT, // Light theme.
direction: DIRECTION_VERTICAL, // Vertical direction. direction: DIRECTION_VERTICAL, // Vertical direction.
screenDensity: SCREEN_DENSITY_SDPI, // The screen resolution is SDPI. screenDensity: SCREEN_DENSITY_SDPI, // The screen pixel density is 'sdpi'.
displayId: 1, // The application is displayed on the display with ID 1. displayId: 1, // The application is displayed on the display with ID 1.
hasPointerDevice: true, // A pointer device is connected. hasPointerDevice: true, // A pointer device is connected.
}; };
...@@ -131,7 +131,7 @@ try { ...@@ -131,7 +131,7 @@ try {
console.log('updateConfiguration success.'); console.log('updateConfiguration success.');
}).catch((err) => { }).catch((err) => {
console.log('updateConfiguration fail, err: ${JSON.stringify(err)}'); console.log('updateConfiguration fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}'); console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
} }
...@@ -306,7 +306,7 @@ try { ...@@ -306,7 +306,7 @@ try {
console.log('getExtensionRunningInfos success, data: ${JSON.stringify(data)}'); console.log('getExtensionRunningInfos success, data: ${JSON.stringify(data)}');
}).catch((err) => { }).catch((err) => {
console.log('getExtensionRunningInfos fail, err: ${JSON.stringify(err)}'); console.log('getExtensionRunningInfos fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}'); console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
} }
...@@ -379,5 +379,5 @@ abilityManager.getTopAbility().then((data) => { ...@@ -379,5 +379,5 @@ abilityManager.getTopAbility().then((data) => {
console.log('getTopAbility success, data: ${JSON.stringify(data)}'); console.log('getTopAbility success, data: ${JSON.stringify(data)}');
}).catch((err) => { }).catch((err) => {
console.log('getTopAbility fail, err: ${JSON.stringify(err)}'); console.log('getTopAbility fail, err: ${JSON.stringify(err)}');
}) });
``` ```
...@@ -45,7 +45,7 @@ appManager.isRunningInStabilityTest((err, flag) => { ...@@ -45,7 +45,7 @@ appManager.isRunningInStabilityTest((err, flag) => {
} else { } else {
console.log('The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}'); console.log('The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}');
} }
}) });
``` ```
...@@ -151,7 +151,7 @@ appManager.isRamConstrainedDevice((err, data) => { ...@@ -151,7 +151,7 @@ appManager.isRamConstrainedDevice((err, data) => {
} else { } else {
console.log('The result of isRamConstrainedDevice is: ${JSON.stringify(data)}'); console.log('The result of isRamConstrainedDevice is: ${JSON.stringify(data)}');
} }
}) });
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -221,7 +221,7 @@ appManager.getAppMemorySize((err, data) => { ...@@ -221,7 +221,7 @@ appManager.getAppMemorySize((err, data) => {
} else { } else {
console.log('The size of app memory is: ${JSON.stringify(data)}'); console.log('The size of app memory is: ${JSON.stringify(data)}');
} }
}) });
``` ```
## appManager.getRunningProcessInformation ## appManager.getRunningProcessInformation
...@@ -295,7 +295,7 @@ appManager.getRunningProcessInformation((err, data) => { ...@@ -295,7 +295,7 @@ appManager.getRunningProcessInformation((err, data) => {
} else { } else {
console.log('The process running information is: ${JSON.stringify(data)}'); console.log('The process running information is: ${JSON.stringify(data)}');
} }
}) });
``` ```
## appManager.on ## appManager.on
...@@ -352,7 +352,7 @@ let applicationStateObserver = { ...@@ -352,7 +352,7 @@ let applicationStateObserver = {
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`); console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`);
} }
} };
try { try {
const observerId = appManager.on('applicationState', applicationStateObserver); const observerId = appManager.on('applicationState', applicationStateObserver);
console.log(`[appManager] observerCode: ${observerId}`); console.log(`[appManager] observerCode: ${observerId}`);
...@@ -416,7 +416,7 @@ let applicationStateObserver = { ...@@ -416,7 +416,7 @@ let applicationStateObserver = {
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`); console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`);
} }
} };
let bundleNameList = ['bundleName1', 'bundleName2']; let bundleNameList = ['bundleName1', 'bundleName2'];
try { try {
const observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList); const observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList);
...@@ -478,7 +478,7 @@ let applicationStateObserver = { ...@@ -478,7 +478,7 @@ let applicationStateObserver = {
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`); console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`);
} }
} };
let bundleNameList = ['bundleName1', 'bundleName2']; let bundleNameList = ['bundleName1', 'bundleName2'];
try { try {
observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList); observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList);
...@@ -559,7 +559,7 @@ let applicationStateObserver = { ...@@ -559,7 +559,7 @@ let applicationStateObserver = {
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`); console.log(`[appManager] onProcessStateChanged: ${JSON.stringify(processData)}`);
} }
} };
let bundleNameList = ['bundleName1', 'bundleName2']; let bundleNameList = ['bundleName1', 'bundleName2'];
try { try {
observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList); observerId = appManager.on('applicationState', applicationStateObserver, bundleNameList);
...@@ -574,7 +574,7 @@ try { ...@@ -574,7 +574,7 @@ try {
console.log('unregisterApplicationStateObserver success, data: ${JSON.stringify(data)}'); console.log('unregisterApplicationStateObserver success, data: ${JSON.stringify(data)}');
}).catch((err) => { }).catch((err) => {
console.log('unregisterApplicationStateObserver fail, err: ${JSON.stringify(err)}'); console.log('unregisterApplicationStateObserver fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.log('error: ${paramError.code}, ${paramError.message}'); console.log('error: ${paramError.code}, ${paramError.message}');
} }
...@@ -660,7 +660,7 @@ appManager.getForegroundApplications().then((data) => { ...@@ -660,7 +660,7 @@ appManager.getForegroundApplications().then((data) => {
console.log('getForegroundApplications success, data: ${JSON.stringify(data)}'); console.log('getForegroundApplications success, data: ${JSON.stringify(data)}');
}).catch((err) => { }).catch((err) => {
console.log('getForegroundApplications fail, err: ${JSON.stringify(err)}'); console.log('getForegroundApplications fail, err: ${JSON.stringify(err)}');
}) });
``` ```
## appManager.killProcessWithAccount ## appManager.killProcessWithAccount
...@@ -702,7 +702,7 @@ try { ...@@ -702,7 +702,7 @@ try {
console.log('killProcessWithAccount success'); console.log('killProcessWithAccount success');
}).catch((err) => { }).catch((err) => {
console.error('killProcessWithAccount fail, err: ${JSON.stringify(err)}'); console.error('killProcessWithAccount fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.error('error: ${paramError.code}, ${paramError.message}'); console.error('error: ${paramError.code}, ${paramError.message}');
} }
...@@ -844,7 +844,7 @@ try { ...@@ -844,7 +844,7 @@ try {
console.log('killProcessesByBundleName success.'); console.log('killProcessesByBundleName success.');
}).catch((err) => { }).catch((err) => {
console.log('killProcessesByBundleName fail, err: ${JSON.stringify(err)}'); console.log('killProcessesByBundleName fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.log('error: ${paramError.code}, ${paramError.message}'); console.log('error: ${paramError.code}, ${paramError.message}');
} }
...@@ -940,7 +940,7 @@ try { ...@@ -940,7 +940,7 @@ try {
console.log('clearUpApplicationData success.'); console.log('clearUpApplicationData success.');
}).catch((err) => { }).catch((err) => {
console.log('clearUpApplicationData fail, err: ${JSON.stringify(err)}'); console.log('clearUpApplicationData fail, err: ${JSON.stringify(err)}');
}) });
} catch (paramError) { } catch (paramError) {
console.log('error: ${paramError.code}, ${paramError.message}'); console.log('error: ${paramError.code}, ${paramError.message}');
} }
......
...@@ -10,7 +10,7 @@ The **Common** module provides all level-2 module APIs for developers to export. ...@@ -10,7 +10,7 @@ The **Common** module provides all level-2 module APIs for developers to export.
## Modules to Import ## Modules to Import
```ts ```ts
import common from '@ohos.app.ability.common' import common from '@ohos.app.ability.common';
``` ```
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
...@@ -24,16 +24,15 @@ import common from '@ohos.app.ability.common' ...@@ -24,16 +24,15 @@ import common from '@ohos.app.ability.common'
| Context | [Context](js-apis-inner-application-context.md) | Level-2 module **Context**.| | Context | [Context](js-apis-inner-application-context.md) | Level-2 module **Context**.|
| ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | Level-2 module **ExtensionContext**.| | ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | Level-2 module **ExtensionContext**.|
| FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | Level-2 module **FormExtensionContext**.| | FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | Level-2 module **FormExtensionContext**.|
| AreaMode | [AreaMode](#areamode) | Enumerated values of **AreaMode**.| | ServiceExtensionContext | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | Level-2 module **ServiceExtensionContext**.|
| EventHub | [EventHub](js-apis-inner-application-eventHub.md) | Level-2 module **EventHub**.| | EventHub | [EventHub](js-apis-inner-application-eventHub.md) | Level-2 module **EventHub**.|
| PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | Level-2 module **PermissionRequestResult**.|
| PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | Level-2 module **PacMap**.| | PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | Level-2 module **PacMap**.|
| AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | Level-2 module **AbilityResult**.| | AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | Level-2 module **AbilityResult**.|
| ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | Level-2 module **ConnectOptions**.| | ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | Level-2 module **ConnectOptions**.|
**Example** **Example**
```ts ```ts
import common from '@ohos.app.ability.common' import common from '@ohos.app.ability.common';
let uiAbilityContext: common.UIAbilityContext; let uiAbilityContext: common.UIAbilityContext;
let abilityStageContext: common.AbilityStageContext; let abilityStageContext: common.AbilityStageContext;
...@@ -42,21 +41,8 @@ let baseContext: common.BaseContext; ...@@ -42,21 +41,8 @@ let baseContext: common.BaseContext;
let context: common.Context; let context: common.Context;
let extensionContext: common.ExtensionContext; let extensionContext: common.ExtensionContext;
let formExtensionContext: common.FormExtensionContext; let formExtensionContext: common.FormExtensionContext;
let areaMode: common.AreaMode;
let eventHub: common.EventHub; let eventHub: common.EventHub;
let permissionRequestResult: common.PermissionRequestResult;
let pacMap: common.PacMap; let pacMap: common.PacMap;
let abilityResult: common.AbilityResult; let abilityResult: common.AbilityResult;
let connectOptions: common.ConnectOptions; let connectOptions: common.ConnectOptions;
``` ```
## AreaMode
Enumerates the data encryption levels.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
| Name | Value | Description |
| --------------- | ---- | --------------- |
| EL1 | 0 | Device-level encryption area, which is accessible after the device is powered on. |
| EL2 | 1 | User-level encryption area, which is accessible only after the device is powered on and the password is entered (for the first time).|
# @ohos.app.ability.Configuration (Configuration) # @ohos.app.ability.Configuration (Configuration)
The **Configuration** module defines environment change information. The **Configuration** module defines environment change information. **Configuration** is an interface definition and is used only for field declaration.
> **NOTE** > **NOTE**
> >
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
```ts
import Configuration from '@ohos.app.ability.Configuration';
```
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| language | string | Yes| Yes| Language of the application, for example, **zh**.| | language | string | Yes| Yes| Language of the application, for example, **zh**.|
| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | Yes| Yes| Color mode, which can be **COLOR_MODE_LIGHT** or **COLOR_MODE_DARK**. The default value is **COLOR_MODE_LIGHT**.| | colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | Yes| Yes| Color mode. The default value is **COLOR_MODE_LIGHT**. The options are as follows:<br>- **COLOR_MODE_NOT_SET**: The color mode is not set.<br>- **COLOR_MODE_LIGHT**: light mode.<br>- **COLOR_MODE_DARK**: dark mode.|
| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | Yes| No| Screen orientation, which can be **DIRECTION_HORIZONTAL** or **DIRECTION_VERTICAL**.| | direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | Yes| No| Screen orientation. The options are as follows:<br>- **DIRECTION_NOT_SET**: The screen orientation is not set.<br>- **DIRECTION_HORIZONTAL**: horizontal direction.<br>- **DIRECTION_VERTICAL**: vertical direction.|
| screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | Yes| No| Screen resolution, which can be **SCREEN_DENSITY_SDPI** (120), **SCREEN_DENSITY_MDPI** (160), **SCREEN_DENSITY_LDPI** (240), **SCREEN_DENSITY_XLDPI** (320), **SCREEN_DENSITY_XXLDPI** (480), or **SCREEN_DENSITY_XXXLDPI** (640).| | screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | Yes| No| Pixel density of the screen. The options are as follows:<br>- **SCREEN_DENSITY_NOT_SET**: The pixel density is not set.<br>- **SCREEN_DENSITY_SDPI**: 120.<br>- **SCREEN_DENSITY_MDPI**: 160.<br>- **SCREEN_DENSITY_LDPI**: 240.<br>- **SCREEN_DENSITY_XLDPI**: 320.<br>- **SCREEN_DENSITY_XXLDPI**: 480.<br>- **SCREEN_DENSITY_XXXLDPI**: 640.|
| displayId | number | Yes| No| ID of the display where the application is located.| | displayId | number | Yes| No| ID of the display where the application is located.|
| hasPointerDevice | boolean | Yes| No| Whether a pointer device, such as a keyboard, mouse, or touchpad, is connected.| | hasPointerDevice | boolean | Yes| No| Whether a pointer device, such as a keyboard, mouse, or touchpad, is connected.|
...@@ -34,7 +28,7 @@ export default class EntryAbility extends UIAbility { ...@@ -34,7 +28,7 @@ export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
let envCallback = { let envCallback = {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`);
let language = config.language; let language = config.language;
let colorMode = config.colorMode; let colorMode = config.colorMode;
let direction = config.direction; let direction = config.direction;
...@@ -45,10 +39,10 @@ export default class EntryAbility extends UIAbility { ...@@ -45,10 +39,10 @@ export default class EntryAbility extends UIAbility {
}; };
try { try {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
let callbackId = applicationContext.on("environment", envCallback); let callbackId = applicationContext.on('environment', envCallback);
console.log("callbackId: " + callbackId); console.log('callbackId: ${callbackId}');
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
} }
} }
......
...@@ -46,10 +46,10 @@ You can obtain the value of this constant by calling the **ConfigurationConstant ...@@ -46,10 +46,10 @@ You can obtain the value of this constant by calling the **ConfigurationConstant
| Name| Value| Description| | Name| Value| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| SCREEN_DENSITY_NOT_SET | 0 | Unspecified screen resolution.| | SCREEN_DENSITY_NOT_SET | 0 | The screen pixel density is not set.|
| SCREEN_DENSITY_SDPI | 120 | The screen resolution is sdpi.| | SCREEN_DENSITY_SDPI | 120 | The pixel density of the screen is 'sdpi'.|
| SCREEN_DENSITY_MDPI | 160 | The screen resolution is mdpi.| | SCREEN_DENSITY_MDPI | 160 | The pixel density of the screen is 'mdpi'.|
| SCREEN_DENSITY_LDPI | 240 | The screen resolution is ldpi.| | SCREEN_DENSITY_LDPI | 240 | The pixel density of the screen is 'ldpi'.|
| SCREEN_DENSITY_XLDPI | 320 | The screen resolution is xldpi.| | SCREEN_DENSITY_XLDPI | 320 | The pixel density of the screen is 'xldpi'.|
| SCREEN_DENSITY_XXLDPI | 480 | The screen resolution is xxldpi.| | SCREEN_DENSITY_XXLDPI | 480 | The pixel density of the screen is 'xxldpi'.|
| SCREEN_DENSITY_XXXLDPI | 640 | The screen resolution is xxxldpi.| | SCREEN_DENSITY_XXXLDPI | 640 | The pixel density of the screen is 'xxxldpi'.|
...@@ -36,10 +36,10 @@ Obtains the ID attached to the end of a given URI. ...@@ -36,10 +36,10 @@ Obtains the ID attached to the end of a given URI.
```ts ```ts
try { try {
var id = dataUriUtils.getId("com.example.dataUriUtils/1221") let id = dataUriUtils.getId('com.example.dataUriUtils/1221');
console.info('get id: ' + id) console.info('get id: ${id}');
} catch(err) { } catch(err) {
console.error('get id err ,check the uri' + err) console.error('get id err ,check the uri ${err}');
} }
``` ```
...@@ -69,15 +69,15 @@ Attaches an ID to the end of a given URI. ...@@ -69,15 +69,15 @@ Attaches an ID to the end of a given URI.
**Example** **Example**
```ts ```ts
var id = 1122; let id = 1122;
try { try {
var uri = dataUriUtils.attachId( let uri = dataUriUtils.attachId(
"com.example.dataUriUtils", 'com.example.dataUriUtils',
id, id,
) );
console.info('attachId the uri is: ' + uri) console.info('attachId the uri is: ${uri}');
} catch (err) { } catch (err) {
console.error('get id err ,check the uri' + err) console.error('get id err ,check the uri ${err}');
} }
``` ```
...@@ -108,10 +108,10 @@ Deletes the ID from the end of a given URI. ...@@ -108,10 +108,10 @@ Deletes the ID from the end of a given URI.
```ts ```ts
try { try {
var uri = dataUriUtils.deleteId("com.example.dataUriUtils/1221") let uri = dataUriUtils.deleteId('com.example.dataUriUtils/1221');
console.info('delete id with the uri is: ' + uri) console.info('delete id with the uri is: ${uri}');
} catch(err) { } catch(err) {
console.error('delete uri err, check the input uri' + err) console.error('delete uri err, check the input uri ${err}');
} }
``` ```
...@@ -144,12 +144,12 @@ Updates the ID in a given URI. ...@@ -144,12 +144,12 @@ Updates the ID in a given URI.
```ts ```ts
try { try {
var id = 1122; let id = 1122;
var uri = dataUriUtils.updateId( let uri = dataUriUtils.updateId(
"com.example.dataUriUtils/1221", 'com.example.dataUriUtils/1221',
id id
) );
} catch (err) { } catch (err) {
console.error('delete uri err, check the input uri' + err) console.error('delete uri err, check the input uri ${err}');
} }
``` ```
...@@ -11,7 +11,7 @@ The **EnvironmentCallback** module provides the **onConfigurationUpdated** API f ...@@ -11,7 +11,7 @@ The **EnvironmentCallback** module provides the **onConfigurationUpdated** API f
## Modules to Import ## Modules to Import
```ts ```ts
import EnvironmentCallback from "@ohos.app.ability.EnvironmentCallback"; import EnvironmentCallback from '@ohos.app.ability.EnvironmentCallback';
``` ```
...@@ -29,33 +29,51 @@ Called when the system environment changes. ...@@ -29,33 +29,51 @@ Called when the system environment changes.
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | Yes| **Configuration** object after the change.| | config | [Configuration](js-apis-app-ability-configuration.md) | Yes| **Configuration** object after the change.|
## EnvironmentCallback.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
Called when the system memory level changes.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | Yes| Memory level that indicates the memory usage status. When the specified memory level is reached, a callback will be invoked and the system will start adjustment.|
**Example** **Example**
```ts ```ts
import UIAbility from "@ohos.app.ability.Ability"; import UIAbility from '@ohos.app.ability.Ability';
var callbackId; let callbackId;
export default class MyAbility extends UIAbility { export default class MyAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log('MyAbility onCreate');
globalThis.applicationContext = this.context.getApplicationContext(); globalThis.applicationContext = this.context.getApplicationContext();
let EnvironmentCallback = { let EnvironmentCallback = {
onConfigurationUpdated(config){ onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config)); console.log('onConfigurationUpdated config: ${JSON.stringify(config)}');
} }
onMemoryLevel(level){
console.log('onMemoryLevel level: ${JSON.stringify(level)}');
} }
};
// 1. Obtain an applicationContext object. // 1. Obtain an applicationContext object.
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
// 2. Register a listener for the environment changes through the applicationContext object. // 2. Register a listener for the environment changes through the applicationContext object.
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); console.log('registerEnvironmentCallback number: ${JSON.stringify(callbackId)}');
} }
onDestroy() { onDestroy() {
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); console.log('unregisterEnvironmentCallback success, err: ${JSON.stringify(error)}');
}); });
} }
} }
......
...@@ -8,12 +8,12 @@ The **ErrorManager** module provides APIs for registering and deregistering erro ...@@ -8,12 +8,12 @@ The **ErrorManager** module provides APIs for registering and deregistering erro
## Modules to Import ## Modules to Import
```ts ```ts
import errorManager from '@ohos.app.ability.errorManager' import errorManager from '@ohos.app.ability.errorManager';
``` ```
## ErrorManager.on ## ErrorManager.on
on(type: "error", observer: ErrorObserver): number; on(type: 'error', observer: ErrorObserver): number;
Registers an error observer. Registers an error observer.
...@@ -35,22 +35,22 @@ Registers an error observer. ...@@ -35,22 +35,22 @@ Registers an error observer.
**Example** **Example**
```ts ```ts
var observer = { let observer = {
onUnhandledException(errorMsg) { onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg) console.log('onUnhandledException, errorMsg: ', errorMsg);
} }
} };
var observerId = -1; let observerId = -1;
try { try {
observerId = errorManager.on("error", observer); observerId = errorManager.on('error', observer);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
## ErrorManager.off ## ErrorManager.off
off(type: "error", observerId: number, callback: AsyncCallback\<void>): void; off(type: 'error', observerId: number, callback: AsyncCallback\<void>): void;
Deregisters an error observer. This API uses an asynchronous callback to return the result. Deregisters an error observer. This API uses an asynchronous callback to return the result.
...@@ -67,7 +67,7 @@ Deregisters an error observer. This API uses an asynchronous callback to return ...@@ -67,7 +67,7 @@ Deregisters an error observer. This API uses an asynchronous callback to return
**Example** **Example**
```ts ```ts
var observerId = 100; let observerId = 100;
function unregisterErrorObserverCallback(err) { function unregisterErrorObserverCallback(err) {
if (err) { if (err) {
...@@ -75,15 +75,15 @@ function unregisterErrorObserverCallback(err) { ...@@ -75,15 +75,15 @@ function unregisterErrorObserverCallback(err) {
} }
} }
try { try {
errorManager.off("error", observerId, unregisterErrorObserverCallback); errorManager.off('error', observerId, unregisterErrorObserverCallback);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
## ErrorManager.off ## ErrorManager.off
off(type: "error", observerId: number): Promise\<void>; off(type: 'error', observerId: number): Promise\<void>;
Deregisters an error observer. This API uses a promise to return the result. Deregisters an error observer. This API uses a promise to return the result.
...@@ -105,17 +105,17 @@ Deregisters an error observer. This API uses a promise to return the result. ...@@ -105,17 +105,17 @@ Deregisters an error observer. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
var observerId = 100; let observerId = 100;
try { try {
errorManager.off("error", observerId) errorManager.off('error', observerId)
.then((data) => { .then((data) => {
console.log('----------- unregisterErrorObserver success ----------', data); console.log('----------- unregisterErrorObserver success ----------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('----------- unregisterErrorObserver fail ----------', err); console.log('----------- unregisterErrorObserver fail ----------', err);
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -18,7 +18,7 @@ ohos.permission.MANAGE_MISSIONS ...@@ -18,7 +18,7 @@ ohos.permission.MANAGE_MISSIONS
## missionManager.on ## missionManager.on
on(type:"mission", listener: MissionListener): number; on(type:'mission', listener: MissionListener): number;
Registers a listener to observe the mission status. Registers a listener to observe the mission status.
...@@ -46,53 +46,53 @@ Registers a listener to observe the mission status. ...@@ -46,53 +46,53 @@ Registers a listener to observe the mission status.
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
var listenerId = -1; let listenerId = -1;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("[Demo] EntryAbility onCreate"); console.log('[Demo] EntryAbility onCreate');
globalThis.abilityWant = want; globalThis.abilityWant = want;
globalThis.context = this.context; globalThis.context = this.context;
} }
onDestroy() { onDestroy() {
try { try {
if (listenerId != -1) { if (listenerId !== -1) {
missionManager.off("mission", listenerId).catch(function (err) { missionManager.off('mission', listenerId).catch(function (err) {
console.log(err); console.log(err);
}); });
} }
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
console.log("[Demo] EntryAbility onDestroy") console.log('[Demo] EntryAbility onDestroy');
} }
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
// The main window is created. Set a main page for this ability. // The main window is created. Set a main page for this ability.
console.log("[Demo] EntryAbility onWindowStageCreate") console.log('[Demo] EntryAbility onWindowStageCreate');
try { try {
listenerId = missionManager.on("mission", listener); listenerId = missionManager.on('mission', listener);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
windowStage.loadContent("pages/index", (err, data) => { windowStage.loadContent('pages/index', (err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to load the content. Cause:' + JSON.stringify(err)); console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
return; return;
} }
console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)) console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
}); });
if (globalThis.flag) { if (globalThis.flag) {
...@@ -105,7 +105,7 @@ export default class EntryAbility extends UIAbility { ...@@ -105,7 +105,7 @@ export default class EntryAbility extends UIAbility {
## missionManager.off ## missionManager.off
off(type: "mission", listenerId: number, callback: AsyncCallback&lt;void&gt;): void; off(type: 'mission', listenerId: number, callback: AsyncCallback&lt;void&gt;): void;
Deregisters a mission status listener. Deregisters a mission status listener.
...@@ -128,53 +128,53 @@ Deregisters a mission status listener. ...@@ -128,53 +128,53 @@ Deregisters a mission status listener.
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
var listenerId = -1; let listenerId = -1;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("[Demo] EntryAbility onCreate") console.log('[Demo] EntryAbility onCreate');
globalThis.abilityWant = want; globalThis.abilityWant = want;
globalThis.context = this.context; globalThis.context = this.context;
} }
onDestroy() { onDestroy() {
try { try {
if (listenerId != -1) { if (listenerId !== -1) {
missionManager.off("mission", listenerId, (err) => { missionManager.off('mission', listenerId, (err) => {
console.log(err); console.log(err);
}); });
} }
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
console.log("[Demo] EntryAbility onDestroy") console.log('[Demo] EntryAbility onDestroy');
} }
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
// The main window is created. Set a main page for this ability. // The main window is created. Set a main page for this ability.
console.log("[Demo] EntryAbility onWindowStageCreate") console.log('[Demo] EntryAbility onWindowStageCreate');
try { try {
listenerId = missionManager.on("mission", listener); listenerId = missionManager.on('mission', listener);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
windowStage.loadContent("pages/index", (err, data) => { windowStage.loadContent('pages/index', (err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to load the content. Cause:' + JSON.stringify(err)); console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
return; return;
} }
console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)) console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
}); });
if (globalThis.flag) { if (globalThis.flag) {
...@@ -187,7 +187,7 @@ export default class EntryAbility extends UIAbility { ...@@ -187,7 +187,7 @@ export default class EntryAbility extends UIAbility {
## missionManager.off ## missionManager.off
off(type: "mission", listenerId: number): Promise&lt;void&gt;; off(type: 'mission', listenerId: number): Promise&lt;void&gt;;
Deregisters a mission status listener. This API uses a promise to return the result. Deregisters a mission status listener. This API uses a promise to return the result.
...@@ -215,53 +215,53 @@ Deregisters a mission status listener. This API uses a promise to return the res ...@@ -215,53 +215,53 @@ Deregisters a mission status listener. This API uses a promise to return the res
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
var listenerId = -1; let listenerId = -1;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("[Demo] EntryAbility onCreate") console.log('[Demo] EntryAbility onCreate');
globalThis.abilityWant = want; globalThis.abilityWant = want;
globalThis.context = this.context; globalThis.context = this.context;
} }
onDestroy() { onDestroy() {
try { try {
if (listenerId != -1) { if (listenerId !== -1) {
missionManager.off("mission", listenerId).catch(function (err) { missionManager.off('mission', listenerId).catch(function (err) {
console.log(err); console.log(err);
}); });
} }
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
console.log("[Demo] EntryAbility onDestroy") console.log('[Demo] EntryAbility onDestroy');
} }
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
// The main window is created. Set a main page for this ability. // The main window is created. Set a main page for this ability.
console.log("[Demo] EntryAbility onWindowStageCreate") console.log('[Demo] EntryAbility onWindowStageCreate');
try { try {
listenerId = missionManager.on("mission", listener); listenerId = missionManager.on('mission', listener);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
windowStage.loadContent("pages/index", (err, data) => { windowStage.loadContent('pages/index', (err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to load the content. Cause:' + JSON.stringify(err)); console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
return; return;
} }
console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)) console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
}); });
if (globalThis.flag) { if (globalThis.flag) {
...@@ -299,26 +299,25 @@ Obtains the information about a given mission. This API uses an asynchronous cal ...@@ -299,26 +299,25 @@ Obtains the information about a given mission. This API uses an asynchronous cal
let testMissionId = 1; let testMissionId = 1;
try { try {
var allMissions=await missionManager.getMissionInfos("",10).catch(function(err){console.log(err);}); let allMissions=await missionManager.getMissionInfos('',10).catch(function(err){console.log(err);});
if (allMissions && allMissions.length > 0) { if (allMissions && allMissions.length > 0) {
testMissionId = allMissions[0].missionId; testMissionId = allMissions[0].missionId;
} }
missionManager.getMissionInfo("", testMissionId, (error, mission) => { missionManager.getMissionInfo('', testMissionId, (error, mission) => {
if (error) { if (error) {
console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfo failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
} else { } else {
console.log("mission.missionId = " + mission.missionId); console.log('mission.missionId = ${mission.missionId}');
console.log("mission.runningState = " + mission.runningState); console.log('mission.runningState = ${mission.runningState}');
console.log("mission.lockedState = " + mission.lockedState); console.log('mission.lockedState = ${mission.lockedState}');
console.log("mission.timestamp = " + mission.timestamp); console.log('mission.timestamp = ${mission.timestamp}');
console.log("mission.label = " + mission.label); console.log('mission.label = ${mission.label}');
console.log("mission.iconPath = " + mission.iconPath); console.log('mission.iconPath = ${mission.iconPath}');
} }
}); });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error.code: ${paramError.code}, error.message: ${paramError.message}');
} }
``` ```
...@@ -355,13 +354,13 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -355,13 +354,13 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 1; let testMissionId = 1;
try { try {
missionManager.getMissionInfo("", testMissionId).then((data) => { missionManager.getMissionInfo('', testMissionId).then((data) => {
console.info('getMissionInfo successfully. Data: ' + JSON.stringify(data)); console.info('getMissionInfo successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('getMissionInfo failed. Cause: ' + error.message); console.error('getMissionInfo failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('getMissionInfo failed. Cause: ' + error.message); console.error('getMissionInfo failed. Cause: ${error.message}');
} }
``` ```
...@@ -391,17 +390,16 @@ Obtains information about all missions. This API uses an asynchronous callback t ...@@ -391,17 +390,16 @@ Obtains information about all missions. This API uses an asynchronous callback t
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
try { try {
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error) { if (error) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
} else { } else {
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
} }
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -437,13 +435,13 @@ Obtains information about all missions. This API uses a promise to return the re ...@@ -437,13 +435,13 @@ Obtains information about all missions. This API uses a promise to return the re
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
try { try {
missionManager.getMissionInfos("", 10).then((data) => { missionManager.getMissionInfos('', 10).then((data) => {
console.info('getMissionInfos successfully. Data: ' + JSON.stringify(data)); console.info('getMissionInfos successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('getMissionInfos failed. Cause: ' + error.message); console.error('getMissionInfos failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('getMissionInfos failed. Cause: ' + error.message); console.error('getMissionInfos failed. Cause: ${error.message}');
} }
``` ```
...@@ -473,15 +471,15 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -473,15 +471,15 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.getMissionSnapShot("", testMissionId, (err, data) => { missionManager.getMissionSnapShot('', testMissionId, (err, data) => {
if (err) { if (err) {
console.error('getMissionSnapShot failed:' + err.message); console.error('getMissionSnapShot failed: ${err.message}');
} else { } else {
console.info('getMissionSnapShot successfully:' + JSON.stringify(data)); console.info('getMissionSnapShot successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('getMissionSnapShot failed:' + err.message); console.error('getMissionSnapShot failed: ${err.message}');
} }
``` ```
...@@ -516,13 +514,13 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -516,13 +514,13 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.getMissionSnapShot("", testMissionId).then((data) => { missionManager.getMissionSnapShot('', testMissionId).then((data) => {
console.info('getMissionSnapShot successfully. Data: ' + JSON.stringify(data)); console.info('getMissionSnapShot successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('getMissionSnapShot failed. Cause: ' + error.message); console.error('getMissionSnapShot failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('getMissionSnapShot failed. Cause: ' + error.message); console.error('getMissionSnapShot failed. Cause: ${error.message}');
} }
``` ```
...@@ -552,15 +550,15 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -552,15 +550,15 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.getLowResolutionMissionSnapShot("", testMissionId, (err, data) => { missionManager.getLowResolutionMissionSnapShot('', testMissionId, (err, data) => {
if (err) { if (err) {
console.error('getLowResolutionMissionSnapShot failed:' + err.message); console.error('getLowResolutionMissionSnapShot failed: ${err.message}');
} else { } else {
console.info('getLowResolutionMissionSnapShot successfully:' + JSON.stringify(data)); console.info('getLowResolutionMissionSnapShot successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('getLowResolutionMissionSnapShot failed:' + err.message); console.error('getLowResolutionMissionSnapShot failed: ${err.message}');
} }
``` ```
...@@ -596,13 +594,13 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -596,13 +594,13 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.getLowResolutionMissionSnapShot("", testMissionId).then((data) => { missionManager.getLowResolutionMissionSnapShot('', testMissionId).then((data) => {
console.info('getLowResolutionMissionSnapShot successfully. Data: ' + JSON.stringify(data)); console.info('getLowResolutionMissionSnapShot successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('getLowResolutionMissionSnapShot failed. Cause: ' + error.message); console.error('getLowResolutionMissionSnapShot failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('getLowResolutionMissionSnapShot failed. Cause: ' + error.message); console.error('getLowResolutionMissionSnapShot failed. Cause: ${error.message}');
} }
``` ```
...@@ -635,13 +633,13 @@ let testMissionId = 2; ...@@ -635,13 +633,13 @@ let testMissionId = 2;
try { try {
missionManager.lockMission(testMissionId, (err, data) => { missionManager.lockMission(testMissionId, (err, data) => {
if (err) { if (err) {
console.error('lockMission failed:' + err.message); console.error('lockMission failed: ${err.message}');
} else { } else {
console.info('lockMission successfully:' + JSON.stringify(data)); console.info('lockMission successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('lockMission failed:' + err.message); console.error('lockMission failed: ${err.message}');
} }
``` ```
...@@ -676,12 +674,12 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -676,12 +674,12 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.lockMission(testMissionId).then((data) => { missionManager.lockMission(testMissionId).then((data) => {
console.info('lockMission successfully. Data: ' + JSON.stringify(data)); console.info('lockMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('lockMission failed. Cause: ' + error.message); console.error('lockMission failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('lockMission failed. Cause: ' + error.message); console.error('lockMission failed. Cause: ${error.message}');
} }
``` ```
...@@ -712,13 +710,13 @@ let testMissionId = 2; ...@@ -712,13 +710,13 @@ let testMissionId = 2;
try { try {
missionManager.unlockMission(testMissionId, (err, data) => { missionManager.unlockMission(testMissionId, (err, data) => {
if (err) { if (err) {
console.error('unlockMission failed:' + err.message); console.error('unlockMission failed: ${err.message}');
} else { } else {
console.info('unlockMission successfully:' + JSON.stringify(data)); console.info('unlockMission successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('unlockMission failed:' + err.message); console.error('unlockMission failed: ${err.message}');
} }
``` ```
...@@ -754,12 +752,12 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -754,12 +752,12 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.unlockMission(testMissionId).then((data) => { missionManager.unlockMission(testMissionId).then((data) => {
console.info('unlockMission successfully. Data: ' + JSON.stringify(data)); console.info('unlockMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('unlockMission failed. Cause: ' + error.message); console.error('unlockMission failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('unlockMission failed. Cause: ' + error.message); console.error('unlockMission failed. Cause: ${error.message}');
} }
``` ```
...@@ -791,13 +789,13 @@ let testMissionId = 2; ...@@ -791,13 +789,13 @@ let testMissionId = 2;
try { try {
missionManager.clearMission(testMissionId, (err, data) => { missionManager.clearMission(testMissionId, (err, data) => {
if (err) { if (err) {
console.error('clearMission failed:' + err.message); console.error('clearMission failed: ${err.message}');
} else { } else {
console.info('clearMission successfully:' + JSON.stringify(data)); console.info('clearMission successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('clearMission failed:' + err.message); console.error('clearMission failed: ${err.message}');
} }
``` ```
...@@ -834,12 +832,12 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -834,12 +832,12 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.clearMission(testMissionId).then((data) => { missionManager.clearMission(testMissionId).then((data) => {
console.info('clearMission successfully. Data: ' + JSON.stringify(data)); console.info('clearMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('clearMission failed. Cause: ' + error.message); console.error('clearMission failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('clearMission failed. Cause: ' + error.message); console.error('clearMission failed. Cause: ${error.message}');
} }
``` ```
...@@ -863,13 +861,13 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -863,13 +861,13 @@ import missionManager from '@ohos.app.ability.missionManager';
try { try {
missionManager.clearAllMissions(err => { missionManager.clearAllMissions(err => {
if (err) { if (err) {
console.error('clearAllMissions failed:' + err.message); console.error('clearAllMissions failed: ${err.message}');
} else { } else {
console.info('clearAllMissions successfully.'); console.info('clearAllMissions successfully.');
} }
}); });
} catch (err) { } catch (err) {
console.error('clearAllMissions failed:' + err.message); console.error('clearAllMissions failed: ${err.message}');
} }
``` ```
...@@ -900,10 +898,10 @@ try { ...@@ -900,10 +898,10 @@ try {
missionManager.clearAllMissions(bundleName).then(() => { missionManager.clearAllMissions(bundleName).then(() => {
console.info('clearAllMissions successfully.'); console.info('clearAllMissions successfully.');
}).catch(err => { }).catch(err => {
console.error('clearAllMissions failed:' + err.message); console.error('clearAllMissions failed: ${err.message}');
}); });
} catch (err) { } catch (err) {
console.error('clearAllMissions failed:' + err.message); console.error('clearAllMissions failed: ${err.message}');
} }
``` ```
...@@ -935,13 +933,13 @@ let testMissionId = 2; ...@@ -935,13 +933,13 @@ let testMissionId = 2;
try { try {
missionManager.moveMissionToFront(testMissionId, (err, data) => { missionManager.moveMissionToFront(testMissionId, (err, data) => {
if (err) { if (err) {
console.error('moveMissionToFront failed:' + err.message); console.error('moveMissionToFront failed: ${err.message}');
} else { } else {
console.info('moveMissionToFront successfully:' + JSON.stringify(data)); console.info('moveMissionToFront successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('moveMissionToFront failed:' + err.message); console.error('moveMissionToFront failed: ${err.message}');
} }
``` ```
...@@ -974,13 +972,13 @@ let testMissionId = 2; ...@@ -974,13 +972,13 @@ let testMissionId = 2;
try { try {
missionManager.moveMissionToFront(testMissionId, {windowMode : 101}, (err, data) => { missionManager.moveMissionToFront(testMissionId, {windowMode : 101}, (err, data) => {
if (err) { if (err) {
console.error('moveMissionToFront failed:' + err.message); console.error('moveMissionToFront failed: ${err.message}');
} else { } else {
console.info('moveMissionToFront successfully:' + JSON.stringify(data)); console.info('moveMissionToFront successfully: ${JSON.stringify(data)}');
} }
}); });
} catch (err) { } catch (err) {
console.error('moveMissionToFront failed:' + err.message); console.error('moveMissionToFront failed: ${err.message}');
} }
``` ```
...@@ -1017,11 +1015,11 @@ import missionManager from '@ohos.app.ability.missionManager'; ...@@ -1017,11 +1015,11 @@ import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2; let testMissionId = 2;
try { try {
missionManager.moveMissionToFront(testMissionId).then((data) => { missionManager.moveMissionToFront(testMissionId).then((data) => {
console.info('moveMissionToFront successfully. Data: ' + JSON.stringify(data)); console.info('moveMissionToFront successfully. Data: ${JSON.stringify(data)}');
}).catch(error => { }).catch(error => {
console.error('moveMissionToFront failed. Cause: ' + error.message); console.error('moveMissionToFront failed. Cause: ${error.message}');
}); });
} catch (error) { } catch (error) {
console.error('moveMissionToFront failed. Cause: ' + error.message); console.error('moveMissionToFront failed. Cause: ${error.message}');
} }
``` ```
...@@ -24,7 +24,7 @@ Defines the quick fix information at the HAP file level. ...@@ -24,7 +24,7 @@ Defines the quick fix information at the HAP file level.
| ----------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------------------- | ---- | ------------------------------------------------------------ |
| moduleName | string | Yes | Name of the HAP file. | | moduleName | string | Yes | Name of the HAP file. |
| originHapHash | string | Yes | Hash value of the HAP file. | | originHapHash | string | Yes | Hash value of the HAP file. |
| quickFixFilePath | string | Yes | Installation path of the quick fix file. | | quickFixFilePath | string | Yes | Installation path of the quick fix patch file. |
## ApplicationQuickFixInfo ## ApplicationQuickFixInfo
...@@ -57,25 +57,29 @@ Applies a quick fix patch. This API uses an asynchronous callback to return the ...@@ -57,25 +57,29 @@ Applies a quick fix patch. This API uses an asynchronous callback to return the
**Parameters** **Parameters**
| Parameter| Type| Mandatory| Description| | Parameter| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| hapModuleQuickFixFiles | Array\<string> | Yes| Quick fix files, each of which must contain a valid file path.| | hapModuleQuickFixFiles | Array\<string> | Yes| Quick fix patch files, each of which must contain a valid file path.|
| callback | AsyncCallback\<void> | Yes| Callback used to return the result.| | callback | AsyncCallback\<void> | Yes| Callback used to return the result.|
> **NOTE**
>
> The file path passed in the API must be an application sandbox path. For details about how to obtain the sandbox path, see [Obtaining the Sandbox Path](js-apis-bundle-BundleInstaller.md#obtaining-the-sandbox-path). The path mapped to the device is **/proc/<*applicationProcessId*>/root/*sandboxPath***.
**Example** **Example**
```ts ```ts
try { try {
let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] let hapModuleQuickFixFiles = ['/data/storage/el2/base/entry.hqf'];
quickFixManager.applyQuickFix(hapModuleQuickFixFiles, (error) => { quickFixManager.applyQuickFix(hapModuleQuickFixFiles, (error) => {
if (error) { if (error) {
console.info( `applyQuickFix failed with error + ${error}`) console.info( `applyQuickFix failed with error: ${error}`);
} else { } else {
console.info( 'applyQuickFix success') console.info( 'applyQuickFix success');
} }
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error.code: ${paramError.code}, error.message: ${paramError.message}');
} }
``` ```
...@@ -93,28 +97,28 @@ Applies a quick fix patch. This API uses a promise to return the result. ...@@ -93,28 +97,28 @@ Applies a quick fix patch. This API uses a promise to return the result.
**Parameters** **Parameters**
| Parameter| Type| Mandatory| Description| | Parameter| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| hapModuleQuickFixFiles | Array\<string> | Yes| Quick fix files, each of which must contain a valid file path.| | hapModuleQuickFixFiles | Array\<string> | Yes| Quick fix patch files, each of which must contain a valid file path.|
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise\<void> | Promise used to return the result.| | Promise\<void> | Promise used to return the result.|
**Example** **Example**
```ts ```ts
let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] let hapModuleQuickFixFiles = ['/data/storage/el2/base/entry.hqf'];
try { try {
quickFixManager.applyQuickFix(hapModuleQuickFixFiles).then(() => { quickFixManager.applyQuickFix(hapModuleQuickFixFiles).then(() => {
console.info('applyQuickFix success') console.info('applyQuickFix success');
}).catch((error) => { }).catch((error) => {
console.info(`applyQuickFix err: + ${error}`) console.info(`applyQuickFix err: ${error}`);
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -141,16 +145,16 @@ Obtains the quick fix information of the application. This API uses an asynchron ...@@ -141,16 +145,16 @@ Obtains the quick fix information of the application. This API uses an asynchron
```ts ```ts
try { try {
let bundleName = "bundleName" let bundleName = 'bundleName';
quickFixManager.getApplicationQuickFixInfo(bundleName, (error, data) => { quickFixManager.getApplicationQuickFixInfo(bundleName, (error, data) => {
if (error) { if (error) {
console.info(`getApplicationQuickFixInfo error: + ${error}`) console.info(`getApplicationQuickFixInfo error: ${error}`);
} else { } else {
console.info(`getApplicationQuickFixInfo success: + ${data}`) console.info(`getApplicationQuickFixInfo success: ${data}`);
} }
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -174,21 +178,21 @@ Obtains the quick fix information of the application. This API uses a promise to ...@@ -174,21 +178,21 @@ Obtains the quick fix information of the application. This API uses a promise to
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise\<[ApplicationQuickFixInfo](#applicationquickfixinfo)> | Promise used to return the quick fix information.| | Promise\<[ApplicationQuickFixInfo](#applicationquickfixinfo)> | Promise used to return the quick fix information.|
**Example** **Example**
```ts ```ts
try { try {
let bundleName = "bundleName" let bundleName = 'bundleName';
quickFixManager.getApplicationQuickFixInfo(bundleName).then((data) => { quickFixManager.getApplicationQuickFixInfo(bundleName).then((data) => {
console.info(`getApplicationQuickFixInfo success: + ${data}`) console.info(`getApplicationQuickFixInfo success: ${data}`);
}).catch((error) => { }).catch((error) => {
console.info(`getApplicationQuickFixInfo err: + ${error}`) console.info(`getApplicationQuickFixInfo err: ${error}`);
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -49,7 +49,7 @@ Called when a ServiceExtensionAbility is created to initialize the service logic ...@@ -49,7 +49,7 @@ Called when a ServiceExtensionAbility is created to initialize the service logic
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onCreate(want) { onCreate(want) {
console.log('onCreate, want:' + want.abilityName); console.log('onCreate, want: ${want.abilityName}');
} }
} }
``` ```
...@@ -80,7 +80,7 @@ Called when this ServiceExtensionAbility is destroyed to clear resources. ...@@ -80,7 +80,7 @@ Called when this ServiceExtensionAbility is destroyed to clear resources.
onRequest(want: Want, startId: number): void; onRequest(want: Want, startId: number): void;
Called following **onCreate()** when a ServiceExtensionAbility is started by calling **startAbility()**. The value of **startId** is incremented for each ability that is started. Called following **onCreate()** when a ServiceExtensionAbility is started by calling **startAbility()** or **startServiceExtensionAbility()**. The value of **startId** is incremented for each ability that is started.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -98,7 +98,7 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal ...@@ -98,7 +98,7 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onRequest(want, startId) { onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName); console.log('onRequest, want: ${want.abilityName}');
} }
} }
``` ```
...@@ -129,7 +129,7 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal ...@@ -129,7 +129,7 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal
**Example** **Example**
```ts ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc';
class StubTest extends rpc.RemoteObject{ class StubTest extends rpc.RemoteObject{
constructor(des) { constructor(des) {
super(des); super(des);
...@@ -139,8 +139,8 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal ...@@ -139,8 +139,8 @@ Called following **onCreate()** when a ServiceExtensionAbility is started by cal
} }
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onConnect(want) { onConnect(want) {
console.log('onConnect , want:' + want.abilityName); console.log('onConnect , want: ${want.abilityName}');
return new StubTest("test"); return new StubTest('test');
} }
} }
``` ```
...@@ -167,7 +167,7 @@ Called when a client is disconnected from this ServiceExtensionAbility. ...@@ -167,7 +167,7 @@ Called when a client is disconnected from this ServiceExtensionAbility.
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDisconnect(want) { onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName); console.log('onDisconnect, want: ${want.abilityName}');
} }
} }
``` ```
...@@ -193,7 +193,7 @@ Called when a new client attempts to connect to this ServiceExtensionAbility aft ...@@ -193,7 +193,7 @@ Called when a new client attempts to connect to this ServiceExtensionAbility aft
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onReconnect(want) { onReconnect(want) {
console.log('onReconnect, want:' + want.abilityName); console.log('onReconnect, want: ${want.abilityName}');
} }
} }
``` ```
...@@ -219,7 +219,7 @@ Called when the configuration of this ServiceExtensionAbility is updated. ...@@ -219,7 +219,7 @@ Called when the configuration of this ServiceExtensionAbility is updated.
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); console.log('onConfigurationUpdate, config: ${JSON.stringify(config)}');
} }
} }
``` ```
...@@ -245,8 +245,8 @@ Dumps the client information. ...@@ -245,8 +245,8 @@ Dumps the client information.
```ts ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDump(params) { onDump(params) {
console.log('dump, params:' + JSON.stringify(params)); console.log('dump, params: ${JSON.stringify(params)}');
return ["params"] return ['params'];
} }
} }
``` ```
...@@ -47,7 +47,7 @@ Called to initialize the service logic when a UIAbility is created. ...@@ -47,7 +47,7 @@ Called to initialize the service logic when a UIAbility is created.
```ts ```ts
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onCreate(want, param) { onCreate(want, param) {
console.log('onCreate, want:' + want.abilityName); console.log('onCreate, want: ${want.abilityName}');
} }
} }
``` ```
...@@ -202,11 +202,11 @@ Called to save data during the ability migration preparation process. ...@@ -202,11 +202,11 @@ Called to save data during the ability migration preparation process.
**Example** **Example**
```ts ```ts
import AbilityConstant from "@ohos.app.ability.AbilityConstant" import AbilityConstant from '@ohos.app.ability.AbilityConstant';
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onContinue(wantParams) { onContinue(wantParams) {
console.log('onContinue'); console.log('onContinue');
wantParams["myData"] = "my1234567"; wantParams['myData'] = 'my1234567';
return AbilityConstant.OnContinueResult.AGREE; return AbilityConstant.OnContinueResult.AGREE;
} }
} }
...@@ -233,8 +233,8 @@ Called when a new Want is passed in and this UIAbility is started again. ...@@ -233,8 +233,8 @@ Called when a new Want is passed in and this UIAbility is started again.
```ts ```ts
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onNewWant(want, launchParams) { onNewWant(want, launchParams) {
console.log('onNewWant, want:' + want.abilityName); console.log('onNewWant, want: ${want.abilityName}');
console.log('onNewWant, launchParams:' + JSON.stringify(launchParams)); console.log('onNewWant, launchParams: ${JSON.stringify(launchParams)}');
} }
} }
``` ```
...@@ -258,8 +258,8 @@ Dumps client information. ...@@ -258,8 +258,8 @@ Dumps client information.
```ts ```ts
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onDump(params) { onDump(params) {
console.log('dump, params:' + JSON.stringify(params)); console.log('dump, params: ${JSON.stringify(params)}');
return ["params"] return ['params'];
} }
} }
``` ```
...@@ -289,12 +289,12 @@ Called when the framework automatically saves the UIAbility state in the case of ...@@ -289,12 +289,12 @@ Called when the framework automatically saves the UIAbility state in the case of
**Example** **Example**
```ts ```ts
import AbilityConstant from '@ohos.app.ability.AbilityConstant' import AbilityConstant from '@ohos.app.ability.AbilityConstant';
class MyUIAbility extends UIAbility { class MyUIAbility extends UIAbility {
onSaveState(reason, wantParam) { onSaveState(reason, wantParam) {
console.log('onSaveState'); console.log('onSaveState');
wantParam["myData"] = "my1234567"; wantParam['myData'] = 'my1234567';
return AbilityConstant.OnSaveResult.RECOVERY_AGREE; return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
} }
} }
...@@ -339,8 +339,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -339,8 +339,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
```ts ```ts
class MyMessageAble{ // Custom sequenceable data structure. class MyMessageAble{ // Custom sequenceable data structure.
name:"" name:''
str:"" str:''
num: 1 num: 1
constructor(name, str) { constructor(name, str) {
this.name = name; this.name = name;
...@@ -349,38 +349,36 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -349,38 +349,36 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
marshalling(messageParcel) { marshalling(messageParcel) {
messageParcel.writeInt(this.num); messageParcel.writeInt(this.num);
messageParcel.writeString(this.str); messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble marshalling num[${this.num}] str[${this.str}]');
return true; return true;
} }
unmarshalling(messageParcel) { unmarshalling(messageParcel) {
this.num = messageParcel.readInt(); this.num = messageParcel.readInt();
this.str = messageParcel.readString(); this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble unmarshalling num[${this.num}] str[${this.str}]');
return true; return true;
} }
}; };
var method = 'call_Function'; // Notification message string negotiated by the two abilities. let method = 'call_Function'; // Notification message string negotiated by the two abilities.
var caller; let caller;
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.context.startUIAbilityByCall({ this.context.startAbilityByCall({
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
abilityName: "MainUIAbility", abilityName: 'MainUIAbility',
deviceId: "" deviceId: ''
}).then((obj) => { }).then((obj) => {
caller = obj; caller = obj;
let msg = new MyMessageAble("msg", "world"); // See the definition of Sequenceable. let msg = new MyMessageAble('msg', 'world'); // See the definition of Sequenceable.
caller.call(method, msg) caller.call(method, msg)
.then(() => { .then(() => {
console.log('Caller call() called'); console.log('Caller call() called');
}) })
.catch((callErr) => { .catch((callErr) => {
console.log('Caller.call catch error, error.code: ' + JSON.stringify(callErr.code) + console.log('Caller.call catch error, error.code: ${JSON.stringify(callErr.code)}, error.message: ${JSON.stringify(callErr.message)}');
' error.message: ' + JSON.stringify(callErr.message));
}); });
}).catch((err) => { }).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
' error.message: ' + JSON.stringify(err.message));
}); });
} }
} }
...@@ -420,8 +418,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -420,8 +418,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
```ts ```ts
class MyMessageAble{ class MyMessageAble{
name:"" name:''
str:"" str:''
num: 1 num: 1
constructor(name, str) { constructor(name, str) {
this.name = name; this.name = name;
...@@ -430,40 +428,38 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -430,40 +428,38 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
marshalling(messageParcel) { marshalling(messageParcel) {
messageParcel.writeInt(this.num); messageParcel.writeInt(this.num);
messageParcel.writeString(this.str); messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble marshalling num[${this.num}] str[${this.str}]');
return true; return true;
} }
unmarshalling(messageParcel) { unmarshalling(messageParcel) {
this.num = messageParcel.readInt(); this.num = messageParcel.readInt();
this.str = messageParcel.readString(); this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble unmarshalling num[${this.num] str[${this.str}]');
return true; return true;
} }
}; };
var method = 'call_Function'; let method = 'call_Function';
var caller; let caller;
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.context.startUIAbilityByCall({ this.context.startAbilityByCall({
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
abilityName: "MainUIAbility", abilityName: 'MainUIAbility',
deviceId: "" deviceId: ''
}).then((obj) => { }).then((obj) => {
caller = obj; caller = obj;
let msg = new MyMessageAble(1, "world"); let msg = new MyMessageAble(1, 'world');
caller.callWithResult(method, msg) caller.callWithResult(method, msg)
.then((data) => { .then((data) => {
console.log('Caller callWithResult() called'); console.log('Caller callWithResult() called');
let retmsg = new MyMessageAble(0, ""); let retmsg = new MyMessageAble(0, '');
data.readSequenceable(retmsg); data.readSequenceable(retmsg);
}) })
.catch((callErr) => { .catch((callErr) => {
console.log('Caller.callWithResult catch error, error.code: ' + JSON.stringify(callErr.code) + console.log('Caller.callWithResult catch error, error.code: ${JSON.stringify(callErr.code)}, error.message: ${JSON.stringify(callErr.message)}');
' error.message: ' + JSON.stringify(callErr.message));
}); });
}).catch((err) => { }).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
' error.message: ' + JSON.stringify(err.message));
}); });
} }
} }
...@@ -490,24 +486,22 @@ Releases the caller interface of the target ability. ...@@ -490,24 +486,22 @@ Releases the caller interface of the target ability.
**Example** **Example**
```ts ```ts
var caller; let caller;
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.context.startUIAbilityByCall({ this.context.startAbilityByCall({
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
abilityName: "MainUIAbility", abilityName: 'MainUIAbility',
deviceId: "" deviceId: ''
}).then((obj) => { }).then((obj) => {
caller = obj; caller = obj;
try { try {
caller.release(); caller.release();
} catch (releaseErr) { } catch (releaseErr) {
console.log('Caller.release catch error, error.code: ' + JSON.stringify(releaseErr.code) + console.log('Caller.release catch error, error.code: ${JSON.stringify(releaseErr.code)}, error.message: ${JSON.stringify(releaseErr.message)}');
' error.message: ' + JSON.stringify(releaseErr.message));
} }
}).catch((err) => { }).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
' error.message: ' + JSON.stringify(err.message));
}); });
} }
} }
...@@ -525,31 +519,29 @@ Registers a callback that is invoked when the stub on the target ability is disc ...@@ -525,31 +519,29 @@ Registers a callback that is invoked when the stub on the target ability is disc
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | [OnReleaseCallBack](#onreleasecallback) | Yes| Callback used for the **onRelease** API.| | callback | [OnReleaseCallBack](#onreleasecallback) | Yes| Callback used to return the result.|
**Example** **Example**
```ts ```ts
var caller; let caller;
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.context.startUIAbilityByCall({ this.context.startAbilityByCall({
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
abilityName: "MainUIAbility", abilityName: 'MainUIAbility',
deviceId: "" deviceId: ''
}).then((obj) => { }).then((obj) => {
caller = obj; caller = obj;
try { try {
caller.onRelease((str) => { caller.onRelease((str) => {
console.log(' Caller OnRelease CallBack is called ' + str); console.log(' Caller OnRelease CallBack is called ${str}');
}); });
} catch (error) { } catch (error) {
console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) + console.log('Caller.onRelease catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
}).catch((err) => { }).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
' error.message: ' + JSON.stringify(err.message));
}); });
} }
} }
...@@ -557,7 +549,7 @@ Registers a callback that is invoked when the stub on the target ability is disc ...@@ -557,7 +549,7 @@ Registers a callback that is invoked when the stub on the target ability is disc
## Caller.on ## Caller.on
on(type: "release", callback: OnReleaseCallback): void; on(type: 'release', callback: OnReleaseCallback): void;
Registers a callback that is invoked when the stub on the target ability is disconnected. Registers a callback that is invoked when the stub on the target ability is disconnected.
...@@ -568,7 +560,7 @@ Registers a callback that is invoked when the stub on the target ability is disc ...@@ -568,7 +560,7 @@ Registers a callback that is invoked when the stub on the target ability is disc
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is fixed at **release**.| | type | string | Yes| Event type. The value is fixed at **release**.|
| callback | [OnReleaseCallBack](#onreleasecallback) | Yes| Callback used for the **onRelease** API.| | callback | [OnReleaseCallBack](#onreleasecallback) | Yes| Callback used to return the result.|
**Error codes** **Error codes**
...@@ -581,31 +573,127 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -581,31 +573,127 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
**Example** **Example**
```ts ```ts
var caller; let caller;
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.context.startUIAbilityByCall({ this.context.startAbilityByCall({
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
abilityName: "MainUIAbility", abilityName: 'MainUIAbility',
deviceId: "" deviceId: ''
}).then((obj) => { }).then((obj) => {
caller = obj; caller = obj;
try { try {
caller.on("release", (str) => { caller.on('release', (str) => {
console.log(' Caller OnRelease CallBack is called ' + str); console.log(' Caller OnRelease CallBack is called ${str}');
}); });
} catch (error) { } catch (error) {
console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) + console.log('Caller.on catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
}).catch((err) => { }).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
' error.message: ' + JSON.stringify(err.message));
}); });
} }
} }
``` ```
## Caller.off
off(type: 'release', callback: OnReleaseCallback): void;
Deregisters a callback that is invoked when the stub on the target ability is disconnected. This capability is reserved.
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is fixed at **release**.|
| callback | [OnReleaseCallBack](#onreleasecallback) | Yes| Callback used to return the result.|
**Error codes**
| ID| Error Message|
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
For other IDs, see [Ability Error Codes](../errorcodes/errorcode-ability.md).
**Example**
```ts
let caller;
export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: 'com.example.myservice',
abilityName: 'MainUIAbility',
deviceId: ''
}).then((obj) => {
caller = obj;
try {
let onReleaseCallBack = (str) => {
console.log(' Caller OnRelease CallBack is called ${str}');
};
caller.on('release', onReleaseCallBack);
caller.off('release', onReleaseCallBack);
} catch (error) {
console.log('Caller.on or Caller.off catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
}
}).catch((err) => {
console.log('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
});
}
}
```
## Caller.off
off(type: 'release'): void;
Deregisters a callback that is invoked when the stub on the target ability is disconnected. This capability is reserved.
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is fixed at **release**.|
**Error codes**
| ID| Error Message|
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
For other IDs, see [Ability Error Codes](../errorcodes/errorcode-ability.md).
**Example**
```ts
let caller;
export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: 'com.example.myservice',
abilityName: 'MainUIAbility',
deviceId: ''
}).then((obj) => {
caller = obj;
try {
let onReleaseCallBack = (str) => {
console.log(' Caller OnRelease CallBack is called ${str}');
};
caller.on('release', onReleaseCallBack);
caller.off('release');
} catch (error) {
console.error('Caller.on or Caller.off catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
}
}).catch((err) => {
console.error('Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}');
});
}
}
```
## Callee ## Callee
...@@ -638,8 +726,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -638,8 +726,8 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
```ts ```ts
class MyMessageAble{ class MyMessageAble{
name:"" name:''
str:"" str:''
num: 1 num: 1
constructor(name, str) { constructor(name, str) {
this.name = name; this.name = name;
...@@ -648,22 +736,22 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -648,22 +736,22 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
marshalling(messageParcel) { marshalling(messageParcel) {
messageParcel.writeInt(this.num); messageParcel.writeInt(this.num);
messageParcel.writeString(this.str); messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble marshalling num[${this.num}] str[${this.str}]');
return true; return true;
} }
unmarshalling(messageParcel) { unmarshalling(messageParcel) {
this.num = messageParcel.readInt(); this.num = messageParcel.readInt();
this.str = messageParcel.readString(); this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); console.log('MyMessageAble unmarshalling num[${this.num}] str[${this.str}]');
return true; return true;
} }
}; };
var method = 'call_Function'; let method = 'call_Function';
function funcCallBack(pdata) { function funcCallBack(pdata) {
console.log('Callee funcCallBack is called ' + pdata); console.log('Callee funcCallBack is called ${pdata}');
let msg = new MyMessageAble("test", ""); let msg = new MyMessageAble('test', '');
pdata.readSequenceable(msg); pdata.readSequenceable(msg);
return new MyMessageAble("test1", "Callee test"); return new MyMessageAble('test1', 'Callee test');
} }
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
...@@ -671,8 +759,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -671,8 +759,7 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
try { try {
this.callee.on(method, funcCallBack); this.callee.on(method, funcCallBack);
} catch (error) { } catch (error) {
console.log('Callee.on catch error, error.code: ' + JSON.stringify(error.code) + console.log('Callee.on catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
} }
} }
...@@ -704,15 +791,14 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error ...@@ -704,15 +791,14 @@ For details about the error codes, see [Ability Error Codes](../errorcodes/error
**Example** **Example**
```ts ```ts
var method = 'call_Function'; let method = 'call_Function';
export default class MainUIAbility extends UIAbility { export default class MainUIAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log('Callee onCreate is called'); console.log('Callee onCreate is called');
try { try {
this.callee.off(method); this.callee.off(method);
} catch (error) { } catch (error) {
console.log('Callee.off catch error, error.code: ' + JSON.stringify(error.code) + console.log('Callee.off catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
} }
} }
......
...@@ -22,115 +22,133 @@ import Want from '@ohos.app.ability.Want'; ...@@ -22,115 +22,133 @@ import Want from '@ohos.app.ability.Want';
| bundleName | string | No | Bundle name of the ability.| | bundleName | string | No | Bundle name of the ability.|
| moduleName | string | No| Name of the module to which the ability belongs.| | moduleName | string | No| Name of the module to which the ability belongs.|
| abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.| | abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.|
| [action](js-apis-app-ability-wantConstant.md#wantconstantaction) | string | No | Action to take, such as viewing and sharing application details. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](../../application-models/explicit-implicit-want-mappings.md). | | action | string | No | Action to take, such as viewing and sharing application details. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](../../application-models/explicit-implicit-want-mappings.md). |
| [entities](js-apis-app-ability-wantConstant.md#wantconstantentity) | Array\<string> | No| Additional category information (such as browser and video player) of the ability. It is a supplement to the **action** field for implicit Want. and is used to filter ability types.| | entities | Array\<string> | No| Additional category information (such as browser and video player) of the ability. It is a supplement to the **action** field for implicit Want. and is used to filter ability types.|
| uri | string | No| Data carried. This field is used together with **type** to specify the data type. If **uri** is specified in a Want, the Want will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.| | uri | string | No| Data carried. This field is used together with **type** to specify the data type. If **uri** is specified in a Want, the Want will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.|
| type | string | No| MIME type, that is, the type of the file to open, for example, **text/xml** and **image/***. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com.| | type | string | No| MIME type, that is, the type of the file to open, for example, **'text/xml'** and **'image/*'**. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com.|
| parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>- **ohos.aafwk.callerPid**: PID of the caller.<br>- **ohos.aafwk.param.callerToken**: token of the caller.<br>- **ohos.aafwk.param.callerUid**: UID in [BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information. | | parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>- **ohos.aafwk.callerPid**: PID of the caller.<br>- **ohos.aafwk.param.callerToken**: token of the caller.<br>- **ohos.aafwk.param.callerUid**: UID in [BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information.<br>- **component.startup.newRules**: whether to enable the new control rule.<br>- **moduleName**: module name of the caller. No matter what this field is set to, the correct module name will be sent to the peer.<br>- **ohos.dlp.params.sandbox**: available only for DLP files. |
| [flags](js-apis-ability-wantConstant.md#wantconstantflags) | number | No| How the **Want** object will be handled. By default, a number is passed in.<br>For example, **wantConstant.Flags.FLAG_ABILITY_CONTINUATION** specifies whether to start the ability in cross-device migration scenarios.| | [flags](js-apis-ability-wantConstant.md#wantconstantflags) | number | No| How the **Want** object will be handled. By default, a number is passed in.<br>For example, **wantConstant.Flags.FLAG_ABILITY_CONTINUATION** specifies whether to start the ability in cross-device migration scenarios.|
**Example** **Example**
- Basic usage (called in a UIAbility object, where context in the example is the context object of the UIAbility). - Basic usage: called in a UIAbility object, as shown in the example below. For details about how to obtain the context, see [Obtaining the Context of UIAbility](../../application-models/uiability-usage.md#obtaining-the-context-of-uiability).
```ts ```ts
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "FuncAbility", 'abilityName': 'FuncAbility',
"moduleName": "entry" // moduleName is optional. 'moduleName': 'entry' // moduleName is optional.
}; };
this.context.startAbility(want, (error) => {
this.context.startAbility(want, (err) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability. // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code) console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
}) });
``` ```
- Data is transferred through user-defined fields. The following data types are supported (called in a UIAbility object, where context in the example is the context object of the UIAbility): - Data is transferred through user-defined fields. The following data types are supported (called in a UIAbility object, as shown in the example below. For details about how to obtain the context, see [Obtaining the Context of UIAbility](../../application-models/uiability-usage.md#obtaining-the-context-of-uiability).)
* String * String
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "FuncAbility", abilityName: 'FuncAbility',
parameters: { parameters: {
keyForString: "str", keyForString: 'str',
}, },
} };
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
``` ```
* Number * Number
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "FuncAbility", abilityName: 'FuncAbility',
parameters: { parameters: {
keyForInt: 100, keyForInt: 100,
keyForDouble: 99.99, keyForDouble: 99.99,
}, },
} };
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
``` ```
* Boolean * Boolean
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "FuncAbility", abilityName: 'FuncAbility',
parameters: { parameters: {
keyForBool: true, keyForBool: true,
}, },
} };
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
``` ```
* Object * Object
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "FuncAbility", abilityName: 'FuncAbility',
parameters: { parameters: {
keyForObject: { keyForObject: {
keyForObjectString: "str", keyForObjectString: 'str',
keyForObjectInt: -200, keyForObjectInt: -200,
keyForObjectDouble: 35.5, keyForObjectDouble: 35.5,
keyForObjectBool: false, keyForObjectBool: false,
}, },
}, },
} };
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
``` ```
* Array * Array
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "FuncAbility", abilityName: 'FuncAbility',
parameters: { parameters: {
keyForArrayString: ["str1", "str2", "str3"], keyForArrayString: ['str1', 'str2', 'str3'],
keyForArrayInt: [100, 200, 300, 400], keyForArrayInt: [100, 200, 300, 400],
keyForArrayDouble: [0.1, 0.2], keyForArrayDouble: [0.1, 0.2],
keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}], keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }],
}, },
} };
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
``` ```
* File descriptor (FD) * File descriptor (FD)
```ts ```ts
import fileio from '@ohos.fileio'; import fileio from '@ohos.fileio';
let fd; let fd;
try { try {
fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); fd = fileio.openSync('/data/storage/el2/base/haps/pic.png');
} catch(e) { } catch(e) {
console.log("openSync fail:" + JSON.stringify(e)); console.log('openSync fail: ${JSON.stringify(e)}');
} }
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "FuncAbility", 'abilityName': 'FuncAbility',
"moduleName": "entry", // moduleName is optional. 'moduleName': 'entry', // moduleName is optional.
"parameters": { 'parameters': {
"keyFd":{"type":"FD", "value":fd} 'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd} is a fixed usage, indicating that the data is a file descriptor.
} }
}; };
this.context.startAbility(want, (error) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code)
})
```
- For more details and examples, see [Want](../../application-models/want-overview.md).
this.context.startAbility(want, (err) => {
console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
});
```
...@@ -16,7 +16,7 @@ import WantAgent from '@ohos.app.ability.wantAgent'; ...@@ -16,7 +16,7 @@ import WantAgent from '@ohos.app.ability.wantAgent';
getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void
Obtains a **WantAgent** object. This API uses an asynchronous callback to return the result. Obtains a **WantAgent** object. This API uses an asynchronous callback to return the result. If the creation fails, a null **WantAgent** object is returned.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -85,20 +85,20 @@ let wantAgentInfo = { ...@@ -85,20 +85,20 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(err)); console.error('getWantAgent failed, error: ${JSON.stringify(err)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.error('getWantAgent failed, error: ${JSON.stringify(err)}');
} }
``` ```
...@@ -108,7 +108,7 @@ try { ...@@ -108,7 +108,7 @@ try {
getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
Obtains a **WantAgent** object. This API uses a promise to return the result. Obtains a **WantAgent** object. This API uses a promise to return the result. If the creation fails, a null **WantAgent** object is returned.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -180,16 +180,16 @@ let wantAgentInfo = { ...@@ -180,16 +180,16 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
try { try {
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
wantAgent = data; wantAgent = data;
}).catch((err) => { }).catch((err) => {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}); });
} catch (err) { } catch (err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -268,33 +268,33 @@ let wantAgentInfo = { ...@@ -268,33 +268,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getBundleName callback // getBundleName callback
function getBundleNameCallback(err, data) { function getBundleNameCallback(err, data) {
if(err) { if(err) {
console.info('getBundleName failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getBundleName failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('getBundleName ok!' + JSON.stringify(data)); console.info('getBundleName ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.getBundleName(wantAgent, getBundleNameCallback); WantAgent.getBundleName(wantAgent, getBundleNameCallback);
} catch(err) { } catch(err) {
console.info('getBundleName failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getBundleName failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -378,29 +378,29 @@ let wantAgentInfo = { ...@@ -378,29 +378,29 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.getBundleName(wantAgent).then((data)=>{ WantAgent.getBundleName(wantAgent).then((data)=>{
console.info('getBundleName ok!' + JSON.stringify(data)); console.info('getBundleName ok! ${JSON.stringify(data)}');
}).catch((err)=>{ }).catch((err)=>{
console.info('getBundleName failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getBundleName failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) });
} catch(err){ } catch(err){
console.info('getBundleName failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getBundleName failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -480,33 +480,33 @@ let wantAgentInfo = { ...@@ -480,33 +480,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(err)); console.info('getWantAgent failed ${JSON.stringify(err)}');
} }
// getUid callback // getUid callback
function getUidCallback(err, data) { function getUidCallback(err, data) {
if(err) { if(err) {
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('getUid ok!' + JSON.stringify(data)); console.info('getUid ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.getUid(wantAgent, getUidCallback); WantAgent.getUid(wantAgent, getUidCallback);
} catch(err) { } catch(err) {
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -590,29 +590,29 @@ let wantAgentInfo = { ...@@ -590,29 +590,29 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.getUid(wantAgent).then((data)=>{ WantAgent.getUid(wantAgent).then((data)=>{
console.info('getUid ok!' + JSON.stringify(data)); console.info('getUid ok! ${JSON.stringify(data)}');
}).catch((err)=>{ }).catch((err)=>{
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) });
} catch(err){ } catch(err){
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -692,33 +692,33 @@ let wantAgentInfo = { ...@@ -692,33 +692,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getUid callback // getWant callback
function getWantCallback(err, data) { function getWantCallback(err, data) {
if(err) { if(err) {
console.info('getWant failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWant failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('getWant ok!' + JSON.stringify(data)); console.info('getWant ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.getWant(wantAgent, getBundleNameCallback); WantAgent.getWant(wantAgent, getWantCallback);
} catch(err) { } catch(err) {
console.info('getWant failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWant failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -804,29 +804,29 @@ let wantAgentInfo = { ...@@ -804,29 +804,29 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.getUid(wantAgent).then((data)=>{ WantAgent.getUid(wantAgent).then((data)=>{
console.info('getUid ok!' + JSON.stringify(data)); console.info('getUid ok! ${JSON.stringify(data)}');
}).catch((err)=>{ }).catch((err)=>{
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) });
} catch(err){ } catch(err){
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -905,33 +905,33 @@ let wantAgentInfo = { ...@@ -905,33 +905,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getUid callback // cancel callback
function cancelCallback(err, data) { function cancelCallback(err, data) {
if(err) { if(err) {
console.info('cancel failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('cancel failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('cancel ok!'); console.info('cancel ok!');
} }
} }
try { try {
WantAgent.cancel(wantAgent, getBundleNameCallback); WantAgent.cancel(wantAgent, cancelCallback);
} catch(err) { } catch(err) {
console.info('cancel failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('cancel failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1015,29 +1015,29 @@ let wantAgentInfo = { ...@@ -1015,29 +1015,29 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.cancel(wantAgent).then((data)=>{ WantAgent.cancel(wantAgent).then((data)=>{
console.info('cancel ok!'); console.info('cancel ok!');
}).catch((err)=>{ }).catch((err)=>{
console.info('cancel failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('cancel failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) });
} catch(err){ } catch(err){
console.info('cancel failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('cancel failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1092,7 +1092,7 @@ let wantAgent; ...@@ -1092,7 +1092,7 @@ let wantAgent;
// triggerInfo // triggerInfo
let triggerInfo = { let triggerInfo = {
code: 0 // Custom result code. code: 0 // Custom result code.
} };
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
...@@ -1119,33 +1119,33 @@ let wantAgentInfo = { ...@@ -1119,33 +1119,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getUid callback // trigger callback
function triggerCallback(err, data) { function triggerCallback(err, data) {
if(err) { if(err) {
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('getUid ok!' + JSON.stringify(data)); console.info('getUid ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback); WantAgent.trigger(wantAgent, triggerInfo, triggerCallback);
} catch(err) { } catch(err) {
console.info('getUid failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getUid failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1164,7 +1164,7 @@ Checks whether two **WantAgent** objects are equal to determine whether the same ...@@ -1164,7 +1164,7 @@ Checks whether two **WantAgent** objects are equal to determine whether the same
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------ | ---- | --------------------------------------- | | ---------- | ------------------------ | ---- | --------------------------------------- |
| agent | WantAgent | Yes | The first **WantAgent** object. | | agent | WantAgent | Yes | The first **WantAgent** object. |
| otherAgent | WantAgent | Yes | The second **WantAgent** object. | | otherAgent | WantAgent | Yes | Target **WantAgent** object. |
| callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
...@@ -1226,7 +1226,7 @@ let wantAgentInfo = { ...@@ -1226,7 +1226,7 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
...@@ -1234,26 +1234,26 @@ function getWantAgentCallback(err, data) { ...@@ -1234,26 +1234,26 @@ function getWantAgentCallback(err, data) {
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getUid callback // equal callback
function equalCallback(err, data) { function equalCallback(err, data) {
if(err) { if(err) {
console.info('equal failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('equal failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('equal ok!' + JSON.stringify(data)); console.info('equal ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.equal(wantAgent1,wantAgent2,equalCallback); WantAgent.equal(wantAgent1,wantAgent2,equalCallback);
} catch(err) { } catch(err) {
console.info('equal failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('equal failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1272,7 +1272,7 @@ Checks whether two **WantAgent** objects are equal to determine whether the same ...@@ -1272,7 +1272,7 @@ Checks whether two **WantAgent** objects are equal to determine whether the same
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | --------- | ---- | ------------- | | ---------- | --------- | ---- | ------------- |
| agent | WantAgent | Yes | The first **WantAgent** object.| | agent | WantAgent | Yes | The first **WantAgent** object.|
| otherAgent | WantAgent | Yes | The second **WantAgent** object.| | otherAgent | WantAgent | Yes | Target **WantAgent** object.|
**Return value** **Return value**
...@@ -1339,7 +1339,7 @@ let wantAgentInfo = { ...@@ -1339,7 +1339,7 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
...@@ -1347,22 +1347,22 @@ function getWantAgentCallback(err, data) { ...@@ -1347,22 +1347,22 @@ function getWantAgentCallback(err, data) {
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.equal(wantAgent1,wantAgent2).then((data)=>{ WantAgent.equal(wantAgent1,wantAgent2).then((data)=>{
console.info('equal ok!' + JSON.stringify(data)); console.info('equal ok! ${JSON.stringify(data)}');
}).catch((err)=>{ }).catch((err)=>{
console.info('equal failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('equal failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) })
} catch(err){ } catch(err){
console.info('equal failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('equal failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1439,33 +1439,33 @@ let wantAgentInfo = { ...@@ -1439,33 +1439,33 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed' + JSON.stringify(wantAgent)); console.info('getWantAgent failed ${JSON.stringify(wantAgent)}');
} }
// getUid callback // getOperationTypeCallback callback
function getOperationTypeCallback(err, data) { function getOperationTypeCallback(err, data) {
if(err) { if(err) {
console.info('getOperationType failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getOperationType failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} else { } else {
console.info('getOperationType ok!' + JSON.stringify(data)); console.info('getOperationType ok! ${JSON.stringify(data)}');
} }
} }
try { try {
WantAgent.getOperationTypeCallback(wantAgent, getBundleNameCallback); WantAgent.getOperationTypeCallback(wantAgent, getOperationTypeCallback);
} catch(err) { } catch(err) {
console.info('getOperationTypeCallback failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getOperationTypeCallback failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1547,29 +1547,29 @@ let wantAgentInfo = { ...@@ -1547,29 +1547,29 @@ let wantAgentInfo = {
operationType: WantAgent.OperationType.START_ABILITIES, operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} };
// getWantAgent callback // getWantAgent callback
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
if (err === undefined) { if (err === undefined) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('getWantAgent failed!' + JSON.stringify(wantAgent)); console.info('getWantAgent failed! ${JSON.stringify(wantAgent)}');
} }
try { try {
WantAgent.getOperationType(wantAgent).then((data)=>{ WantAgent.getOperationType(wantAgent).then((data)=>{
console.info('getOperationType ok!' + JSON.stringify(data)); console.info('getOperationType ok! ${JSON.stringify(data)}');
}).catch((err)=>{ }).catch((err)=>{
console.info('getOperationType failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getOperationType failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
}) });
} catch(err){ } catch(err){
console.info('getOperationType failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getOperationType failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
} }
try { try {
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
} catch(err) { } catch(err) {
console.info('getWantAgent failed!' + JSON.stringify(err.code) + JSON.stringify(err.message)); console.info('getWantAgent failed! ${JSON.stringify(err.code)} ${JSON.stringify(err.message)}');
} }
``` ```
...@@ -1615,5 +1615,5 @@ try { ...@@ -1615,5 +1615,5 @@ try {
| info | WantAgent | Yes | A triggered **WantAgent** object. | | info | WantAgent | Yes | A triggered **WantAgent** object. |
| want | Want | Yes | An existing triggered **want**. | | want | Want | Yes | An existing triggered **want**. |
| finalCode | number | Yes | Request code that triggers the **WantAgent** object.| | finalCode | number | Yes | Request code that triggers the **WantAgent** object.|
| finalData | string | No | Final data collected by the common event. | | finalData | string | Yes | Final data collected by the common event. |
| extraInfo | {[key: string]: any} | No | Extra information. | | extraInfo | {[key: string]: any} | No | Extra information. |
...@@ -8,65 +8,21 @@ The **wantConstant** module provides the actions, entities, and flags used in ** ...@@ -8,65 +8,21 @@ The **wantConstant** module provides the actions, entities, and flags used in **
## Modules to Import ## Modules to Import
```js ```ts
import wantConstant from '@ohos.app.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
``` ```
## wantConstant.Action ## wantConstant.Params
Enumerates the action constants of the **Want** object. **action** specifies the operation to execute. Defines **Params** (specifying the action that can be performed) in the Want.
**System capability**: SystemCapability.Ability.AbilityBase
| Name | Value | Description |
| ------------ | ------------------ | ---------------------- |
| ACTION_HOME | ohos.want.action.home | Action of returning to the home page. |
| ACTION_DIAL | ohos.want.action.dial | Action of launching the numeric keypad. |
| ACTION_SEARCH | ohos.want.action.search | Action of launching the search function. |
| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | Action of launching the UI that provides wireless network settings, for example, Wi-Fi options. |
| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | Action of launching the UI for managing installed applications. |
| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | Action of launching the UI that displays the details of an application. |
| ACTION_SET_ALARM | ohos.want.action.setAlarm | Action of launching the UI for setting the alarm clock. |
| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | Action of launching the UI that displays all alarms. |
| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | Action of launching the UI for snoozing an alarm. |
| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | Action of launching the UI for deleting an alarm. |
| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | Action of launching the UI for dismissing a timer. |
| ACTION_SEND_SMS | ohos.want.action.sendSms | Action of launching the UI for sending an SMS message. |
| ACTION_CHOOSE | ohos.want.action.choose | Action of launching the UI for opening a contact or picture. |
| ACTION_IMAGE_CAPTURE | ohos.want.action.imageCapture | Action of launching the UI for photographing. |
| ACTION_VIDEO_CAPTURE | ohos.want.action.videoCapture | Action of launching the UI for shooting a video. |
| ACTION_SELECT | ohos.want.action.select | Action of launching the UI for application selection. |
| ACTION_SEND_DATA | ohos.want.action.sendData | Action of launching the UI for sending a single data record. |
| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | Action of launching the UI for sending multiple data records. |
| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | Action of requesting a media scanner to scan a file and add the file to the media library. |
| ACTION_VIEW_DATA | ohos.want.action.viewData | Action of viewing data. |
| ACTION_EDIT_DATA | ohos.want.action.editData | Action of editing data. |
| INTENT_PARAMS_INTENT | ability.want.params.INTENT | Action of displaying selection options with an action selector. |
| INTENT_PARAMS_TITLE | ability.want.params.TITLE | Title of the character sequence dialog box used with the action selector. |
| ACTION_FILE_SELECT | ohos.action.fileSelect | Action of selecting a file. |
| PARAMS_STREAM | ability.params.stream | URI of the data stream associated with the target when the data is sent. |
| ACTION_APP_ACCOUNT_AUTH | account.appAccount.action.auth | Action of providing the authentication service. |
| ACTION_MARKET_DOWNLOAD | ohos.want.action.marketDownload | Action of downloading an application from the application market.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| ACTION_MARKET_CROWDTEST | ohos.want.action.marketCrowdTest | Action of crowdtesting an application from the application market.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| DLP_PARAMS_SANDBOX |ohos.dlp.params.sandbox | Action of obtaining the sandbox flag.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| DLP_PARAMS_BUNDLE_NAME |ohos.dlp.params.bundleName |Action of obtaining the DLP bundle name.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| DLP_PARAMS_MODULE_NAME |ohos.dlp.params.moduleName |Action of obtaining the DLP module name.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| DLP_PARAMS_ABILITY_NAME |ohos.dlp.params.abilityName |Action of obtaining the DLP ability name.<br>**System API**: This is a system API and cannot be called by third-party applications. |
| DLP_PARAMS_INDEX |ohos.dlp.params.index |Action of obtaining the DLP index.<br>**System API**: This is a system API and cannot be called by third-party applications. |
## wantConstant.Entity
Enumerates the entity constants of the **Want** object. **entity** specifies additional information of the target ability.
**System capability**: SystemCapability.Ability.AbilityBase
| Name | Value | Description | | Name | Value | Description |
| ------------ | ------------------ | ---------------------- | | ----------------------- | --------------------------- | ------------------------------------------------------------ |
| ENTITY_DEFAULT | entity.system.default | Default entity. The default entity is used if no entity is specified. | | DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | Action of obtaining the sandbox flag.<br>**System API**: This is a system API and cannot be called by third-party applications.|
| ENTITY_HOME | entity.system.home | Home screen entity. | | DLP_PARAMS_BUNDLE_NAME | ohos.dlp.params.bundleName | Action of obtaining the DLP bundle name.<br>**System API**: This is a system API and cannot be called by third-party applications.|
| ENTITY_VOICE | entity.system.voice | Voice interaction entity. | | DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | Action of obtaining the DLP module name.<br>**System API**: This is a system API and cannot be called by third-party applications.|
| ENTITY_BROWSABLE | entity.system.browsable | Browser type entity. | | DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | Action of obtaining the DLP ability name.<br>**System API**: This is a system API and cannot be called by third-party applications.|
| ENTITY_VIDEO | entity.system.video | Video type entity. | | DLP_PARAMS_INDEX | ohos.dlp.params.index | Action of obtaining the DLP index.<br>**System API**: This is a system API and cannot be called by third-party applications.|
## wantConstant.Flags ## wantConstant.Flags
......
...@@ -35,7 +35,7 @@ Creates a **FormBindingData** object. ...@@ -35,7 +35,7 @@ Creates a **FormBindingData** object.
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | -------------- | ---- | ------------------------------------------------------------ | | ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object\|string | No | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. The image data is identified by "formImages", and the content is multiple key-value pairs, each of which consists of an image identifier and image file descriptor. The final format is {"formImages": {"key1": fd1, "key2": fd2}}.| | obj | Object\|string | No | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. The image data is identified by **'formImages'**, and the content is multiple key-value pairs, each of which consists of an image identifier and image file descriptor. The final format is {'formImages': {'key1': fd1, 'key2': fd2}}.|
**Return value** **Return value**
...@@ -48,14 +48,14 @@ Creates a **FormBindingData** object. ...@@ -48,14 +48,14 @@ Creates a **FormBindingData** object.
**Example** **Example**
```ts ```ts
import fs from '@ohos.file.fs';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import fs from '@ohos.file.fs';
try { try {
let fd = fs.openSync('/path/to/form.png') let fd = fs.openSync('/path/to/form.png');
let obj = { let obj = {
"temperature": "21°", 'temperature': '21°',
"formImages": { "image": fd } 'formImages': { 'image': fd }
}; };
formBindingData.createFormBindingData(obj); formBindingData.createFormBindingData(obj);
} catch (error) { } catch (error) {
......
...@@ -43,7 +43,7 @@ Deletes a widget. After this API is called, the application can no longer use th ...@@ -43,7 +43,7 @@ Deletes a widget. After this API is called, the application can no longer use th
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.deleteForm(formId, (error) => { formHost.deleteForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -92,7 +92,7 @@ Deletes a widget. After this API is called, the application can no longer use th ...@@ -92,7 +92,7 @@ Deletes a widget. After this API is called, the application can no longer use th
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.deleteForm(formId).then(() => { formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success'); console.log('formHost deleteForm success');
}).catch((error) => { }).catch((error) => {
...@@ -133,7 +133,7 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -133,7 +133,7 @@ Releases a widget. After this API is called, the application can no longer use t
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, (error) => { formHost.releaseForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -175,7 +175,7 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -175,7 +175,7 @@ Releases a widget. After this API is called, the application can no longer use t
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, true, (error) => { formHost.releaseForm(formId, true, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -222,7 +222,7 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -222,7 +222,7 @@ Releases a widget. After this API is called, the application can no longer use t
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, true).then(() => { formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
}).catch((error) => { }).catch((error) => {
...@@ -263,7 +263,7 @@ Requests a widget update. This API uses an asynchronous callback to return the r ...@@ -263,7 +263,7 @@ Requests a widget update. This API uses an asynchronous callback to return the r
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.requestForm(formId, (error) => { formHost.requestForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -309,7 +309,7 @@ Requests a widget update. This API uses a promise to return the result. ...@@ -309,7 +309,7 @@ Requests a widget update. This API uses a promise to return the result.
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.requestForm(formId).then(() => { formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success'); console.log('formHost requestForm success');
}).catch((error) => { }).catch((error) => {
...@@ -351,7 +351,7 @@ Converts a temporary widget to a normal one. This API uses an asynchronous callb ...@@ -351,7 +351,7 @@ Converts a temporary widget to a normal one. This API uses an asynchronous callb
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.castToNormalForm(formId, (error) => { formHost.castToNormalForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -397,7 +397,7 @@ Converts a temporary widget to a normal one. This API uses a promise to return t ...@@ -397,7 +397,7 @@ Converts a temporary widget to a normal one. This API uses a promise to return t
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.castToNormalForm(formId).then(() => { formHost.castToNormalForm(formId).then(() => {
console.log('formHost castTempForm success'); console.log('formHost castTempForm success');
}).catch((error) => { }).catch((error) => {
...@@ -438,7 +438,7 @@ Instructs the widget framework to make a widget visible. After this API is calle ...@@ -438,7 +438,7 @@ Instructs the widget framework to make a widget visible. After this API is calle
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error) => { formHost.notifyVisibleForms(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -484,7 +484,7 @@ Instructs the widget framework to make a widget visible. After this API is calle ...@@ -484,7 +484,7 @@ Instructs the widget framework to make a widget visible. After this API is calle
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId).then(() => { formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success'); console.log('formHost notifyVisibleForms success');
}).catch((error) => { }).catch((error) => {
...@@ -525,7 +525,7 @@ Instructs the widget framework to make a widget invisible. After this API is cal ...@@ -525,7 +525,7 @@ Instructs the widget framework to make a widget invisible. After this API is cal
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error) => { formHost.notifyInvisibleForms(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -571,7 +571,7 @@ Instructs the widget framework to make a widget invisible. After this API is cal ...@@ -571,7 +571,7 @@ Instructs the widget framework to make a widget invisible. After this API is cal
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId).then(() => { formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success'); console.log('formHost notifyInvisibleForms success');
}).catch((error) => { }).catch((error) => {
...@@ -612,7 +612,7 @@ Instructs the widget framework to make a widget updatable. After this API is cal ...@@ -612,7 +612,7 @@ Instructs the widget framework to make a widget updatable. After this API is cal
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error) => { formHost.enableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -658,7 +658,7 @@ Instructs the widget framework to make a widget updatable. After this API is cal ...@@ -658,7 +658,7 @@ Instructs the widget framework to make a widget updatable. After this API is cal
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId).then(() => { formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success'); console.log('formHost enableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
...@@ -699,7 +699,7 @@ Instructs the widget framework to make a widget not updatable. After this API is ...@@ -699,7 +699,7 @@ Instructs the widget framework to make a widget not updatable. After this API is
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error) => { formHost.disableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
...@@ -745,7 +745,7 @@ Instructs the widget framework to make a widget not updatable. After this API is ...@@ -745,7 +745,7 @@ Instructs the widget framework to make a widget not updatable. After this API is
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId).then(() => { formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success'); console.log('formHost disableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
...@@ -842,7 +842,7 @@ try { ...@@ -842,7 +842,7 @@ try {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
} catch(error) { } catch(error) {
...@@ -873,7 +873,7 @@ import formHost from '@ohos.app.form.formHost'; ...@@ -873,7 +873,7 @@ import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getAllFormsInfo().then((data) => { formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
...@@ -912,11 +912,11 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -912,11 +912,11 @@ Obtains the widget information provided by a given application on the device. Th
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
} catch(error) { } catch(error) {
...@@ -955,11 +955,11 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -955,11 +955,11 @@ Obtains the widget information provided by a given application on the device. Th
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
} catch(error) { } catch(error) {
...@@ -1003,8 +1003,8 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -1003,8 +1003,8 @@ Obtains the widget information provided by a given application on the device. Th
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
...@@ -1036,12 +1036,12 @@ Deletes invalid widgets from the list. This API uses an asynchronous callback to ...@@ -1036,12 +1036,12 @@ Deletes invalid widgets from the list. This API uses an asynchronous callback to
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
} }
}); });
} catch(error) { } catch(error) {
...@@ -1077,9 +1077,9 @@ Deletes invalid widgets from the list. This API uses a promise to return the res ...@@ -1077,9 +1077,9 @@ Deletes invalid widgets from the list. This API uses a promise to return the res
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
try { try {
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data) => { formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
...@@ -1118,13 +1118,13 @@ Obtains the widget state. This API uses an asynchronous callback to return the r ...@@ -1118,13 +1118,13 @@ Obtains the widget state. This API uses an asynchronous callback to return the r
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let want = { let want = {
"deviceId": "", 'deviceId': '',
"bundleName": "ohos.samples.FormApplication", 'bundleName': 'ohos.samples.FormApplication',
"abilityName": "FormAbility", 'abilityName': 'FormAbility',
"parameters": { 'parameters': {
"ohos.extra.param.key.module_name": "entry", 'ohos.extra.param.key.module_name': 'entry',
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.form_dimension": 2 'ohos.extra.param.key.form_dimension': 2
} }
}; };
try { try {
...@@ -1132,7 +1132,7 @@ try { ...@@ -1132,7 +1132,7 @@ try {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
} }
}); });
} catch(error) { } catch(error) {
...@@ -1175,18 +1175,18 @@ Obtains the widget state. This API uses a promise to return the result. ...@@ -1175,18 +1175,18 @@ Obtains the widget state. This API uses a promise to return the result.
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let want = { let want = {
"deviceId": "", 'deviceId': '',
"bundleName": "ohos.samples.FormApplication", 'bundleName': 'ohos.samples.FormApplication',
"abilityName": "FormAbility", 'abilityName': 'FormAbility',
"parameters": { 'parameters': {
"ohos.extra.param.key.module_name": "entry", 'ohos.extra.param.key.module_name': 'entry',
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.form_dimension": 2 'ohos.extra.param.key.form_dimension': 2
} }
}; };
try { try {
formHost.acquireFormState(want).then((data) => { formHost.acquireFormState(want).then((data) => {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message}`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
...@@ -1195,9 +1195,9 @@ try { ...@@ -1195,9 +1195,9 @@ try {
} }
``` ```
## on("formUninstall") ## on('formUninstall')
on(type: "formUninstall", callback: Callback&lt;string&gt;): void on(type: 'formUninstall', callback: Callback&lt;string&gt;): void
Subscribes to widget uninstall events. This API uses an asynchronous callback to return the result. Subscribes to widget uninstall events. This API uses an asynchronous callback to return the result.
...@@ -1207,7 +1207,7 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to ...@@ -1207,7 +1207,7 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| type | string | Yes | Event type. The value **formUninstall** indicates a widget uninstallation event.| | type | string | Yes | Event type. The value **'formUninstall'** indicates a widget uninstallation event.|
| callback | Callback&lt;string&gt; | Yes| Callback used to return the widget ID.| | callback | Callback&lt;string&gt; | Yes| Callback used to return the widget ID.|
**Example** **Example**
...@@ -1216,14 +1216,14 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to ...@@ -1216,14 +1216,14 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId: ${formId}');
} }
formHost.on("formUninstall", callback); formHost.on('formUninstall', callback);
``` ```
## off("formUninstall") ## off('formUninstall')
off(type: "formUninstall", callback?: Callback&lt;string&gt;): void off(type: 'formUninstall', callback?: Callback&lt;string&gt;): void
Unsubscribes from widget uninstall events. This API uses an asynchronous callback to return the result. Unsubscribes from widget uninstall events. This API uses an asynchronous callback to return the result.
...@@ -1233,8 +1233,8 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac ...@@ -1233,8 +1233,8 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| type | string | Yes | Event type. The value **formUninstall** indicates a widget uninstallation event.| | type | string | Yes | Event type. The value **'formUninstall'** indicates a widget uninstallation event.|
| callback | Callback&lt;string&gt; | No| Callback used to return the widget ID. If it is left unspecified, it indicates the callback for all the events that have been subscribed.<br> The value must be the same as that in **on("formUninstall")**.| | callback | Callback&lt;string&gt; | No| Callback used to return the widget ID. If it is left unspecified, it indicates the callback for all the events that have been subscribed.<br> The value must be the same as that in **on('formUninstall')**.|
**Example** **Example**
...@@ -1242,9 +1242,9 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac ...@@ -1242,9 +1242,9 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId: ${formId}');
} }
formHost.off("formUninstall", callback); formHost.off('formUninstall', callback);
``` ```
## notifyFormsVisible ## notifyFormsVisible
...@@ -1277,7 +1277,7 @@ Instructs the widgets to make themselves visible. This API uses an asynchronous ...@@ -1277,7 +1277,7 @@ Instructs the widgets to make themselves visible. This API uses an asynchronous
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsVisible(formIds, true, (error) => { formHost.notifyFormsVisible(formIds, true, (error) => {
if (error) { if (error) {
...@@ -1324,7 +1324,7 @@ Instructs the widgets to make themselves visible. This API uses a promise to ret ...@@ -1324,7 +1324,7 @@ Instructs the widgets to make themselves visible. This API uses a promise to ret
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsVisible(formIds, true).then(() => { formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success'); console.log('formHost notifyFormsVisible success');
...@@ -1366,7 +1366,7 @@ Instructs the widgets to enable or disable updates. This API uses an asynchronou ...@@ -1366,7 +1366,7 @@ Instructs the widgets to enable or disable updates. This API uses an asynchronou
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsEnableUpdate(formIds, true, (error) => { formHost.notifyFormsEnableUpdate(formIds, true, (error) => {
if (error) { if (error) {
...@@ -1413,7 +1413,7 @@ Instructs the widgets to enable or disable updates. This API uses a promise to r ...@@ -1413,7 +1413,7 @@ Instructs the widgets to enable or disable updates. This API uses a promise to r
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsEnableUpdate(formIds, true).then(() => { formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success'); console.log('formHost notifyFormsEnableUpdate success');
...@@ -1454,8 +1454,8 @@ Shares a specified widget with a remote device. This API uses an asynchronous ca ...@@ -1454,8 +1454,8 @@ Shares a specified widget with a remote device. This API uses an asynchronous ca
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
try { try {
formHost.shareForm(formId, deviceId, (error) => { formHost.shareForm(formId, deviceId, (error) => {
if (error) { if (error) {
...@@ -1502,8 +1502,8 @@ Shares a specified widget with a remote device. This API uses a promise to retur ...@@ -1502,8 +1502,8 @@ Shares a specified widget with a remote device. This API uses a promise to retur
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
try { try {
formHost.shareForm(formId, deviceId).then(() => { formHost.shareForm(formId, deviceId).then(() => {
console.log('formHost shareForm success'); console.log('formHost shareForm success');
...@@ -1545,7 +1545,7 @@ Notifies that the privacy protection status of the specified widgets changes. Th ...@@ -1545,7 +1545,7 @@ Notifies that the privacy protection status of the specified widgets changes. Th
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true, (error) => { formHost.notifyFormsPrivacyProtected(formIds, true, (error) => {
if (error) { if (error) {
...@@ -1590,7 +1590,7 @@ Notifies that the privacy protection status of the specified widgets changes. Th ...@@ -1590,7 +1590,7 @@ Notifies that the privacy protection status of the specified widgets changes. Th
```ts ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost notifyFormsPrivacyProtected success'); console.log('formHost notifyFormsPrivacyProtected success');
......
...@@ -31,7 +31,6 @@ Describes widget information. ...@@ -31,7 +31,6 @@ Describes widget information.
| isDefault | boolean | Yes | No | Whether the widget is the default one. | | isDefault | boolean | Yes | No | Whether the widget is the default one. |
| updateEnabled | boolean | Yes | No | Whether the widget is updatable. | | updateEnabled | boolean | Yes | No | Whether the widget is updatable. |
| formVisibleNotify | boolean | Yes | No | Whether to send a notification when the widget is visible. | | formVisibleNotify | boolean | Yes | No | Whether to send a notification when the widget is visible. |
| relatedBundleName | string | Yes | No | Name of the associated bundle to which the widget belongs. |
| scheduledUpdateTime | string | Yes | No | Time when the widget was updated. | | scheduledUpdateTime | string | Yes | No | Time when the widget was updated. |
| formConfigAbility | string | Yes | No | Configuration ability of the widget, that is, the ability corresponding to the option in the selection box displayed when the widget is long pressed. | | formConfigAbility | string | Yes | No | Configuration ability of the widget, that is, the ability corresponding to the option in the selection box displayed when the widget is long pressed. |
| updateDuration | number | Yes | No | Update period of the widget.| | updateDuration | number | Yes | No | Update period of the widget.|
...@@ -93,16 +92,16 @@ Enumerates the widget parameters. ...@@ -93,16 +92,16 @@ Enumerates the widget parameters.
| Name | Value | Description | | Name | Value | Description |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | Widget ID. | | IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | Widget ID. |
| DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | Widget dimension. | | DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | Widget dimension. |
| NAME_KEY | "ohos.extra.param.key.form_name" | Widget name. | | NAME_KEY | 'ohos.extra.param.key.form_name' | Widget name. |
| MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | Name of the module to which the widget belongs. | | MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | Name of the module to which the widget belongs. |
| WIDTH_KEY | "ohos.extra.param.key.form_width" | Widget width. | | WIDTH_KEY | 'ohos.extra.param.key.form_width' | Widget width. |
| HEIGHT_KEY | "ohos.extra.param.key.form_height" | Widget height. | | HEIGHT_KEY | 'ohos.extra.param.key.form_height' | Widget height. |
| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | Temporary widget. | | TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | Temporary widget. |
| ABILITY_NAME_KEY | "ohos.extra.param.key.ability_name" | Ability name. | | ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | Ability name. |
| DEVICE_ID_KEY | "ohos.extra.param.key.device_id" | Device ID. | | DEVICE_ID_KEY | 'ohos.extra.param.key.device_id' | Device ID. |
| BUNDLE_NAME_KEY | "ohos.extra.param.key.bundle_name" | Key that specifies the target bundle name.| | BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | Key that specifies the target bundle name.|
## FormDimension ## FormDimension
......
...@@ -39,7 +39,7 @@ Sets the next refresh time for a widget. This API uses an asynchronous callback ...@@ -39,7 +39,7 @@ Sets the next refresh time for a widget. This API uses an asynchronous callback
```ts ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
try { try {
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error) { if (error) {
...@@ -86,7 +86,7 @@ Sets the next refresh time for a widget. This API uses a promise to return the r ...@@ -86,7 +86,7 @@ Sets the next refresh time for a widget. This API uses a promise to return the r
```ts ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
try { try {
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log(`formProvider setFormNextRefreshTime success`); console.log(`formProvider setFormNextRefreshTime success`);
...@@ -127,9 +127,9 @@ Updates a widget. This API uses an asynchronous callback to return the result. ...@@ -127,9 +127,9 @@ Updates a widget. This API uses an asynchronous callback to return the result.
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
try { try {
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
formProvider.updateForm(formId, obj, (error, data) => { formProvider.updateForm(formId, obj, (error, data) => {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
...@@ -176,8 +176,8 @@ Updates a widget. This API uses a promise to return the result. ...@@ -176,8 +176,8 @@ Updates a widget. This API uses a promise to return the result.
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({ temperature: "22c", time: "22:00" }); let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' });
try { try {
formProvider.updateForm(formId, obj).then(() => { formProvider.updateForm(formId, obj).then(() => {
console.log(`formProvider updateForm success`); console.log(`formProvider updateForm success`);
...@@ -221,7 +221,7 @@ try { ...@@ -221,7 +221,7 @@ try {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider getFormsInfo, data: ' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
} catch (error) { } catch (error) {
...@@ -258,14 +258,14 @@ import formProvider from '@ohos.app.form.formProvider'; ...@@ -258,14 +258,14 @@ import formProvider from '@ohos.app.form.formProvider';
const filter: formInfo.FormInfoFilter = { const filter: formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName: "entry" moduleName: 'entry'
}; };
try { try {
formProvider.getFormsInfo(filter, (error, data) => { formProvider.getFormsInfo(filter, (error, data) => {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider getFormsInfo, data: ' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
} catch (error) { } catch (error) {
...@@ -308,11 +308,11 @@ import formProvider from '@ohos.app.form.formProvider'; ...@@ -308,11 +308,11 @@ import formProvider from '@ohos.app.form.formProvider';
const filter: formInfo.FormInfoFilter = { const filter: formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName: "entry" moduleName: 'entry'
}; };
try { try {
formProvider.getFormsInfo(filter).then((data) => { formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`promise error, code: ${error.code}, message: ${error.message})`); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
...@@ -335,7 +335,7 @@ Requests to publish a widget carrying data to the widget host. This API uses an ...@@ -335,7 +335,7 @@ Requests to publish a widget carrying data to the widget host. This API uses an
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>'ohos.extra.param.key.form_dimension'<br>'ohos.extra.param.key.form_name'<br>'ohos.extra.param.key.module_name' |
| formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | Yes | Data used for creating the widget.| | formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | Yes | Data used for creating the widget.|
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the widget ID.| | callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the widget ID.|
...@@ -353,20 +353,20 @@ import formBindingData from '@ohos.app.form.formBindingData'; ...@@ -353,20 +353,20 @@ import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let want = { let want = {
abilityName: "FormAbility", abilityName: 'FormAbility',
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, 'ohos.extra.param.key.form_dimension': 2,
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.module_name": "entry" 'ohos.extra.param.key.module_name': 'entry'
} }
}; };
try { try {
let obj = formBindingData.createFormBindingData({ temperature: "22c", time: "22:00" }); let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' });
formProvider.requestPublishForm(want, obj, (error, data) => { formProvider.requestPublishForm(want, obj, (error, data) => {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
} }
}); });
} catch (error) { } catch (error) {
...@@ -388,7 +388,7 @@ Requests to publish a widget to the widget host. This API uses an asynchronous c ...@@ -388,7 +388,7 @@ Requests to publish a widget to the widget host. This API uses an asynchronous c
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>'ohos.extra.param.key.form_dimension'<br>'ohos.extra.param.key.form_name'<br>'ohos.extra.param.key.module_name' |
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the widget ID.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the widget ID.|
**Error codes** **Error codes**
...@@ -404,11 +404,11 @@ Requests to publish a widget to the widget host. This API uses an asynchronous c ...@@ -404,11 +404,11 @@ Requests to publish a widget to the widget host. This API uses an asynchronous c
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let want = { let want = {
abilityName: "FormAbility", abilityName: 'FormAbility',
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, 'ohos.extra.param.key.form_dimension': 2,
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.module_name": "entry" 'ohos.extra.param.key.module_name': 'entry'
} }
}; };
try { try {
...@@ -416,7 +416,7 @@ try { ...@@ -416,7 +416,7 @@ try {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
} }
}); });
} catch (error) { } catch (error) {
...@@ -438,7 +438,7 @@ Requests to publish a widget to the widget host. This API uses a promise to retu ...@@ -438,7 +438,7 @@ Requests to publish a widget to the widget host. This API uses a promise to retu
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>'ohos.extra.param.key.form_dimension'<br>'ohos.extra.param.key.form_name'<br>'ohos.extra.param.key.module_name' |
| formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | No | Data used for creating the widget. | | formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | No | Data used for creating the widget. |
**Return value** **Return value**
...@@ -460,16 +460,16 @@ Requests to publish a widget to the widget host. This API uses a promise to retu ...@@ -460,16 +460,16 @@ Requests to publish a widget to the widget host. This API uses a promise to retu
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let want = { let want = {
abilityName: "FormAbility", abilityName: 'FormAbility',
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, 'ohos.extra.param.key.form_dimension': 2,
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.module_name": "entry" 'ohos.extra.param.key.module_name': 'entry'
} }
}; };
try { try {
formProvider.requestPublishForm(want).then((data) => { formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`promise error, code: ${error.code}, message: ${error.message})`); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
...@@ -506,11 +506,11 @@ try { ...@@ -506,11 +506,11 @@ try {
} else { } else {
if (isSupported) { if (isSupported) {
var want = { var want = {
abilityName: "FormAbility", abilityName: 'FormAbility',
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, 'ohos.extra.param.key.form_dimension': 2,
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.module_name": "entry" 'ohos.extra.param.key.module_name': 'entry'
} }
}; };
try { try {
...@@ -518,7 +518,7 @@ try { ...@@ -518,7 +518,7 @@ try {
if (error) { if (error) {
console.log(`callback error, code: ${error.code}, message: ${error.message})`); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
} }
}); });
} catch (error) { } catch (error) {
...@@ -557,16 +557,16 @@ try { ...@@ -557,16 +557,16 @@ try {
formProvider.isRequestPublishFormSupported().then((isSupported) => { formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) { if (isSupported) {
var want = { var want = {
abilityName: "FormAbility", abilityName: 'FormAbility',
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, 'ohos.extra.param.key.form_dimension': 2,
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.module_name": "entry" 'ohos.extra.param.key.module_name': 'entry'
} }
}; };
try { try {
formProvider.requestPublishForm(want).then((data) => { formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.log(`promise error, code: ${error.code}, message: ${error.message})`); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
......
# @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry) # @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)
The **AbilityDelegatorRegistry** module provides APIs for storing the global registers of the registered **AbilityDelegator** and **AbilityDelegatorArgs** objects. You can use the APIs to obtain the **AbilityDelegator** and **AbilityDelegatorArgs** objects of an application. The **AbilityDelegatorRegistry** module provides APIs for storing the global registers of the registered **AbilityDelegator** and **AbilityDelegatorArgs** objects. You can use the APIs to obtain the **AbilityDelegator** and **AbilityDelegatorArgs** objects of an application. The APIs can be used only in the test framework.
> **NOTE** > **NOTE**
> >
...@@ -43,7 +43,7 @@ Obtains the **AbilityDelegator** object of the application. ...@@ -43,7 +43,7 @@ Obtains the **AbilityDelegator** object of the application.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
``` ```
...@@ -65,8 +65,8 @@ Obtains the **AbilityDelegatorArgs** object of the application. ...@@ -65,8 +65,8 @@ Obtains the **AbilityDelegatorArgs** object of the application.
**Example** **Example**
```ts ```ts
var args = AbilityDelegatorRegistry.getArguments(); let args = AbilityDelegatorRegistry.getArguments();
console.info("getArguments bundleName:" + args.bundleName); console.info('getArguments bundleName: ${args.bundleName}');
console.info("getArguments testCaseNames:" + args.testCaseNames); console.info('getArguments testCaseNames: ${args.testCaseNames}');
console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); console.info('getArguments testRunnerClassName: ${args.testRunnerClassName}');
``` ```
...@@ -49,13 +49,13 @@ Updates the configuration. This API uses an asynchronous callback to return the ...@@ -49,13 +49,13 @@ Updates the configuration. This API uses an asynchronous callback to return the
**Example** **Example**
```ts ```ts
var config = { let config = {
language: 'chinese' language: 'chinese'
} };
abilityManager.updateConfiguration(config, () => { abilityManager.updateConfiguration(config, () => {
console.log('------------ updateConfiguration -----------'); console.log('------------ updateConfiguration -----------');
}) });
``` ```
## updateConfiguration ## updateConfiguration
...@@ -83,15 +83,15 @@ Updates the configuration. This API uses a promise to return the result. ...@@ -83,15 +83,15 @@ Updates the configuration. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
var config = { let config = {
language: 'chinese' language: 'chinese'
} };
abilityManager.updateConfiguration(config).then(() => { abilityManager.updateConfiguration(config).then(() => {
console.log('updateConfiguration success'); console.log('updateConfiguration success');
}).catch((err) => { }).catch((err) => {
console.log('updateConfiguration fail'); console.log('updateConfiguration fail');
}) });
``` ```
## getAbilityRunningInfos ## getAbilityRunningInfos
...@@ -114,7 +114,7 @@ Obtains the ability running information. This API uses an asynchronous callback ...@@ -114,7 +114,7 @@ Obtains the ability running information. This API uses an asynchronous callback
```ts ```ts
abilityManager.getAbilityRunningInfos((err,data) => { abilityManager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); console.log('getAbilityRunningInfos err: ${err}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -138,115 +138,8 @@ Obtains the ability running information. This API uses a promise to return the r ...@@ -138,115 +138,8 @@ Obtains the ability running information. This API uses a promise to return the r
```ts ```ts
abilityManager.getAbilityRunningInfos().then((data) => { abilityManager.getAbilityRunningInfos().then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data)) console.log('getAbilityRunningInfos data: ${JSON.stringify(data)}');
}).catch((err) => { }).catch((err) => {
console.log("getAbilityRunningInfos err: " + err) console.log('getAbilityRunningInfos err: ${JSON.stringify(err)}');
}); });
``` ```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void
Obtains the extension running information. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | Yes| Maximum number of messages that can be obtained.|
| callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | Yes | Callback used to return the result. |
**Example**
```ts
var upperLimit = 0;
abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
Obtains the extension running information. This API uses a promise to return the result.
**Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | Yes| Maximum number of messages that can be obtained.|
**Return value**
| Type | Description |
| ---------------------------------------- | ------- |
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | Promise used to return the result.|
**Example**
```ts
var upperLimit = 0;
abilityManager.getExtensionRunningInfos(upperLimit).then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err);
})
```
## getTopAbility<sup>9+</sup>
getTopAbility(callback: AsyncCallback\<ElementName>): void;
Obtains the top ability, which is the ability that has the window focus. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | Yes | Callback used to return the result. |
**Example**
```ts
abilityManager.getTopAbility((err,data) => {
console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data));
});
```
## getTopAbility<sup>9+</sup>
getTopAbility(): Promise\<ElementName>;
Obtains the top ability, which is the ability that has the window focus. This API uses a promise to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Return value**
| Type | Description |
| ---------------------------------------- | ------- |
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| Promise used to return the result.|
**Example**
```ts
abilityManager.getTopAbility().then((data) => {
console.log("getTopAbility data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getTopAbility err: " + err);
})
```
...@@ -22,9 +22,9 @@ Checks whether this application is undergoing a stability test. This API uses an ...@@ -22,9 +22,9 @@ Checks whether this application is undergoing a stability test. This API uses an
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.|
**Example** **Example**
...@@ -32,7 +32,7 @@ Checks whether this application is undergoing a stability test. This API uses an ...@@ -32,7 +32,7 @@ Checks whether this application is undergoing a stability test. This API uses an
appManager.isRunningInStabilityTest((err, flag) => { appManager.isRunningInStabilityTest((err, flag) => {
console.log('error: ${JSON.stringify(err)}'); console.log('error: ${JSON.stringify(err)}');
console.log('The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}'); console.log('The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}');
}) });
``` ```
...@@ -46,9 +46,9 @@ Checks whether this application is undergoing a stability test. This API uses a ...@@ -46,9 +46,9 @@ Checks whether this application is undergoing a stability test. This API uses a
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Promise used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| | Promise&lt;boolean&gt; | Promise used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.|
**Example** **Example**
...@@ -71,9 +71,9 @@ Checks whether this application is running on a RAM constrained device. This API ...@@ -71,9 +71,9 @@ Checks whether this application is running on a RAM constrained device. This API
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Promise used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| | Promise&lt;boolean&gt; | Promise used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.|
**Example** **Example**
...@@ -95,9 +95,9 @@ Checks whether this application is running on a RAM constrained device. This API ...@@ -95,9 +95,9 @@ Checks whether this application is running on a RAM constrained device. This API
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.|
**Example** **Example**
...@@ -105,7 +105,7 @@ Checks whether this application is running on a RAM constrained device. This API ...@@ -105,7 +105,7 @@ Checks whether this application is running on a RAM constrained device. This API
appManager.isRamConstrainedDevice((err, data) => { appManager.isRamConstrainedDevice((err, data) => {
console.log('error: ${JSON.stringify(err)}'); console.log('error: ${JSON.stringify(err)}');
console.log('The result of isRamConstrainedDevice is: ${JSON.stringify(data)}'); console.log('The result of isRamConstrainedDevice is: ${JSON.stringify(data)}');
}) });
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -118,9 +118,9 @@ Obtains the memory size of this application. This API uses a promise to return t ...@@ -118,9 +118,9 @@ Obtains the memory size of this application. This API uses a promise to return t
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | Promise used to return the memory size, in MB.| | Promise&lt;number&gt; | Promise used to return the memory size, in MB.|
**Example** **Example**
...@@ -142,9 +142,9 @@ Obtains the memory size of this application. This API uses an asynchronous callb ...@@ -142,9 +142,9 @@ Obtains the memory size of this application. This API uses an asynchronous callb
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;number&gt; | Yes| Callback used to return the memory size, in MB.| | callback | AsyncCallback&lt;number&gt; | Yes| Callback used to return the memory size, in MB.|
**Example** **Example**
......
# @ohos.application.Configuration (Configuration) # @ohos.application.Configuration (Configuration)
The **Configuration** module defines environment change information. The **Configuration** module defines environment change information. **Configuration** is an interface definition and is used only for field declaration.
> **NOTE** > **NOTE**
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> This module is deprecated since API version 9. You are advised to use [@ohos.app.ability.Configuration](js-apis-app-ability-configuration.md) instead. > This module is deprecated since API version 9. You are advised to use [@ohos.app.ability.Configuration](js-apis-app-ability-configuration.md) instead.
## Modules to Import
```ts
import Configuration from '@ohos.application.Configuration'
```
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| language<sup>8+</sup> | string | Yes| Yes| Language of the application, for example, **zh**.| | language<sup>8+</sup> | string | Yes| Yes| Language of the application, for example, **zh**.|
| colorMode<sup>8+</sup> | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | Yes| Yes| Color mode, which can be **COLOR_MODE_LIGHT** or **COLOR_MODE_DARK**. The default value is **COLOR_MODE_LIGHT**.| | colorMode<sup>8+</sup> | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | Yes| Yes| Color mode, which can be **COLOR_MODE_LIGHT** or **COLOR_MODE_DARK**. The default value is **COLOR_MODE_LIGHT**.|
| direction<sup>9+</sup> | [Direction](js-apis-application-configurationConstant.md#configurationconstantdirection9) | Yes| No| Screen orientation, which can be **DIRECTION_HORIZONTAL** or **DIRECTION_VERTICAL**.|
| screenDensity<sup>9+</sup> | [ScreenDensity](js-apis-application-configurationConstant.md#configurationconstantscreendensity9) | Yes| No| Screen resolution, which can be **SCREEN_DENSITY_SDPI** (120), **SCREEN_DENSITY_MDPI** (160), **SCREEN_DENSITY_LDPI** (240), **SCREEN_DENSITY_XLDPI** (320), **SCREEN_DENSITY_XXLDPI** (480), or **SCREEN_DENSITY_XXXLDPI** (640).|
| displayId<sup>9+</sup> | number | Yes| No| ID of the display where the application is located.|
| hasPointerDevice<sup>9+</sup> | boolean | Yes| No| Whether a pointer device, such as a keyboard, mouse, or touchpad, is connected.|
For details about the fields, see the **ohos.application.Configuration.d.ts** file. For details about the fields, see the **ohos.application.Configuration.d.ts** file.
**Example** **Example**
```ts ```ts
import hilog from '@ohos.hilog';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import Window from '@ohos.window'; import Window from '@ohos.window';
...@@ -41,13 +30,9 @@ export default class EntryAbility extends UIAbility { ...@@ -41,13 +30,9 @@ export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: Window.WindowStage) { onWindowStageCreate(windowStage: Window.WindowStage) {
let envCallback = { let envCallback = {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`);
let language = config.language; let language = config.language;
let colorMode = config.colorMode; let colorMode = config.colorMode;
let direction = config.direction;
let screenDensity = config.screenDensity;
let displayId = config.displayId;
let hasPointerDevice = config.hasPointerDevice;
} }
}; };
...@@ -56,12 +41,10 @@ export default class EntryAbility extends UIAbility { ...@@ -56,12 +41,10 @@ export default class EntryAbility extends UIAbility {
windowStage.loadContent('pages/index', (err, data) => { windowStage.loadContent('pages/index', (err, data) => {
if (err.code) { if (err.code) {
hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.ERROR); console.error('failed to load the content, error: + ${JSON.stringify(err)}');
hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
return; return;
} }
hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.INFO); console.info('Succeeded in loading the content, data: + ${JSON.stringify(data)}');
hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
}); });
} }
} }
......
...@@ -23,33 +23,3 @@ You can obtain the value of this constant by calling the **ConfigurationConstant ...@@ -23,33 +23,3 @@ You can obtain the value of this constant by calling the **ConfigurationConstant
| COLOR_MODE_NOT_SET | -1 | Unspecified color mode.| | COLOR_MODE_NOT_SET | -1 | Unspecified color mode.|
| COLOR_MODE_DARK | 0 | Dark mode.| | COLOR_MODE_DARK | 0 | Dark mode.|
| COLOR_MODE_LIGHT | 1 | Light mode.| | COLOR_MODE_LIGHT | 1 | Light mode.|
## ConfigurationConstant.Direction<sup>9+</sup>
You can obtain the value of this constant by calling the **ConfigurationConstant.Direction** API.
**System capability**: SystemCapability.Ability.AbilityBase
| Name| Value| Description|
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | Unspecified direction.|
| DIRECTION_VERTICAL | 0 | Vertical direction.|
| DIRECTION_HORIZONTAL | 1 | Horizontal direction.|
## ConfigurationConstant.ScreenDensity<sup>9+</sup>
You can obtain the value of this constant by calling the **ConfigurationConstant.ScreenDensity** API.
**System capability**: SystemCapability.Ability.AbilityBase
| Name| Value| Description|
| -------- | -------- | -------- |
| SCREEN_DENSITY_NOT_SET | 0 | Unspecified screen resolution.|
| SCREEN_DENSITY_SDPI | 120 | The screen resolution is sdpi.|
| SCREEN_DENSITY_MDPI | 160 | The screen resolution is mdpi.|
| SCREEN_DENSITY_LDPI | 240 | The screen resolution is ldpi.|
| SCREEN_DENSITY_XLDPI | 320 | The screen resolution is xldpi.|
| SCREEN_DENSITY_XXLDPI | 480 | The screen resolution is xxldpi.|
| SCREEN_DENSITY_XXXLDPI | 640 | The screen resolution is xxxldpi.|
...@@ -11,7 +11,7 @@ The **EnvironmentCallback** module provides APIs, such as **onConfigurationUpdat ...@@ -11,7 +11,7 @@ The **EnvironmentCallback** module provides APIs, such as **onConfigurationUpdat
## Modules to Import ## Modules to Import
```ts ```ts
import EnvironmentCallback from "@ohos.application.EnvironmentCallback"; import EnvironmentCallback from '@ohos.application.EnvironmentCallback';
``` ```
...@@ -41,37 +41,37 @@ Called when the system memory level changes. ...@@ -41,37 +41,37 @@ Called when the system memory level changes.
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| level | [MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | Yes| New memory level.| | level | [MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | Yes| New memory level.|
**Example** **Example**
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var callbackId; let callbackId;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log('MyAbility onCreate');
globalThis.applicationContext = this.context.getApplicationContext(); globalThis.applicationContext = this.context.getApplicationContext();
let EnvironmentCallback = { let EnvironmentCallback = {
onConfigurationUpdated(config){ onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config)); console.log('onConfigurationUpdated config: ${JSON.stringify(config)}');
}, },
onMemoryLevel(level){ onMemoryLevel(level){
console.log("onMemoryLevel level:" + level); console.log('onMemoryLevel level: ${level}');
}
} }
};
// 1. Obtain an applicationContext object. // 1. Obtain an applicationContext object.
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
// 2. Register a listener for the environment changes through the applicationContext object. // 2. Register a listener for the environment changes through the applicationContext object.
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); console.log('registerEnvironmentCallback number: ${JSON.stringify(callbackId)}');
} }
onDestroy() { onDestroy() {
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); console.log('unregisterEnvironmentCallback success, err: ${JSON.stringify(error)}');
}); });
} }
} }
......
...@@ -35,7 +35,7 @@ Creates a **FormBindingData** object. ...@@ -35,7 +35,7 @@ Creates a **FormBindingData** object.
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | -------------- | ---- | ------------------------------------------------------------ | | ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object\|string | No | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. The image data is identified by "formImages", and the content is multiple key-value pairs, each of which consists of an image identifier and image file descriptor. The final format is {"formImages": {"key1": fd1, "key2": fd2}}.| | obj | Object\|string | No | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. The image data is identified by **'formImages'**, and the content is multiple key-value pairs, each of which consists of an image identifier and image file descriptor. The final format is {'formImages': {'key1': fd1, 'key2': fd2}}.|
**Return value** **Return value**
...@@ -52,13 +52,13 @@ import formBindingData from '@ohos.application.formBindingData'; ...@@ -52,13 +52,13 @@ import formBindingData from '@ohos.application.formBindingData';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
try { try {
let fd = fs.openSync('/path/to/form.png') let fd = fs.openSync('/path/to/form.png');
let obj = { let obj = {
"temperature": "21°", 'temperature': '21°',
"formImages": { "image": fd } 'formImages': { 'image': fd }
}; };
formBindingData.createFormBindingData(obj); formBindingData.createFormBindingData(obj);
} catch (error.code) { } catch (error) {
console.log('catch error, error:' + JSON.stringify(error)); console.log('catch error, error: ${JSON.stringify(error)}');
} }
``` ```
...@@ -36,10 +36,10 @@ Deletes a widget. After this API is called, the application can no longer use th ...@@ -36,10 +36,10 @@ Deletes a widget. After this API is called, the application can no longer use th
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.deleteForm(formId, (error, data) => { formHost.deleteForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost deleteForm, error:' + JSON.stringify(error)); console.error('formHost deleteForm, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -66,16 +66,16 @@ Deletes a widget. After this API is called, the application can no longer use th ...@@ -66,16 +66,16 @@ Deletes a widget. After this API is called, the application can no longer use th
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Parameters** **Example**
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.deleteForm(formId).then(() => { formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success'); console.log('formHost deleteForm success');
}).catch((error) => { }).catch((error) => {
console.error('formHost deleteForm, error:' + JSON.stringify(error)); console.error('formHost deleteForm, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -101,10 +101,10 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -101,10 +101,10 @@ Releases a widget. After this API is called, the application can no longer use t
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, (error, data) => { formHost.releaseForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost releaseForm, error:' + JSON.stringify(error)); console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
} }
...@@ -134,10 +134,10 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -134,10 +134,10 @@ Releases a widget. After this API is called, the application can no longer use t
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, true, (error, data) => { formHost.releaseForm(formId, true, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost releaseForm, error:' + JSON.stringify(error)); console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
} }
...@@ -172,11 +172,11 @@ Releases a widget. After this API is called, the application can no longer use t ...@@ -172,11 +172,11 @@ Releases a widget. After this API is called, the application can no longer use t
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.releaseForm(formId, true).then(() => { formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
}).catch((error) => { }).catch((error) => {
console.error('formHost releaseForm, error:' + JSON.stringify(error)); console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -202,10 +202,10 @@ Requests a widget update. This API uses an asynchronous callback to return the r ...@@ -202,10 +202,10 @@ Requests a widget update. This API uses an asynchronous callback to return the r
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.requestForm(formId, (error, data) => { formHost.requestForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost requestForm, error:' + JSON.stringify(error)); console.error('formHost requestForm, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -237,11 +237,11 @@ Requests a widget update. This API uses a promise to return the result. ...@@ -237,11 +237,11 @@ Requests a widget update. This API uses a promise to return the result.
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.requestForm(formId).then(() => { formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success'); console.log('formHost requestForm success');
}).catch((error) => { }).catch((error) => {
console.error('formHost requestForm, error:' + JSON.stringify(error)); console.error('formHost requestForm, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -267,10 +267,10 @@ Converts a temporary widget to a normal one. This API uses an asynchronous callb ...@@ -267,10 +267,10 @@ Converts a temporary widget to a normal one. This API uses an asynchronous callb
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.castTempForm(formId, (error, data) => { formHost.castTempForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost castTempForm, error:' + JSON.stringify(error)); console.error('formHost castTempForm, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -302,11 +302,11 @@ Converts a temporary widget to a normal one. This API uses a promise to return t ...@@ -302,11 +302,11 @@ Converts a temporary widget to a normal one. This API uses a promise to return t
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.castTempForm(formId).then(() => { formHost.castTempForm(formId).then(() => {
console.log('formHost castTempForm success'); console.log('formHost castTempForm success');
}).catch((error) => { }).catch((error) => {
console.error('formHost castTempForm, error:' + JSON.stringify(error)); console.error('formHost castTempForm, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -332,10 +332,10 @@ Instructs the widget framework to make a widget visible. After this API is calle ...@@ -332,10 +332,10 @@ Instructs the widget framework to make a widget visible. After this API is calle
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error, data) => { formHost.notifyVisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost notifyVisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -367,11 +367,11 @@ Instructs the widget framework to make a widget visible. After this API is calle ...@@ -367,11 +367,11 @@ Instructs the widget framework to make a widget visible. After this API is calle
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId).then(() => { formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success'); console.log('formHost notifyVisibleForms success');
}).catch((error) => { }).catch((error) => {
console.error('formHost notifyVisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -397,10 +397,10 @@ Instructs the widget framework to make a widget invisible. After this API is cal ...@@ -397,10 +397,10 @@ Instructs the widget framework to make a widget invisible. After this API is cal
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error, data) => { formHost.notifyInvisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -432,11 +432,11 @@ Instructs the widget framework to make a widget invisible. After this API is cal ...@@ -432,11 +432,11 @@ Instructs the widget framework to make a widget invisible. After this API is cal
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId).then(() => { formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success'); console.log('formHost notifyInvisibleForms success');
}).catch((error) => { }).catch((error) => {
console.error('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -462,10 +462,10 @@ Instructs the widget framework to make a widget updatable. After this API is cal ...@@ -462,10 +462,10 @@ Instructs the widget framework to make a widget updatable. After this API is cal
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error, data) => { formHost.enableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost enableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -497,11 +497,11 @@ Instructs the widget framework to make a widget updatable. After this API is cal ...@@ -497,11 +497,11 @@ Instructs the widget framework to make a widget updatable. After this API is cal
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId).then(() => { formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success'); console.log('formHost enableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
console.error('formHost enableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -527,10 +527,10 @@ Instructs the widget framework to make a widget not updatable. After this API is ...@@ -527,10 +527,10 @@ Instructs the widget framework to make a widget not updatable. After this API is
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error, data) => { formHost.disableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost disableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -562,11 +562,11 @@ Instructs the widget framework to make a widget not updatable. After this API is ...@@ -562,11 +562,11 @@ Instructs the widget framework to make a widget not updatable. After this API is
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"]; let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId).then(() => { formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success'); console.log('formHost disableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
console.error('formHost disableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -589,10 +589,10 @@ Checks whether the system is ready. This API uses an asynchronous callback to re ...@@ -589,10 +589,10 @@ Checks whether the system is ready. This API uses an asynchronous callback to re
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
if (error.code) { if (error.code) {
console.error('formHost isSystemReady, error:' + JSON.stringify(error)); console.error('formHost isSystemReady, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -616,11 +616,11 @@ Checks whether the system is ready. This API uses a promise to return the result ...@@ -616,11 +616,11 @@ Checks whether the system is ready. This API uses a promise to return the result
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288"; let formId = '12400633174999288';
formHost.isSystemReady().then(() => { formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success'); console.log('formHost isSystemReady success');
}).catch((error) => { }).catch((error) => {
console.error('formHost isSystemReady, error:' + JSON.stringify(error)); console.error('formHost isSystemReady, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -647,9 +647,9 @@ import formHost from '@ohos.application.formHost'; ...@@ -647,9 +647,9 @@ import formHost from '@ohos.application.formHost';
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error.code) { if (error.code) {
console.error('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
``` ```
...@@ -676,9 +676,9 @@ Obtains the widget information provided by all applications on the device. This ...@@ -676,9 +676,9 @@ Obtains the widget information provided by all applications on the device. This
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
formHost.getAllFormsInfo().then((data) => { formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.error('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -704,11 +704,11 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -704,11 +704,11 @@ Obtains the widget information provided by a given application on the device. Th
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost getFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
``` ```
...@@ -736,11 +736,11 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -736,11 +736,11 @@ Obtains the widget information provided by a given application on the device. Th
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost getFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
} }
}); });
``` ```
...@@ -773,10 +773,10 @@ Obtains the widget information provided by a given application on the device. Th ...@@ -773,10 +773,10 @@ Obtains the widget information provided by a given application on the device. Th
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.error('formHost getFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -802,12 +802,12 @@ Deletes invalid widgets from the list. This API uses an asynchronous callback to ...@@ -802,12 +802,12 @@ Deletes invalid widgets from the list. This API uses an asynchronous callback to
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost deleteInvalidForms, error:' + JSON.stringify(error)); console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
} }
}); });
``` ```
...@@ -839,11 +839,11 @@ Deletes invalid widgets from the list. This API uses a promise to return the res ...@@ -839,11 +839,11 @@ Deletes invalid widgets from the list. This API uses a promise to return the res
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data) => { formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.error('formHost deleteInvalidForms, error:' + JSON.stringify(error)); console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -870,20 +870,20 @@ Obtains the widget state. This API uses an asynchronous callback to return the r ...@@ -870,20 +870,20 @@ Obtains the widget state. This API uses an asynchronous callback to return the r
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let want = { let want = {
"deviceId": "", 'deviceId': '',
"bundleName": "ohos.samples.FormApplication", 'bundleName': 'ohos.samples.FormApplication',
"abilityName": "FormAbility", 'abilityName': 'FormAbility',
"parameters": { 'parameters': {
"ohos.extra.param.key.module_name": "entry", 'ohos.extra.param.key.module_name': 'entry',
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.form_dimension": 2 'ohos.extra.param.key.form_dimension': 2
} }
}; };
formHost.acquireFormState(want, (error, data) => { formHost.acquireFormState(want, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost acquireFormState, error:' + JSON.stringify(error)); console.error('formHost acquireFormState, error: ${JSON.stringify(error)}');
} else { } else {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
} }
}); });
``` ```
...@@ -916,25 +916,25 @@ Obtains the widget state. This API uses a promise to return the result. ...@@ -916,25 +916,25 @@ Obtains the widget state. This API uses a promise to return the result.
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let want = { let want = {
"deviceId": "", 'deviceId': '',
"bundleName": "ohos.samples.FormApplication", 'bundleName': 'ohos.samples.FormApplication',
"abilityName": "FormAbility", 'abilityName': 'FormAbility',
"parameters": { 'parameters': {
"ohos.extra.param.key.module_name": "entry", 'ohos.extra.param.key.module_name': 'entry',
"ohos.extra.param.key.form_name": "widget", 'ohos.extra.param.key.form_name': 'widget',
"ohos.extra.param.key.form_dimension": 2 'ohos.extra.param.key.form_dimension': 2
} }
}; };
formHost.acquireFormState(want).then((data) => { formHost.acquireFormState(want).then((data) => {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
}).catch((error) => { }).catch((error) => {
console.error('formHost acquireFormState, error:' + JSON.stringify(error)); console.error('formHost acquireFormState, error: ${JSON.stringify(error)}');
}); });
``` ```
## on("formUninstall") ## on('formUninstall')
on(type: "formUninstall", callback: Callback&lt;string&gt;): void on(type: 'formUninstall', callback: Callback&lt;string&gt;): void
Subscribes to widget uninstall events. This API uses an asynchronous callback to return the result. Subscribes to widget uninstall events. This API uses an asynchronous callback to return the result.
...@@ -944,7 +944,7 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to ...@@ -944,7 +944,7 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| type | string | Yes | Event type. The value **formUninstall** indicates a widget uninstallation event.| | type | string | Yes | Event type. The value **'formUninstall'** indicates a widget uninstallation event.|
| callback | Callback&lt;string&gt; | Yes| Callback used to return the widget ID.| | callback | Callback&lt;string&gt; | Yes| Callback used to return the widget ID.|
**Example** **Example**
...@@ -953,14 +953,14 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to ...@@ -953,14 +953,14 @@ Subscribes to widget uninstall events. This API uses an asynchronous callback to
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId: ${formId}');
} };
formHost.on("formUninstall", callback); formHost.on('formUninstall', callback);
``` ```
## off("formUninstall") ## off('formUninstall')
off(type: "formUninstall", callback?: Callback&lt;string&gt;): void off(type: 'formUninstall', callback?: Callback&lt;string&gt;): void
Unsubscribes from widget uninstall events. This API uses an asynchronous callback to return the result. Unsubscribes from widget uninstall events. This API uses an asynchronous callback to return the result.
...@@ -970,8 +970,8 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac ...@@ -970,8 +970,8 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| type | string | Yes | Event type. The value **formUninstall** indicates a widget uninstallation event.| | type | string | Yes | Event type. The value **'formUninstall'** indicates a widget uninstallation event.|
| callback | Callback&lt;string&gt; | No| Callback used to return the widget ID. If it is left unspecified, it indicates the callback for all the events that have been subscribed.<br> The value must be the same as that in **on("formUninstall")**.| | callback | Callback&lt;string&gt; | No| Callback used to return the widget ID. If it is left unspecified, it indicates the callback for all the events that have been subscribed.<br> The value must be the same as that in **on('formUninstall')**.|
**Example** **Example**
...@@ -979,9 +979,9 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac ...@@ -979,9 +979,9 @@ Unsubscribes from widget uninstall events. This API uses an asynchronous callbac
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId: ${formId}');
} };
formHost.off("formUninstall", callback); formHost.off('formUninstall', callback);
``` ```
## notifyFormsVisible ## notifyFormsVisible
...@@ -1007,10 +1007,10 @@ Instructs the widgets to make themselves visible. This API uses an asynchronous ...@@ -1007,10 +1007,10 @@ Instructs the widgets to make themselves visible. This API uses an asynchronous
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true, (error, data) => { formHost.notifyFormsVisible(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost notifyFormsVisible, error:' + JSON.stringify(error)); console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -1043,11 +1043,11 @@ Instructs the widgets to make themselves visible. This API uses a promise to ret ...@@ -1043,11 +1043,11 @@ Instructs the widgets to make themselves visible. This API uses a promise to ret
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true).then(() => { formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success'); console.log('formHost notifyFormsVisible success');
}).catch((error) => { }).catch((error) => {
console.error('formHost notifyFormsVisible, error:' + JSON.stringify(error)); console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -1074,10 +1074,10 @@ Instructs the widgets to enable or disable updates. This API uses an asynchronou ...@@ -1074,10 +1074,10 @@ Instructs the widgets to enable or disable updates. This API uses an asynchronou
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
console.error('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -1110,145 +1110,10 @@ Instructs the widgets to enable or disable updates. This API uses a promise to r ...@@ -1110,145 +1110,10 @@ Instructs the widgets to enable or disable updates. This API uses a promise to r
```ts ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true).then(() => { formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success'); console.log('formHost notifyFormsEnableUpdate success');
}).catch((error) => { }).catch((error) => {
console.error('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}');
});
```
## shareForm<sup>9+</sup>
shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;): void
Shares a specified widget with a remote device. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.REQUIRE_FORM and ohos.permission.DISTRIBUTED_DATASYNC
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| formId | string | Yes | Widget ID.|
| deviceId | string | Yes | Remote device ID.|
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result. If the widget is shared, **error** is undefined; otherwise, **error** is an error object.|
**Example**
```ts
import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
formHost.shareForm(formId, deviceId, (error, data) => {
if (error.code) {
console.error('formHost shareForm, error:' + JSON.stringify(error));
}
}); });
``` ```
## shareForm<sup>9+</sup>
shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
Shares a specified widget with a remote device. This API uses a promise to return the result.
**Required permissions**: ohos.permission.REQUIRE_FORM
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| formId | string | Yes | Widget ID.|
| deviceId | string | Yes | Remote device ID.|
**Return value**
| Type| Description|
| -------- | -------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Parameters**
```ts
import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
formHost.shareForm(formId, deviceId).then(() => {
console.log('formHost shareForm success');
}).catch((error) => {
console.error('formHost shareForm, error:' + JSON.stringify(error));
});
```
## notifyFormsPrivacyProtected<sup>9+</sup>
notifyFormsPrivacyProtected(formIds: Array&lt;string&gt;, isProtected: boolean, callback: AsyncCallback&lt;void&gt;): void
Notifies that the privacy protection status of the specified widgets changes. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.REQUIRE_FORM
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| formId | string | Yes | Widget ID.|
| deviceId | string | Yes | Remote device ID.|
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost shareForm success');
}).catch((error) => {
console.error('formHost shareForm, error:' + JSON.stringify(error));
});
```
## notifyFormsPrivacyProtected
function notifyFormsPrivacyProtected(formIds: Array&lt;string&gt;, isProtected: boolean): Promise&lt;void&gt;;
Notifies that the privacy protection status of the specified widgets changes. This API uses a promise to return the result.
**Required permissions**: ohos.permission.REQUIRE_FORM
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | --------------- | ---- | -------------------------------- |
| formIds | Array&lt;string&gt; | Yes | ID of the widgets.|
| isProtected | boolean | Yes | Whether privacy protection is enabled. |
**Return value**
| Type | Description |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.|
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost notifyFormsPrivacyProtected success');
}).catch((error) => {
console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error));
});
} catch(error) {
console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error));
}
```
...@@ -49,7 +49,6 @@ Enumerates the widget types. ...@@ -49,7 +49,6 @@ Enumerates the widget types.
| Name | Value | Description | | Name | Value | Description |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| JS | 1 | JS widget. | | JS | 1 | JS widget. |
| eTS<sup>9+<sup> | 2 | eTS widget.|
## ColorMode ## ColorMode
...@@ -94,48 +93,10 @@ Enumerates the widget parameters. ...@@ -94,48 +93,10 @@ Enumerates the widget parameters.
| Name | Value | Description | | Name | Value | Description |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| IDENTITY_KEY<sup>9+</sup> | "ohos.extra.param.key.form_identity" | Widget ID.<br>**System API**: This is a system API. | | IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | Widget ID.<br>**System API**: This is a system API. |
| DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | Widget dimension. | | DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | Widget dimension. |
| NAME_KEY | "ohos.extra.param.key.form_name" | Widget name. | | NAME_KEY | 'ohos.extra.param.key.form_name' | Widget name. |
| MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | Name of the module to which the widget belongs. | | MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | Name of the module to which the widget belongs. |
| WIDTH_KEY | "ohos.extra.param.key.form_width" | Widget width. | | WIDTH_KEY | 'ohos.extra.param.key.form_width' | Widget width. |
| HEIGHT_KEY | "ohos.extra.param.key.form_height" | Widget height. | | HEIGHT_KEY | 'ohos.extra.param.key.form_height' | Widget height. |
| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | Temporary widget. | | TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | Temporary widget. |
| ABILITY_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.ability_name" | Ability name. |
| DEVICE_ID_KEY<sup>9+</sup> | "ohos.extra.param.key.device_id" | Device ID. |
| BUNDLE_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.bundle_name" | Key that specifies the target bundle name.|
## FormDimension<sup>9+</sup>
Enumerates the widget dimensions.
**System capability**: SystemCapability.Ability.Form
| Name | Value | Description |
| ----------- | ---- | ------------ |
| Dimension_1_2 <sup>9+</sup> | 1 | 1 x 2. |
| Dimension_2_2 <sup>9+</sup> | 2 | 2 x 2. |
| Dimension_2_4 <sup>9+</sup> | 3 | 2 x 4. |
| Dimension_4_4 <sup>9+</sup> | 4 | 4 x 4. |
| Dimension_2_1 <sup>9+</sup> | 5 | 2 x 1. |
## FormInfoFilter<sup>9+</sup>
Defines the widget information filter. Only the widget information that meets the filter is returned.
**System capability**: SystemCapability.Ability.Form
| Name | Description |
| ----------- | ------------ |
| moduleName<sup>9+</sup> | Optional. Only the information about the widget whose **moduleName** is the same as the provided value is returned.<br>If this parameter is not set, **moduleName** is not used for filtering.|
## VisibilityType<sup>9+</sup>
Enumerates the visibility types of the widget.
**System capability**: SystemCapability.Ability.Form
| Name | Value | Description |
| ----------- | ---- | ------------ |
| FORM_VISIBLE<sup>9+<sup> | 1 | The widget is visible.|
| FORM_INVISIBLE<sup>9+<sup> | 2 | The widget is invisible.|
...@@ -33,10 +33,10 @@ Sets the next refresh time for a widget. This API uses an asynchronous callback ...@@ -33,10 +33,10 @@ Sets the next refresh time for a widget. This API uses an asynchronous callback
```ts ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) { if (error.code) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); console.log('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -67,11 +67,11 @@ Sets the next refresh time for a widget. This API uses a promise to return the r ...@@ -67,11 +67,11 @@ Sets the next refresh time for a widget. This API uses a promise to return the r
```ts ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success'); console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => { }).catch((error) => {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); console.log('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
}); });
``` ```
...@@ -97,11 +97,11 @@ Updates a widget. This API uses an asynchronous callback to return the result. ...@@ -97,11 +97,11 @@ Updates a widget. This API uses an asynchronous callback to return the result.
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
formProvider.updateForm(formId, obj, (error, data) => { formProvider.updateForm(formId, obj, (error, data) => {
if (error.code) { if (error.code) {
console.log('formProvider updateForm, error:' + JSON.stringify(error)); console.log('formProvider updateForm, error: ${JSON.stringify(error)}');
} }
}); });
``` ```
...@@ -133,316 +133,11 @@ Updates a widget. This API uses a promise to return the result. ...@@ -133,316 +133,11 @@ Updates a widget. This API uses a promise to return the result.
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
formProvider.updateForm(formId, obj).then(() => { formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success'); console.log('formProvider updateForm success');
}).catch((error) => { }).catch((error) => {
console.log('formProvider updateForm, error:' + JSON.stringify(error)); console.log('formProvider updateForm, error: ${JSON.stringify(error)}');
}); });
``` ```
## getFormsInfo<sup>9+</sup>
getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void
Obtains the application's widget information on the device. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Yes| Callback used to return the information obtained.|
**Example**
```ts
import formProvider from '@ohos.app.form.formProvider';
formProvider.getFormsInfo((error, data) => {
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
```
## getFormsInfo<sup>9+</sup>
getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void
Obtains the application's widget information that meets a filter criterion on the device. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | Yes| Filter criterion.|
| callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Yes| Callback used to return the information obtained.|
**Example**
```ts
import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry.
moduleName : "entry"
};
formProvider.getFormsInfo(filter, (error, data) => {
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
```
## getFormsInfo<sup>9+</sup>
getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
Obtains the application's widget information on the device. This API uses a promise to return the result.
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md) | No| Filter criterion.|
**Return value**
| Type | Description |
| :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise used to return the information obtained.|
**Example**
```ts
import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry.
moduleName : "entry"
};
formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
});
```
## requestPublishForm<sup>9+</sup>
requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\<string>): void
Requests to publish a widget carrying data to the widget host. This API uses an asynchronous callback to return the result. This API is usually called by the home screen.
**System capability**: SystemCapability.Ability.Form
**System API**: This is a system API.
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | Yes | Data used for creating the widget.|
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the widget ID.|
**Example**
```ts
import formBindingData from '@ohos.application.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.requestPublishForm(want, obj, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
```
## requestPublishForm<sup>9+</sup>
requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
Requests to publish a widget to the widget host. This API uses an asynchronous callback to return the result. This API is usually called by the home screen.
**System capability**: SystemCapability.Ability.Form
**System API**: This is a system API.
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the widget ID.|
**Example**
```ts
import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
```
## requestPublishForm<sup>9+</sup>
requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise&lt;string&gt;
Requests to publish a widget to the widget host. This API uses a promise to return the result. This API is usually called by the home screen.
**System capability**: SystemCapability.Ability.Form
**System API**: This is a system API.
**Parameters**
| Name | Type | Mandatory| Description |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | Yes | Request used for publishing. The following fields must be included:<br>Information about the target widget.<br>**abilityName**: ability of the target widget.<br>**parameters**:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | Yes | Data used for creating the widget.|
**Return value**
| Type | Description |
| :------------ | :---------------------------------- |
| Promise&lt;string&gt; | Promise used to return the widget ID.|
**Example**
```ts
import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
});
```
## isRequestPublishFormSupported<sup>9+<sup>
isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void
Checks whether a widget can be published to the widget host. This API uses an asynchronous callback to return the result.
**System API**: This is a system API.
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return whether the widget can be published to the widget host.|
**Example**
```ts
formProvider.isRequestPublishFormSupported((error, isSupported) => {
if (error.code) {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
} else {
if (isSupported) {
let want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
}
}
});
```
## isRequestPublishFormSupported<sup>9+</sup>
isRequestPublishFormSupported(): Promise&lt;boolean&gt;
Checks whether a widget can be published to the widget host. This API uses a promise to return the result.
**System API**: This is a system API.
**System capability**: SystemCapability.Ability.Form
**Return value**
| Type | Description |
| :------------ | :---------------------------------- |
| Promise&lt;boolean&gt; | Promise used to return whether the widget can be published to the widget host.|
**Example**
```ts
formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) {
let want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
});
}
}).catch((error) => {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
});
```
...@@ -9,7 +9,7 @@ The **missionManager** module provides APIs to lock, unlock, and clear missions, ...@@ -9,7 +9,7 @@ The **missionManager** module provides APIs to lock, unlock, and clear missions,
## Modules to Import ## Modules to Import
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
``` ```
## Required Permissions ## Required Permissions
...@@ -43,17 +43,17 @@ Registers a listener to observe the mission status. ...@@ -43,17 +43,17 @@ Registers a listener to observe the mission status.
**Example** **Example**
```ts ```ts
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
console.log("registerMissionListener") console.log('registerMissionListener');
var listenerid = missionManager.registerMissionListener(listener); let listenerid = missionManager.registerMissionListener(listener);
``` ```
...@@ -79,21 +79,21 @@ Deregisters a mission status listener. This API uses an asynchronous callback to ...@@ -79,21 +79,21 @@ Deregisters a mission status listener. This API uses an asynchronous callback to
**Example** **Example**
```ts ```ts
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
console.log("registerMissionListener") console.log('registerMissionListener');
var listenerid = missionManager.registerMissionListener(listener); let listenerid = missionManager.registerMissionListener(listener);
missionManager.unregisterMissionListener(listenerid, (error) => { missionManager.unregisterMissionListener(listenerid, (error) => {
console.log("unregisterMissionListener"); console.log('unregisterMissionListener');
}) });
``` ```
...@@ -124,17 +124,17 @@ Deregisters a mission status listener. This API uses a promise to return the res ...@@ -124,17 +124,17 @@ Deregisters a mission status listener. This API uses a promise to return the res
**Example** **Example**
```ts ```ts
var listener = { let listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
}; };
console.log("registerMissionListener") console.log('registerMissionListener');
var listenerid = missionManager.registerMissionListener(listener); let listenerid = missionManager.registerMissionListener(listener);
missionManager.unregisterMissionListener(listenerid).catch(function (err) { missionManager.unregisterMissionListener(listenerid).catch(function (err) {
console.log(err); console.log(err);
...@@ -165,22 +165,21 @@ Obtains the information about a given mission. This API uses an asynchronous cal ...@@ -165,22 +165,21 @@ Obtains the information about a given mission. This API uses an asynchronous cal
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);}); let allMissions=missionManager.getMissionInfos('',10).catch(function(err){console.log(err);});
missionManager.getMissionInfo("", allMissions[0].missionId, (error, mission) => { missionManager.getMissionInfo('', allMissions[0].missionId, (error, mission) => {
if (error.code) { if (error.code) {
console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfo failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("mission.missionId = " + mission.missionId); console.log('mission.missionId = ${mission.missionId}');
console.log("mission.runningState = " + mission.runningState); console.log('mission.runningState = ${mission.runningState}');
console.log("mission.lockedState = " + mission.lockedState); console.log('mission.lockedState = ${mission.lockedState}');
console.log("mission.timestamp = " + mission.timestamp); console.log('mission.timestamp = ${mission.timestamp}');
console.log("mission.label = " + mission.label); console.log('mission.label = ${mission.label}');
console.log("mission.iconPath = " + mission.iconPath); console.log('mission.iconPath = ${mission.iconPath}');
}); });
``` ```
...@@ -213,9 +212,9 @@ Obtains the information about a given mission. This API uses a promise to return ...@@ -213,9 +212,9 @@ Obtains the information about a given mission. This API uses a promise to return
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var mission = missionManager.getMissionInfo("", 10).catch(function (err){ let mission = missionManager.getMissionInfo('', 10).catch(function (err){
console.log(err); console.log(err);
}); });
``` ```
...@@ -244,17 +243,16 @@ Obtains information about all missions. This API uses an asynchronous callback t ...@@ -244,17 +243,16 @@ Obtains information about all missions. This API uses an asynchronous callback t
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
}) });
``` ```
...@@ -286,9 +284,9 @@ Obtains information about all missions. This API uses a promise to return the re ...@@ -286,9 +284,9 @@ Obtains information about all missions. This API uses a promise to return the re
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){ let allMissions = missionManager.getMissionInfos('', 10).catch(function (err){
console.log(err); console.log(err);
}); });
``` ```
...@@ -317,27 +315,25 @@ Obtains the snapshot of a given mission. This API uses an asynchronous callback ...@@ -317,27 +315,25 @@ Obtains the snapshot of a given mission. This API uses an asynchronous callback
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.getMissionSnapShot("", id, (error, snapshot) => { missionManager.getMissionSnapShot('', id, (error, snapshot) => {
if (error.code) { if (error.code) {
console.log("getMissionSnapShot failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionSnapShot failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("bundleName = " + snapshot.ability.bundleName); console.log('bundleName = ${snapshot.ability.bundleName}');
}) });
}) });
``` ```
...@@ -369,17 +365,17 @@ Obtains the snapshot of a given mission. This API uses a promise to return the r ...@@ -369,17 +365,17 @@ Obtains the snapshot of a given mission. This API uses a promise to return the r
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
var snapshot = missionManager.getMissionSnapShot("", id).catch(function (err){ let snapshot = missionManager.getMissionSnapShot('', id).catch(function (err){
console.log(err); console.log(err);
}); });
``` ```
...@@ -407,27 +403,26 @@ Obtains the low-resolution snapshot of a given mission. This API uses an asynchr ...@@ -407,27 +403,26 @@ Obtains the low-resolution snapshot of a given mission. This API uses an asynchr
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.getLowResolutionMissionSnapShot("", id, (error, snapshot) => { missionManager.getLowResolutionMissionSnapShot('', id, (error, snapshot) => {
if (error.code) { if (error.code) {
console.log("getLowResolutionMissionSnapShot failed, error.code:" + JSON.stringify(error.code) + console.log('getLowResolutionMissionSnapShot failed, error.code: ${JSON.stringify(error.code)}
"error.message:" + JSON.stringify(error.message)); 'error.message: ${JSON.stringify(error.message)}');
return; return;
} }
console.log("bundleName = " + snapshot.ability.bundleName); console.log('bundleName = ${snapshot.ability.bundleName}');
}) });
}) });
``` ```
...@@ -459,17 +454,17 @@ Obtains the low-resolution snapshot of a given mission. This API uses a promise ...@@ -459,17 +454,17 @@ Obtains the low-resolution snapshot of a given mission. This API uses a promise
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
var snapshot = missionManager.getLowResolutionMissionSnapShot("", id).catch(function (err){ let snapshot = missionManager.getLowResolutionMissionSnapShot('', id).catch(function (err){
console.log(err); console.log(err);
}); });
``` ```
...@@ -497,20 +492,20 @@ Locks a given mission. This API uses an asynchronous callback to return the resu ...@@ -497,20 +492,20 @@ Locks a given mission. This API uses an asynchronous callback to return the resu
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}
"error.message:" + JSON.stringify(error.message)); 'error.message: ${JSON.stringify(error.message)}');
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.lockMission(id).then(() => { missionManager.lockMission(id).then(() => {
console.log("lockMission is called "); console.log('lockMission is called ');
}); });
}); });
``` ```
...@@ -543,14 +538,14 @@ Locks a given mission. This API uses a promise to return the result. ...@@ -543,14 +538,14 @@ Locks a given mission. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
missionManager.lockMission(id).catch(function (err){ missionManager.lockMission(id).catch(function (err){
console.log(err); console.log(err);
...@@ -580,20 +575,19 @@ Unlocks a given mission. This API uses an asynchronous callback to return the re ...@@ -580,20 +575,19 @@ Unlocks a given mission. This API uses an asynchronous callback to return the re
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.unlockMission(id).then(() => { missionManager.unlockMission(id).then(() => {
console.log("unlockMission is called "); console.log('unlockMission is called ');
}); });
}); });
``` ```
...@@ -626,15 +620,15 @@ Unlocks a given mission. This API uses a promise to return the result. ...@@ -626,15 +620,15 @@ Unlocks a given mission. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
missionManager.lockMission(id).catch(function (err){ missionManager.lockMission(id).catch(function (err){
console.log(err); console.log(err);
...@@ -667,20 +661,19 @@ Clears a given mission, regardless of whether it is locked. This API uses an asy ...@@ -667,20 +661,19 @@ Clears a given mission, regardless of whether it is locked. This API uses an asy
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.clearMission(id).then(() => { missionManager.clearMission(id).then(() => {
console.log("clearMission is called "); console.log('clearMission is called ');
}); });
}); });
``` ```
...@@ -713,15 +706,15 @@ Clears a given mission, regardless of whether it is locked. This API uses a prom ...@@ -713,15 +706,15 @@ Clears a given mission, regardless of whether it is locked. This API uses a prom
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
missionManager.clearMission(id).catch(function (err){ missionManager.clearMission(id).catch(function (err){
console.log(err); console.log(err);
...@@ -747,7 +740,7 @@ Clears all unlocked missions. This API uses an asynchronous callback to return t ...@@ -747,7 +740,7 @@ Clears all unlocked missions. This API uses an asynchronous callback to return t
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.clearAllMissions().then(() => { missionManager.clearAllMissions().then(() => {
console.log("clearAllMissions is called "); console.log('clearAllMissions is called ');
}); });
``` ```
...@@ -773,7 +766,7 @@ Clears all unlocked missions. This API uses a promise to return the result. ...@@ -773,7 +766,7 @@ Clears all unlocked missions. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.clearAllMissions().catch(function (err){ missionManager.clearAllMissions().catch(function (err){
console.log(err); console.log(err);
}); });
...@@ -802,20 +795,19 @@ Switches a given mission to the foreground. This API uses an asynchronous callba ...@@ -802,20 +795,19 @@ Switches a given mission to the foreground. This API uses an asynchronous callba
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.moveMissionToFront(id).then(() => { missionManager.moveMissionToFront(id).then(() => {
console.log("moveMissionToFront is called "); console.log('moveMissionToFront is called ');
}); });
}); });
``` ```
...@@ -838,26 +830,25 @@ Switches a given mission to the foreground, with the startup parameters for the ...@@ -838,26 +830,25 @@ Switches a given mission to the foreground, with the startup parameters for the
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | Yes| Mission ID.| | missionId | number | Yes| Mission ID.|
| options | [StartOptions](js-apis-application-startOptions.md) | Yes| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.| | options | [StartOptions](js-apis-app-ability-startOptions.md) | Yes| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.moveMissionToFront(id,{windowMode : 101}).then(() => { missionManager.moveMissionToFront(id,{windowMode : 101}).then(() => {
console.log("moveMissionToFront is called "); console.log('moveMissionToFront is called ');
}); });
}); });
``` ```
...@@ -880,7 +871,7 @@ Switches a given mission to the foreground, with the startup parameters for the ...@@ -880,7 +871,7 @@ Switches a given mission to the foreground, with the startup parameters for the
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | Yes| Mission ID.| | missionId | number | Yes| Mission ID.|
| options | [StartOptions](js-apis-application-startOptions.md) | No| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.| | options | [StartOptions](js-apis-app-ability-startOptions.md) | No| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|
**Return value** **Return value**
...@@ -891,15 +882,15 @@ Switches a given mission to the foreground, with the startup parameters for the ...@@ -891,15 +882,15 @@ Switches a given mission to the foreground, with the startup parameters for the
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager';
var allMissions; let allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos('',10).then(function(res){
allMissions=res; allMissions=res;
}).catch(function(err){console.log(err);}); }).catch(function(err){console.log(err);});
console.log("size = " + allMissions.length); console.log('size = ${allMissions.length}');
console.log("missions = " + JSON.stringify(allMissions)); console.log('missions = ${JSON.stringify(allMissions)}');
var id = allMissions[0].missionId; let id = allMissions[0].missionId;
missionManager.moveMissionToFront(id).catch(function (err){ missionManager.moveMissionToFront(id).catch(function (err){
console.log(err); console.log(err);
......
...@@ -10,7 +10,7 @@ The **StaticSubscriberExtensionAbility** module provides Extension abilities for ...@@ -10,7 +10,7 @@ The **StaticSubscriberExtensionAbility** module provides Extension abilities for
## Modules to Import ## Modules to Import
```ts ```ts
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility' import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility';
``` ```
## StaticSubscriberExtensionAbility.onReceiveEvent ## StaticSubscriberExtensionAbility.onReceiveEvent
...@@ -32,12 +32,9 @@ Callback of the common event of a static subscriber. ...@@ -32,12 +32,9 @@ Callback of the common event of a static subscriber.
**Example** **Example**
```ts ```ts
var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility") class MyStaticSubscriberExtensionAbility extends StaticSubscriberExtensionAbility {
{ onReceiveEvent(event) {
onReceiveEvent(event){ console.log('onReceiveEvent, event: ${JSON.stringify(event)}');
console.log('onReceiveEvent,event:' + event.code);
} }
} }
export default MyStaticSubscriberExtensionAbility
``` ```
...@@ -11,7 +11,7 @@ To implement your own unit test framework, extend this class and override its AP ...@@ -11,7 +11,7 @@ To implement your own unit test framework, extend this class and override its AP
## Modules to Import ## Modules to Import
```ts ```ts
import TestRunner from '@ohos.application.testRunner' import TestRunner from '@ohos.application.testRunner';
``` ```
## TestRunner.onPrepare ## TestRunner.onPrepare
...@@ -27,7 +27,7 @@ Prepares the unit test environment to run test cases. ...@@ -27,7 +27,7 @@ Prepares the unit test environment to run test cases.
```ts ```ts
export default class UserTestRunner implements TestRunner { export default class UserTestRunner implements TestRunner {
onPrepare() { onPrepare() {
console.log("Trigger onPrepare") console.log('Trigger onPrepare');
} }
onRun() {} onRun() {}
}; };
...@@ -49,7 +49,7 @@ Runs test cases. ...@@ -49,7 +49,7 @@ Runs test cases.
export default class UserTestRunner implements TestRunner { export default class UserTestRunner implements TestRunner {
onPrepare() {} onPrepare() {}
onRun() { onRun() {
console.log("Trigger onRun") console.log('Trigger onRun');
} }
}; };
``` ```
...@@ -4,7 +4,7 @@ Want is a carrier for information transfer between objects (application componen ...@@ -4,7 +4,7 @@ Want is a carrier for information transfer between objects (application componen
> **NOTE** > **NOTE**
> >
> The APIs of this module are supported since API version 8 and deprecated since API version 9. You are advised to use [Want](js-apis-app-ability-want.md) instead. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The APIs of this module are supported since API version 8 and deprecated since API version 9. You are advised to use [@ohos.app.ability.Want](js-apis-app-ability-want.md) instead. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import ## Modules to Import
...@@ -22,10 +22,10 @@ import Want from '@ohos.application.Want'; ...@@ -22,10 +22,10 @@ import Want from '@ohos.application.Want';
| bundleName | string | No | Bundle name.| | bundleName | string | No | Bundle name.|
| abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.| | abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.|
| uri | string | No | URI information to match. If **uri** is specified in a **Want** object, the **Want** object will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.| | uri | string | No | URI information to match. If **uri** is specified in a **Want** object, the **Want** object will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.|
| type | string | No | MIME type, that is, the type of the file to open, for example, **text/xml** and **image/***. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com. | | type | string | No | MIME type, that is, the type of the file to open, for example, **'text/xml'** and **'image/*'**. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com. |
| flags | number | No | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-ability-wantConstant.md#wantConstant.Flags).| | flags | number | No | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-ability-wantConstant.md#wantConstant.Flags).|
| action | string | No | Action to take, such as viewing and sharing application details. In implicit **Want**, you can define this attribute and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details, see [action](js-apis-app-ability-wantConstant.md#wantConstant.Action). For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](application-models/explicit-implicit-want-mappings.md). | | action | string | No | Action to take, such as viewing and sharing application details. In implicit **Want**, you can define this attribute and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details, see [action](js-apis-app-ability-wantConstant.md#wantConstant.Action). For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](application-models/explicit-implicit-want-mappings.md). |
| parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>**ohos.aafwk.callerPid**: PID of the caller.<br>**ohos.aafwk.param.callerToken**: token of the caller.<br>**ohos.aafwk.param.callerUid**: UID in [bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information. | | parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>- **ohos.aafwk.callerPid**: PID of the caller.<br>- **ohos.aafwk.param.callerToken**: token of the caller.<br>- **ohos.aafwk.param.callerUid**: UID in [bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information.<br>- **component.startup.newRules**: whether to enable the new control rule.<br>- **moduleName**: module name of the caller. No matter what this field is set to, the correct module name will be sent to the peer.<br>- **ohos.dlp.params.sandbox**: available only for DLP files. |
| entities | Array\<string> | No | Additional category information (such as browser and video player) of the ability. It is a supplement to the **action** field for implicit Want. and is used to filter ability types. For details, see [entity](js-apis-app-ability-wantConstant.md#wantConstant.Entity). | | entities | Array\<string> | No | Additional category information (such as browser and video player) of the ability. It is a supplement to the **action** field for implicit Want. and is used to filter ability types. For details, see [entity](js-apis-app-ability-wantConstant.md#wantConstant.Entity). |
| moduleName<sup>9+</sup> | string | No | Module to which the ability belongs.| | moduleName<sup>9+</sup> | string | No | Module to which the ability belongs.|
...@@ -35,15 +35,15 @@ import Want from '@ohos.application.Want'; ...@@ -35,15 +35,15 @@ import Want from '@ohos.application.Want';
```ts ```ts
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "EntryAbility", 'abilityName': 'EntryAbility',
"moduleName": "entry" // moduleName is optional. 'moduleName': 'entry' // moduleName is optional.
}; };
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability. // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code) console.log('error.code = ${error.code}');
}) });
``` ```
- Data is transferred through user-defined fields. The following data types are supported (called in a UIAbility object, where context in the example is the context object of the UIAbility): - Data is transferred through user-defined fields. The following data types are supported (called in a UIAbility object, where context in the example is the context object of the UIAbility):
...@@ -51,84 +51,84 @@ import Want from '@ohos.application.Want'; ...@@ -51,84 +51,84 @@ import Want from '@ohos.application.Want';
* String * String
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
keyForString: "str", keyForString: 'str',
}, },
} };
``` ```
* Number * Number
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
keyForInt: 100, keyForInt: 100,
keyForDouble: 99.99, keyForDouble: 99.99,
}, },
} };
``` ```
* Boolean * Boolean
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
keyForBool: true, keyForBool: true,
}, },
} };
``` ```
* Object * Object
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
keyForObject: { keyForObject: {
keyForObjectString: "str", keyForObjectString: 'str',
keyForObjectInt: -200, keyForObjectInt: -200,
keyForObjectDouble: 35.5, keyForObjectDouble: 35.5,
keyForObjectBool: false, keyForObjectBool: false,
}, },
}, },
} };
``` ```
* Array * Array
```ts ```ts
let want = { let want = {
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
keyForArrayString: ["str1", "str2", "str3"], keyForArrayString: ['str1', 'str2', 'str3'],
keyForArrayInt: [100, 200, 300, 400], keyForArrayInt: [100, 200, 300, 400],
keyForArrayDouble: [0.1, 0.2], keyForArrayDouble: [0.1, 0.2],
keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}], keyForArrayObject: [{obj1: 'aaa'}, {obj2: 100}],
}, },
} };
``` ```
* File descriptor (FD) * File descriptor (FD)
```ts ```ts
import fileio from '@ohos.fileio'; import fileio from '@ohos.fileio';
let fd; let fd;
try { try {
fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); fd = fileio.openSync('/data/storage/el2/base/haps/pic.png');
} catch(e) { } catch(e) {
console.log("openSync fail:" + JSON.stringify(e)); console.log('openSync fail: ${JSON.stringify(e)}');
} }
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "EntryAbility", 'abilityName': 'EntryAbility',
"moduleName": "entry", // moduleName is optional. 'moduleName': 'entry', // moduleName is optional.
"parameters": { 'parameters': {
"keyFd":{"type":"FD", "value":fd} 'keyFd':{'type':'FD', 'value':fd}
} }
}; };
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability. // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code) console.log('error.code = ${error.code}');
}) });
``` ```
- For more details and examples, see [Want](../../application-models/want-overview.md). - For more details and examples, see [Want](../../application-models/want-overview.md).
......
...@@ -22,7 +22,7 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility'; ...@@ -22,7 +22,7 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility';
| Name | Type| Readable| Writable| Description | | Name | Type| Readable| Writable| Description |
| --------- | -------- | ---- | ---- | ------------------------- | | --------- | -------- | ---- | ---- | ------------------------- |
| context | [ExtensionContext](js-apis-inner-application-extensionContext.md) | Yes | No | Context of an Extension ability. | | context | [WindowExtensionContext](js-apis-inner-application-windowExtensionContext.md) | Yes | No | Context of an Extension ability. |
## WindowExtensionAbility.onConnect ## WindowExtensionAbility.onConnect
...@@ -44,7 +44,7 @@ Called when this Window Extension ability is connected to an ability for the fir ...@@ -44,7 +44,7 @@ Called when this Window Extension ability is connected to an ability for the fir
export default class MyWindowExtensionAbility extends WindowExtensionAbility { export default class MyWindowExtensionAbility extends WindowExtensionAbility {
onConnect(want) { onConnect(want) {
console.info('WindowExtAbility onConnect ' + want.abilityName); console.info('WindowExtAbility onConnect, abilityName: ${want.abilityName}');
} }
} }
...@@ -71,7 +71,7 @@ Called when this Window Extension ability is disconnected from all connected abi ...@@ -71,7 +71,7 @@ Called when this Window Extension ability is disconnected from all connected abi
export default class MyWindowExtensionAbility extends WindowExtensionAbility { export default class MyWindowExtensionAbility extends WindowExtensionAbility {
onDisconnect(want) { onDisconnect(want) {
console.info('WindowExtAbility onDisconnect ' + want.abilityName); console.info('WindowExtAbility onDisconnect, abilityName: ${want.abilityName}');
} }
} }
...@@ -100,10 +100,10 @@ export default class MyWindowExtensionAbility extends WindowExtensionAbility { ...@@ -100,10 +100,10 @@ export default class MyWindowExtensionAbility extends WindowExtensionAbility {
onWindowReady(window) { onWindowReady(window) {
window.loadContent('WindowExtAbility/pages/index1').then(() => { window.loadContent('WindowExtAbility/pages/index1').then(() => {
window.getProperties().then((pro) => { window.getProperties().then((pro) => {
console.log('WindowExtension ' + JSON.stringify(pro)); console.log('WindowExtension pro: ${JSON.stringify(pro)}');
}) });
window.show(); window.show();
}) });
} }
} }
......
...@@ -9,3 +9,26 @@ ...@@ -9,3 +9,26 @@
| onConnect<sup>7+</sup> | function | Yes | Callback invoked when a connection is set up. | | onConnect<sup>7+</sup> | function | Yes | Callback invoked when a connection is set up. |
| onDisconnect<sup>7+</sup> | function | Yes | Callback invoked when a connection is interrupted. | | onDisconnect<sup>7+</sup> | function | Yes | Callback invoked when a connection is interrupted. |
| onFailed<sup>7+</sup> | function | Yes | Callback invoked when a connection fails.| | onFailed<sup>7+</sup> | function | Yes | Callback invoked when a connection fails.|
**Example**
```ts
let want = {
bundleName: 'com.example.myapp',
abilityName: 'MyAbility'
};
let connectOptions = {
onConnect(elementName, remote) {
console.log('onConnect elementName: ${elementName}');
},
onDisconnect(elementName) {
console.log('onDisconnect elementName: ${elementName}');
},
onFailed(code) {
console.error('onFailed code: ${code}');
}
};
let connection = this.context.connectAbility(want, connectOptions);
```
...@@ -35,12 +35,12 @@ Opens a file with a specified URI. This API uses an asynchronous callback to ret ...@@ -35,12 +35,12 @@ Opens a file with a specified URI. This API uses an asynchronous callback to ret
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var mode = "rw"; let mode = 'rw';
DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err, data) => { DAHelper.openFile('dataability:///com.example.DataAbility', mode, (err, data) => {
console.info("openFile err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('openFile err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -69,12 +69,12 @@ Opens a file with a specified URI. This API uses a promise to return a file desc ...@@ -69,12 +69,12 @@ Opens a file with a specified URI. This API uses a promise to return a file desc
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var mode = "rw"; let mode = 'rw';
DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) => { DAHelper.openFile('dataability:///com.example.DataAbility', mode).then((data) => {
console.info("openFile data: " + JSON.stringify(data)); console.info('openFile data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -90,7 +90,7 @@ Registers an observer to listen for changes in the data specified by a given URI ...@@ -90,7 +90,7 @@ Registers an observer to listen for changes in the data specified by a given URI
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | Yes | The value **dataChange** means data changes. | | type | string | Yes | The value **'dataChange'** means data changes. |
| uri | string | Yes | URI of the data.| | uri | string | Yes | URI of the data.|
| callback | AsyncCallback\<void> | Yes | Callback invoked when the data is changed. | | callback | AsyncCallback\<void> | Yes | Callback invoked when the data is changed. |
...@@ -98,15 +98,15 @@ Registers an observer to listen for changes in the data specified by a given URI ...@@ -98,15 +98,15 @@ Registers an observer to listen for changes in the data specified by a given URI
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
function onChangeNotify() { function onChangeNotify() {
console.info("onChangeNotify call back"); console.info('onChangeNotify call back');
}; };
DAHelper.on( DAHelper.on(
"dataChange", 'dataChange',
"dataability:///com.example.DataAbility", 'dataability:///com.example.DataAbility',
onChangeNotify onChangeNotify
); );
``` ```
...@@ -123,7 +123,7 @@ Deregisters the observer that listens for changes in the data specified by a giv ...@@ -123,7 +123,7 @@ Deregisters the observer that listens for changes in the data specified by a giv
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | Yes | The value **dataChange** means data changes. | | type | string | Yes | The value **'dataChange'** means data changes. |
| uri | string | Yes | URI of the data.| | uri | string | Yes | URI of the data.|
| callback | AsyncCallback\<void> | No | Callback of the listener to deregister. If the callback is set to **null**, all data change listeners are canceled. | | callback | AsyncCallback\<void> | No | Callback of the listener to deregister. If the callback is set to **null**, all data change listeners are canceled. |
...@@ -131,20 +131,20 @@ Deregisters the observer that listens for changes in the data specified by a giv ...@@ -131,20 +131,20 @@ Deregisters the observer that listens for changes in the data specified by a giv
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
function onChangeNotify() { function onChangeNotify() {
console.info("onChangeNotify call back"); console.info('onChangeNotify call back');
}; };
DAHelper.off( DAHelper.off(
"dataChange", 'dataChange',
"dataability:///com.example.DataAbility", 'dataability:///com.example.DataAbility',
onChangeNotify onChangeNotify
); );
DAHelper.off( DAHelper.off(
"dataChange", 'dataChange',
"dataability:///com.example.DataAbility", 'dataability:///com.example.DataAbility',
); );
``` ```
...@@ -167,11 +167,11 @@ Obtains the media resource type of the data specified by a given URI. This API u ...@@ -167,11 +167,11 @@ Obtains the media resource type of the data specified by a given URI. This API u
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => { DAHelper.getType('dataability:///com.example.DataAbility', (err, data) => {
console.info("getType err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getType err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -199,11 +199,11 @@ Obtains the media resource type of the data specified by a given URI. This API u ...@@ -199,11 +199,11 @@ Obtains the media resource type of the data specified by a given URI. This API u
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.getType("dataability:///com.example.DataAbility").then((data) => { DAHelper.getType('dataability:///com.example.DataAbility').then((data) => {
console.info("getType data: " + JSON.stringify(data)); console.info('getType data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -227,11 +227,11 @@ Obtains the supported media resource types of a specified file. This API uses an ...@@ -227,11 +227,11 @@ Obtains the supported media resource types of a specified file. This API uses an
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.getFileTypes( "dataability:///com.example.DataAbility", "image/*", (err, data) => { DAHelper.getFileTypes( 'dataability:///com.example.DataAbility', 'image/*', (err, data) => {
console.info("getFileTypes err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getFileTypes err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -260,11 +260,11 @@ Obtains the supported media resource types of a specified file. This API uses a ...@@ -260,11 +260,11 @@ Obtains the supported media resource types of a specified file. This API uses a
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.getFileTypes("dataability:///com.example.DataAbility", "image/*").then((data) => { DAHelper.getFileTypes('dataability:///com.example.DataAbility', 'image/*').then((data) => {
console.info("getFileTypes data: " + JSON.stringify(data)); console.info('getFileTypes data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -287,11 +287,11 @@ Converts the URI that refers to a Data ability into a normalized URI. This API u ...@@ -287,11 +287,11 @@ Converts the URI that refers to a Data ability into a normalized URI. This API u
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.normalizeUri("dataability:///com.example.DataAbility", (err, data) => { DAHelper.normalizeUri('dataability:///com.example.DataAbility', (err, data) => {
console.info("normalizeUri err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('normalizeUri err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -319,11 +319,11 @@ Converts the URI that refers to a Data ability into a normalized URI. This API u ...@@ -319,11 +319,11 @@ Converts the URI that refers to a Data ability into a normalized URI. This API u
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.normalizeUri("dataability:///com.example.DataAbility",).then((data) => { DAHelper.normalizeUri('dataability:///com.example.DataAbility',).then((data) => {
console.info("normalizeUri data: " + JSON.stringify(data)); console.info('normalizeUri data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -346,11 +346,11 @@ Converts a normalized URI generated by **DataAbilityHelper.normalizeUri(uri: str ...@@ -346,11 +346,11 @@ Converts a normalized URI generated by **DataAbilityHelper.normalizeUri(uri: str
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.denormalizeUri("dataability:///com.example.DataAbility", (err, data) => { DAHelper.denormalizeUri('dataability:///com.example.DataAbility', (err, data) => {
console.info("denormalizeUri err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('denormalizeUri err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -378,11 +378,11 @@ Converts a normalized URI generated by **DataAbilityHelper.normalizeUri(uri: str ...@@ -378,11 +378,11 @@ Converts a normalized URI generated by **DataAbilityHelper.normalizeUri(uri: str
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) => { DAHelper.denormalizeUri('dataability:///com.example.DataAbility',).then((data) => {
console.info("denormalizeUri data: " + JSON.stringify(data)); console.info('denormalizeUri data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -405,11 +405,11 @@ Notifies the registered observer of a change to the data specified by the URI. T ...@@ -405,11 +405,11 @@ Notifies the registered observer of a change to the data specified by the URI. T
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.notifyChange("dataability:///com.example.DataAbility", (err) => { DAHelper.notifyChange('dataability:///com.example.DataAbility', (err) => {
console.info("==========================>Called=======================>"); console.info('==========================>Called=======================>');
}); });
``` ```
...@@ -437,11 +437,11 @@ Notifies the registered observer of a change to the data specified by the URI. T ...@@ -437,11 +437,11 @@ Notifies the registered observer of a change to the data specified by the URI. T
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
DAHelper.notifyChange("dataability:///com.example.DataAbility").then(() => { DAHelper.notifyChange('dataability:///com.example.DataAbility').then(() => {
console.info("================>notifyChangeCallback================>"); console.info('================>notifyChangeCallback================>');
}); });
``` ```
...@@ -465,17 +465,17 @@ Inserts a single data record into the database. This API uses an asynchronous ca ...@@ -465,17 +465,17 @@ Inserts a single data record into the database. This API uses an asynchronous ca
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
const valueBucket = { const valueBucket = {
"name": "rose", 'name': 'rose',
"age": 22, 'age': 22,
"salary": 200.5, 'salary': 200.5,
"blobType": "u8", 'blobType': 'u8',
}; };
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket, (err, data) => { DAHelper.insert('dataability:///com.example.DataAbility', valueBucket, (err, data) => {
console.info("insert err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('insert err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -504,17 +504,17 @@ Inserts a single data record into the database. This API uses a promise to retur ...@@ -504,17 +504,17 @@ Inserts a single data record into the database. This API uses a promise to retur
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
const valueBucket = { const valueBucket = {
"name": "rose1", 'name': 'rose1',
"age": 221, 'age': 221,
"salary": 20.5, 'salary': 20.5,
"blobType": "u8", 'blobType': 'u8',
}; };
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((data) => { DAHelper.insert('dataability:///com.example.DataAbility', valueBucket).then((data) => {
console.info("insert data: " + JSON.stringify(data)); console.info('insert data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -538,14 +538,14 @@ Inserts multiple data records into the database. This API uses an asynchronous c ...@@ -538,14 +538,14 @@ Inserts multiple data records into the database. This API uses an asynchronous c
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, let cars = new Array({'name': 'roe11', 'age': 21, 'salary': 20.5, 'blobType': 'u8',},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {'name': 'roe12', 'age': 21, 'salary': 20.5, 'blobType': 'u8',},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}); {'name': 'roe13', 'age': 21, 'salary': 20.5, 'blobType': 'u8',});
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars, (err, data) => { DAHelper.batchInsert('dataability:///com.example.DataAbility', cars, (err, data) => {
console.info("batchInsert err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('batchInsert err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -574,14 +574,14 @@ Inserts multiple data records into the database. This API uses a promise to retu ...@@ -574,14 +574,14 @@ Inserts multiple data records into the database. This API uses a promise to retu
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, let cars = new Array({'name': 'roe11', 'age': 21, 'salary': 20.5, 'blobType': 'u8',},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {'name': 'roe12', 'age': 21, 'salary': 20.5, 'blobType': 'u8',},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}); {'name': 'roe13', 'age': 21, 'salary': 20.5, 'blobType': 'u8',});
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars).then((data) => { DAHelper.batchInsert('dataability:///com.example.DataAbility', cars).then((data) => {
console.info("batchInsert data: " + JSON.stringify(data)); console.info('batchInsert data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -606,12 +606,12 @@ Deletes one or more data records from the database. This API uses an asynchronou ...@@ -606,12 +606,12 @@ Deletes one or more data records from the database. This API uses an asynchronou
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.delete("dataability:///com.example.DataAbility", da, (err, data) => { DAHelper.delete('dataability:///com.example.DataAbility', da, (err, data) => {
console.info("delete err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('delete err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -641,12 +641,12 @@ Deletes one or more data records from the database. This API uses a promise to r ...@@ -641,12 +641,12 @@ Deletes one or more data records from the database. This API uses a promise to r
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.delete("dataability:///com.example.DataAbility", da).then((data) => { DAHelper.delete('dataability:///com.example.DataAbility', da).then((data) => {
console.info("delete data: " + JSON.stringify(data)); console.info('delete data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -672,18 +672,18 @@ Updates data records in the database. This API uses an asynchronous callback to ...@@ -672,18 +672,18 @@ Updates data records in the database. This API uses an asynchronous callback to
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
const va = { const va = {
"name": "roe1", 'name': 'roe1',
"age": 21, 'age': 21,
"salary": 20.5, 'salary': 20.5,
"blobType": "u8", 'blobType': 'u8',
}; };
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.update("dataability:///com.example.DataAbility", va, da, (err, data) => { DAHelper.update('dataability:///com.example.DataAbility', va, da, (err, data) => {
console.info("update err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('update err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -714,18 +714,18 @@ Updates data records in the database. This API uses a promise to return the resu ...@@ -714,18 +714,18 @@ Updates data records in the database. This API uses a promise to return the resu
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
const va = { const va = {
"name": "roe1", 'name': 'roe1',
"age": 21, 'age': 21,
"salary": 20.5, 'salary': 20.5,
"blobType": "u8", 'blobType': 'u8',
}; };
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.update("dataability:///com.example.DataAbility", va, da).then((data) => { DAHelper.update('dataability:///com.example.DataAbility', va, da).then((data) => {
console.info("update data: " + JSON.stringify(data)); console.info('update data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -751,13 +751,13 @@ Queries data in the database. This API uses an asynchronous callback to return t ...@@ -751,13 +751,13 @@ Queries data in the database. This API uses an asynchronous callback to return t
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var cars=new Array("value1", "value2", "value3", "value4"); let cars=new Array('value1', 'value2', 'value3', 'value4');
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.query("dataability:///com.example.DataAbility", cars, da, (err, data) => { DAHelper.query('dataability:///com.example.DataAbility', cars, da, (err, data) => {
console.info("query err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('query err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -790,13 +790,13 @@ Queries data in the database. This API uses a promise to return the result. ...@@ -790,13 +790,13 @@ Queries data in the database. This API uses a promise to return the result.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility'; import ohos_data_ability from '@ohos.data.dataAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( let DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" 'dataability:///com.example.DataAbility'
); );
var cars = new Array("value1", "value2", "value3", "value4"); let cars = new Array('value1', 'value2', 'value3', 'value4');
let da = new ohos_data_ability.DataAbilityPredicates(); let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.query("dataability:///com.example.DataAbility", cars, da).then((data) => { DAHelper.query('dataability:///com.example.DataAbility', cars, da).then((data) => {
console.info("query data: " + JSON.stringify(data)); console.info('query data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -812,7 +812,7 @@ Calls an extended API of the DataAbility. This API uses an asynchronous callback ...@@ -812,7 +812,7 @@ Calls an extended API of the DataAbility. This API uses an asynchronous callback
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | Yes | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx". | | uri | string | Yes | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'. |
| method | string | Yes | Name of the API to call. | | method | string | Yes | Name of the API to call. |
| arg | string | Yes | Parameter to pass in. | | arg | string | Yes | Parameter to pass in. |
| extras | [PacMap](#pacmap) | Yes | Key-value pair parameter. | | extras | [PacMap](#pacmap) | Yes | Key-value pair parameter. |
...@@ -824,15 +824,15 @@ Calls an extended API of the DataAbility. This API uses an asynchronous callback ...@@ -824,15 +824,15 @@ Calls an extended API of the DataAbility. This API uses an asynchronous callback
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility" 'dataability:///com.example.jsapidemo.UserDataAbility'
); );
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", dataAbilityHelper.call('dataability:///com.example.jsapidemo.UserDataAbility',
"method", "arg", {"key1":"value1"}, (err, data) => { 'method', 'arg', {'key1':'value1'}, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + err); console.error('Operation failed. Cause: ${err}');
return; return;
} }
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ${data}');
}); });
``` ```
...@@ -848,7 +848,7 @@ Calls an extended API of the DataAbility. This API uses a promise to return the ...@@ -848,7 +848,7 @@ Calls an extended API of the DataAbility. This API uses a promise to return the
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | Yes | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx". | | uri | string | Yes | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'. |
| method | string | Yes | Name of the API to call. | | method | string | Yes | Name of the API to call. |
| arg | string | Yes | Parameter to pass in. | | arg | string | Yes | Parameter to pass in. |
| extras | [PacMap](#pacmap) | Yes | Key-value pair parameter. | | extras | [PacMap](#pacmap) | Yes | Key-value pair parameter. |
...@@ -865,13 +865,13 @@ Calls an extended API of the DataAbility. This API uses a promise to return the ...@@ -865,13 +865,13 @@ Calls an extended API of the DataAbility. This API uses a promise to return the
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility" 'dataability:///com.example.jsapidemo.UserDataAbility'
); );
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", dataAbilityHelper.call('dataability:///com.example.jsapidemo.UserDataAbility',
"method", "arg", {"key1":"value1"}).then((data) => { 'method', 'arg', {'key1':'value1'}).then((data) => {
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ${data}');
}).catch((error) => { }).catch((error) => {
console.error('Operation failed. Cause: ' + error); console.error('Operation failed. Cause: ${error}');
}); });
``` ```
...@@ -887,7 +887,7 @@ Operates data in the database in batches. This API uses an asynchronous callback ...@@ -887,7 +887,7 @@ Operates data in the database in batches. This API uses an asynchronous callback
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ----------| ---------------------------------| ---- | ------------------------------------------------ | | ----------| ---------------------------------| ---- | ------------------------------------------------ |
| uri | string | Yes | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx".| | uri | string | Yes | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'.|
| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | Yes | An array holding the data operations on the database. | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | Yes | An array holding the data operations on the database. |
| callback | AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | Yes | Callback used to return the result of each operation in the **DataAbilityResult** array. | | callback | AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | Yes | Callback used to return the result of each operation in the **DataAbilityResult** array. |
...@@ -899,14 +899,14 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -899,14 +899,14 @@ import featureAbility from '@ohos.ability.featureAbility';
// Select the operations to be performed on the database according to the DataAbilityOperation array. // Select the operations to be performed on the database according to the DataAbilityOperation array.
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility" 'dataability:///com.example.jsapidemo.UserDataAbility'
); );
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => { dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', op, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + err); console.error('Operation failed. Cause: ${err}');
return; return;
} }
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ${data}');
}); });
``` ```
...@@ -922,7 +922,7 @@ Operates data in the database in batches. This API uses a promise to return the ...@@ -922,7 +922,7 @@ Operates data in the database in batches. This API uses a promise to return the
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | -------------------------------| ---- | ------------------------------------------------ | | ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | Yes | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx".| | uri | string | Yes | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'.|
| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | Yes | An array holding the data operations on the database. | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | Yes | An array holding the data operations on the database. |
**Return value** **Return value**
...@@ -939,12 +939,12 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -939,12 +939,12 @@ import featureAbility from '@ohos.ability.featureAbility';
// Select the operations to be performed on the database according to the DataAbilityOperation array. // Select the operations to be performed on the database according to the DataAbilityOperation array.
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility" 'dataability:///com.example.jsapidemo.UserDataAbility'
); );
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op).then((data) => { dataAbilityHelper.executeBatch('dataability:///com.example.jsapidemo.UserDataAbility', op).then((data) => {
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ${data}');
}).catch((error) => { }).catch((error) => {
console.error('Operation failed. Cause: ' + error); console.error('Operation failed. Cause: ${error}');
}); });
``` ```
......
...@@ -11,7 +11,7 @@ The **DataAbilityOperation** module defines the operation on DataAbilities. It c ...@@ -11,7 +11,7 @@ The **DataAbilityOperation** module defines the operation on DataAbilities. It c
| Name | Template | Mandatory| Description | | Name | Template | Mandatory| Description |
| -------- | -------- | --------| -------- | | -------- | -------- | --------| -------- |
| uri | string | Yes | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx". | | uri | string | Yes | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'. |
| type | featureAbility.DataAbilityOperationType | Yes | Operation type. | | type | featureAbility.DataAbilityOperationType | Yes | Operation type. |
| valuesBucket? | rdb.ValuesBucket | No | Data value to set. | | valuesBucket? | rdb.ValuesBucket | No | Data value to set. |
| valueBackReferences? | rdb.ValuesBucket | No | **ValuesBucket** object that contains a set of key-value pairs. | | valueBackReferences? | rdb.ValuesBucket | No | **ValuesBucket** object that contains a set of key-value pairs. |
......
...@@ -11,33 +11,33 @@ The **DataAbilityResult** module defines the operation result on DataAbilities. ...@@ -11,33 +11,33 @@ The **DataAbilityResult** module defines the operation result on DataAbilities.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| uri? | string | No | URI of the DataAbility. Example: "dataability:///com.example.xxx.xxxx". | | uri? | string | No | URI of the DataAbility. Example: 'dataability:///com.example.xxx.xxxx'. |
| count? | number | No | Number of rows affected by the operation. | | count? | number | No | Number of rows affected by the operation. |
**Example** **Example**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
// Perform database operations in batches. // Perform database operations in batches.
function executeBatchOperation() { function executeBatchOperation() {
let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility"); let dataAbilityUri = ('dataability:///com.example.myapplication.TestDataAbility');
let DAHelper; let DAHelper;
try { try {
DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri);
if (DAHelper == null) { if (DAHelper === null) {
console.error('DAHelper is null'); console.error('DAHelper is null');
return; return;
} }
} catch (err) { } catch (err) {
console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err)); console.error('acquireDataAbilityHelper fail, error: ${JSON.stringify(err)}');
return; return;
} }
let valueBucket = { let valueBucket = {
"name": "DataAbilityHelperTest", 'name': 'DataAbilityHelperTest',
"age": 24, 'age': 24,
"salary": 2024.20, 'salary': 2024.20,
}; };
let operations = [ let operations = [
{ {
...@@ -64,14 +64,14 @@ function executeBatchOperation() { ...@@ -64,14 +64,14 @@ function executeBatchOperation() {
DAHelper.executeBatch(dataAbilityUri, operations).then((data) => { DAHelper.executeBatch(dataAbilityUri, operations).then((data) => {
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
let dataAbilityResult = data[i]; let dataAbilityResult = data[i];
console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri); console.log('dataAbilityResult.uri: ${dataAbilityResult.uri}');
console.log('dataAbilityResult.count: ' + dataAbilityResult.count); console.log('dataAbilityResult.count: ${dataAbilityResult.count}');
} }
}).catch(err => { }).catch(err => {
console.error('executeBatch error: ' + JSON.stringify(err)); console.error('executeBatch error: ${JSON.stringify(err)}');
}); });
} catch (err) { } catch (err) {
console.error('executeBatch error: ' + JSON.stringify(err)); console.error('executeBatch error: ${JSON.stringify(err)}');
} }
} }
``` ```
...@@ -16,31 +16,31 @@ The **StartAbilityParameter** module defines the parameters for starting an abil ...@@ -16,31 +16,31 @@ The **StartAbilityParameter** module defines the parameters for starting an abil
**Example** **Example**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
let Want = { let Want = {
bundleName: "com.example.abilityStartSettingApp2", bundleName: 'com.example.abilityStartSettingApp2',
abilityName: "com.example.abilityStartSettingApp.EntryAbility", abilityName: 'com.example.abilityStartSettingApp.EntryAbility',
} };
let abilityStartSetting ={ let abilityStartSetting ={
[featureAbility.AbilityStartSetting.BOUNDS_KEY] : [100,200,300,400], [featureAbility.AbilityStartSetting.BOUNDS_KEY] : [100,200,300,400],
[featureAbility.AbilityStartSetting.WINDOW_MODE_KEY] : [featureAbility.AbilityStartSetting.WINDOW_MODE_KEY] :
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED, featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED,
[featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1, [featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1,
} };
let startAbilityParameter = { let startAbilityParameter = {
want : Want, want : Want,
abilityStartSetting : abilityStartSetting abilityStartSetting : abilityStartSetting
} };
try { try {
featureAbility.startAbility(startAbilityParameter, (err, data) => { featureAbility.startAbility(startAbilityParameter, (err, data) => {
console.log('errCode : ' + JSON.stringify(err)); console.log('errCode : ${JSON.stringify(err)}');
console.log('data : ' + JSON.stringify(data)); console.log('data : ${JSON.stringify(data)}');
}); });
} catch(error) { } catch(error) {
console.log("startAbility error: " + JSON.stringify(error)); console.log('startAbility error: ${JSON.stringify(error)}');
} }
``` ```
...@@ -4,7 +4,7 @@ Want is a carrier for information transfer between objects (application componen ...@@ -4,7 +4,7 @@ Want is a carrier for information transfer between objects (application componen
> **NOTE** > **NOTE**
> >
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The APIs of this module are supported since API version 6 and deprecated since API version 9. You are advised to use [@ohos.app.ability.Want](js-apis-app-ability-want.md) instead. Newly added APIs will be marked with a superscript to indicate their earliest API version.
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
...@@ -14,10 +14,10 @@ Want is a carrier for information transfer between objects (application componen ...@@ -14,10 +14,10 @@ Want is a carrier for information transfer between objects (application componen
| bundleName | string | No | Bundle name.| | bundleName | string | No | Bundle name.|
| abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.| | abilityName | string | No | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.|
| uri | string | No | URI. If **uri** is specified in a **Want** object, the **Want** object will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.| | uri | string | No | URI. If **uri** is specified in a **Want** object, the **Want** object will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.|
| type | string | No | MIME type, that is, the type of the file to open, for example, **text/xml** and **image/***. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com. | | type | string | No | MIME type, that is, the type of the file to open, for example, **'text/xml'** and **'image/*'**. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com. |
| flags | number | No | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-ability-wantConstant.md#wantconstantflags). | | flags | number | No | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-ability-wantConstant.md#wantconstantflags). |
| action | string | No | Action to take, such as viewing and sharing application details. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details, see [action](js-apis-app-ability-wantConstant.md#wantconstantaction). For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](../../application-models/explicit-implicit-want-mappings.md). | | action | string | No | Action to take, such as viewing and sharing application details. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data. For details, see [action](js-apis-app-ability-wantConstant.md#wantconstantaction). For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](application-models/explicit-implicit-want-mappings.md). |
| parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>**ohos.aafwk.callerPid**: PID of the caller.<br>**ohos.aafwk.param.callerToken**: token of the caller.<br>**ohos.aafwk.param.callerUid**: UID in [bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information. | | parameters | {[key: string]: any} | No | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>**ohos.aafwk.callerPid**: PID of the caller.<br>**ohos.aafwk.param.callerToken**: token of the caller.<br>**ohos.aafwk.param.callerUid**: UID in [bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information.<br>- **component.startup.newRules**: whether to enable the new control rule.<br>- **moduleName**: module name of the caller. No matter what this field is set to, the correct module name will be sent to the peer.<br>- **ohos.dlp.params.sandbox**: available only for DLP files. |
| entities | Array\<string> | No | Additional category information (such as browser and video player) of the target ability. It is a supplement to **action** in implicit Want and is used to filter ability types. For details, see [entity](js-apis-app-ability-wantConstant.md#wantconstantentity). | | entities | Array\<string> | No | Additional category information (such as browser and video player) of the target ability. It is a supplement to **action** in implicit Want and is used to filter ability types. For details, see [entity](js-apis-app-ability-wantConstant.md#wantconstantentity). |
| moduleName<sup>9+</sup> | string | No | Module to which the ability belongs.| | moduleName<sup>9+</sup> | string | No | Module to which the ability belongs.|
...@@ -27,15 +27,15 @@ Want is a carrier for information transfer between objects (application componen ...@@ -27,15 +27,15 @@ Want is a carrier for information transfer between objects (application componen
```ts ```ts
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "EntryAbility", 'abilityName': 'EntryAbility',
"moduleName": "entry" // moduleName is optional. 'moduleName': 'entry' // moduleName is optional.
}; };
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability. // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code) console.log('error.code = ${error.code}');
}) });
``` ```
- Passing a file descriptor (FD) (called in the UIAbility object, where context in the example is the context object of the UIAbility): - Passing a file descriptor (FD) (called in the UIAbility object, where context in the example is the context object of the UIAbility):
...@@ -46,26 +46,26 @@ Want is a carrier for information transfer between objects (application componen ...@@ -46,26 +46,26 @@ Want is a carrier for information transfer between objects (application componen
// ... // ...
let fd; let fd;
try { try {
fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); fd = fileio.openSync('/data/storage/el2/base/haps/pic.png');
} catch(e) { } catch(e) {
console.log("openSync fail:" + JSON.stringify(e)); console.log('openSync fail: ${JSON.stringify(e)}');
} }
let want = { let want = {
"deviceId": "", // An empty deviceId indicates the local device. 'deviceId': '', // An empty deviceId indicates the local device.
"bundleName": "com.example.myapplication", 'bundleName': 'com.example.myapplication',
"abilityName": "EntryAbility", 'abilityName': 'EntryAbility',
"moduleName": "entry", // moduleName is optional. 'moduleName': 'entry', // moduleName is optional.
"parameters": { 'parameters': {
"keyFd":{"type":"FD", "value":fd} 'keyFd':{'type':'FD', 'value':fd}
} }
}; };
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
// Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability. // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
console.log("error.code = " + error.code) console.log('error.code = ${error.code}');
}) });
// ... // ...
``` ```
- For more details and examples, see [Want](../../application-models/want-overview.md). - For more details and examples, see [Want](../../application-models/want-overview.md).
<!--no_check-->
...@@ -14,9 +14,9 @@ The **Context** object is created in a **featureAbility** and returned through i ...@@ -14,9 +14,9 @@ The **Context** object is created in a **featureAbility** and returned through i
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => { context.getOrCreateLocalDir().then((data) => {
console.info("getOrCreateLocalDir data: " + JSON.stringify(data)); console.info('getOrCreateLocalDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -40,9 +40,9 @@ If this API is called for the first time, a root directory will be created. ...@@ -40,9 +40,9 @@ If this API is called for the first time, a root directory will be created.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getOrCreateLocalDir((err, data)=>{ context.getOrCreateLocalDir((err, data)=>{
console.info("getOrCreateLocalDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getOrCreateLocalDir err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -68,9 +68,9 @@ If this API is called for the first time, a root directory will be created. ...@@ -68,9 +68,9 @@ If this API is called for the first time, a root directory will be created.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => { context.getOrCreateLocalDir().then((data) => {
console.info("getOrCreateLocalDir data: " + JSON.stringify(data)); console.info('getOrCreateLocalDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -95,10 +95,10 @@ Verifies whether a specific PID and UID have the given permission. This API uses ...@@ -95,10 +95,10 @@ Verifies whether a specific PID and UID have the given permission. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle.bundleManager'; import bundle from '@ohos.bundle.bundleManager';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
bundle.getBundleInfo('com.context.test', 1, (err, datainfo) =>{ bundle.getBundleInfo('com.context.test', 1, (err, datainfo) =>{
context.verifyPermission("com.example.permission", {uid:datainfo.appInfo.uid}, (err, data) =>{ context.verifyPermission('com.example.permission', {uid:datainfo.appInfo.uid}, (err, data) =>{
console.info("verifyPermission err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('verifyPermission err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
}); });
``` ```
...@@ -125,9 +125,9 @@ Verifies whether the current PID and UID have the given permission. This API use ...@@ -125,9 +125,9 @@ Verifies whether the current PID and UID have the given permission. This API use
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.verifyPermission("com.example.permission", (err, data) =>{ context.verifyPermission('com.example.permission', (err, data) =>{
console.info("verifyPermission err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('verifyPermission err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -156,10 +156,10 @@ Verifies whether a specific PID and UID have the given permission. This API uses ...@@ -156,10 +156,10 @@ Verifies whether a specific PID and UID have the given permission. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var Permission = {pid:1}; let Permission = {pid:1};
context.verifyPermission('com.context.permission',Permission).then((data) => { context.verifyPermission('com.context.permission',Permission).then((data) => {
console.info("verifyPermission data: " + JSON.stringify(data)); console.info('verifyPermission data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -185,16 +185,16 @@ Requests certain permissions from the system. This API uses an asynchronous call ...@@ -185,16 +185,16 @@ Requests certain permissions from the system. This API uses an asynchronous call
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.requestPermissionsFromUser( context.requestPermissionsFromUser(
["com.example.permission1", ['com.example.permission1',
"com.example.permission2", 'com.example.permission2',
"com.example.permission3", 'com.example.permission3',
"com.example.permission4", 'com.example.permission4',
"com.example.permission5"], 'com.example.permission5'],
1, 1,
(err, data) => { (err, data) => {
console.info("requestPermissionsFromUser err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('requestPermissionsFromUser err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
} }
); );
``` ```
...@@ -225,15 +225,15 @@ Requests certain permissions from the system. This API uses a promise to return ...@@ -225,15 +225,15 @@ Requests certain permissions from the system. This API uses a promise to return
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.requestPermissionsFromUser( context.requestPermissionsFromUser(
["com.example.permission1", ['com.example.permission1',
"com.example.permission2", 'com.example.permission2',
"com.example.permission3", 'com.example.permission3',
"com.example.permission4", 'com.example.permission4',
"com.example.permission5"], 'com.example.permission5'],
1).then((data)=>{ 1).then((data)=>{
console.info("requestPermissionsFromUser data: " + JSON.stringify(data)); console.info('requestPermissionsFromUser data: ${JSON.stringify(data)}');
} }
); );
``` ```
...@@ -258,9 +258,9 @@ Obtains information about the current application. This API uses an asynchronous ...@@ -258,9 +258,9 @@ Obtains information about the current application. This API uses an asynchronous
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getApplicationInfo((err, data) => { context.getApplicationInfo((err, data) => {
console.info("getApplicationInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getApplicationInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -284,9 +284,9 @@ Obtains information about the current application. This API uses a promise to re ...@@ -284,9 +284,9 @@ Obtains information about the current application. This API uses a promise to re
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getApplicationInfo().then((data) => { context.getApplicationInfo().then((data) => {
console.info("getApplicationInfo data: " + JSON.stringify(data)); console.info('getApplicationInfo data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -310,9 +310,9 @@ Obtains the bundle name of this ability. This API uses an asynchronous callback ...@@ -310,9 +310,9 @@ Obtains the bundle name of this ability. This API uses an asynchronous callback
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getBundleName((err, data) => { context.getBundleName((err, data) => {
console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getBundleName err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -336,9 +336,9 @@ Obtains the bundle name of this ability. This API uses a promise to return the r ...@@ -336,9 +336,9 @@ Obtains the bundle name of this ability. This API uses a promise to return the r
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getBundleName().then((data) => { context.getBundleName().then((data) => {
console.info("getBundleName data: " + JSON.stringify(data)); console.info('getBundleName data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -360,9 +360,9 @@ Obtains the display orientation of this ability. This API uses an asynchronous c ...@@ -360,9 +360,9 @@ Obtains the display orientation of this ability. This API uses an asynchronous c
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getDisplayOrientation((err, data) => { context.getDisplayOrientation((err, data) => {
console.info("getDisplayOrientation err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getDisplayOrientation err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -384,9 +384,9 @@ Obtains the display orientation of this ability. This API uses a promise to retu ...@@ -384,9 +384,9 @@ Obtains the display orientation of this ability. This API uses a promise to retu
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getDisplayOrientation().then((data) => { context.getDisplayOrientation().then((data) => {
console.info("getDisplayOrientation data: " + JSON.stringify(data)); console.info('getDisplayOrientation data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -408,9 +408,9 @@ Obtains the external cache directory of the application. This API uses an asynch ...@@ -408,9 +408,9 @@ Obtains the external cache directory of the application. This API uses an asynch
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getExternalCacheDir((err, data) => { context.getExternalCacheDir((err, data) => {
console.info("getExternalCacheDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getExternalCacheDir err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -432,9 +432,9 @@ Obtains the external cache directory of the application. This API uses a promise ...@@ -432,9 +432,9 @@ Obtains the external cache directory of the application. This API uses a promise
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getExternalCacheDir().then((data) => { context.getExternalCacheDir().then((data) => {
console.info("getExternalCacheDir data: " + JSON.stringify(data)); console.info('getExternalCacheDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -458,10 +458,10 @@ Sets the display orientation for this ability. This API uses an asynchronous cal ...@@ -458,10 +458,10 @@ Sets the display orientation for this ability. This API uses an asynchronous cal
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle'; import bundle from '@ohos.bundle';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var orientation = bundle.DisplayOrientation.UNSPECIFIED; let orientation = bundle.DisplayOrientation.UNSPECIFIED;
context.setDisplayOrientation(orientation, (err) => { context.setDisplayOrientation(orientation, (err) => {
console.info("setDisplayOrientation err: " + JSON.stringify(err)); console.info('setDisplayOrientation err: ${JSON.stringify(err)}');
}); });
``` ```
...@@ -485,10 +485,10 @@ Sets the display orientation for this ability. This API uses a promise to return ...@@ -485,10 +485,10 @@ Sets the display orientation for this ability. This API uses a promise to return
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle'; import bundle from '@ohos.bundle';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var orientation = bundle.DisplayOrientation.UNSPECIFIED; let orientation = bundle.DisplayOrientation.UNSPECIFIED;
context.setDisplayOrientation(orientation).then((data) => { context.setDisplayOrientation(orientation).then((data) => {
console.info("setDisplayOrientation data: " + JSON.stringify(data)); console.info('setDisplayOrientation data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -511,10 +511,10 @@ Sets whether to show this feature at the top of the lock screen so that the feat ...@@ -511,10 +511,10 @@ Sets whether to show this feature at the top of the lock screen so that the feat
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var show = true; let show = true;
context.setShowOnLockScreen(show, (err) => { context.setShowOnLockScreen(show, (err) => {
console.info("setShowOnLockScreen err: " + JSON.stringify(err)); console.info('setShowOnLockScreen err: ${JSON.stringify(err)}');
}); });
``` ```
...@@ -542,10 +542,10 @@ Sets whether to show this feature at the top of the lock screen so that the feat ...@@ -542,10 +542,10 @@ Sets whether to show this feature at the top of the lock screen so that the feat
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var show = true; let show = true;
context.setShowOnLockScreen(show).then((data) => { context.setShowOnLockScreen(show).then((data) => {
console.info("setShowOnLockScreen data: " + JSON.stringify(data)); console.info('setShowOnLockScreen data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -568,10 +568,10 @@ Sets whether to wake up the screen when this feature is restored. This API uses ...@@ -568,10 +568,10 @@ Sets whether to wake up the screen when this feature is restored. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var wakeUp = true; let wakeUp = true;
context.setWakeUpScreen(wakeUp, (err) => { context.setWakeUpScreen(wakeUp, (err) => {
console.info("setWakeUpScreen err: " + JSON.stringify(err)); console.info('setWakeUpScreen err: ${JSON.stringify(err)}');
}); });
``` ```
...@@ -599,10 +599,10 @@ Sets whether to wake up the screen when this feature is restored. This API uses ...@@ -599,10 +599,10 @@ Sets whether to wake up the screen when this feature is restored. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
var wakeUp = true; let wakeUp = true;
context.setWakeUpScreen(wakeUp).then((data) => { context.setWakeUpScreen(wakeUp).then((data) => {
console.info("setWakeUpScreen data: " + JSON.stringify(data)); console.info('setWakeUpScreen data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -627,9 +627,9 @@ Obtains information about the current process, including the PID and process nam ...@@ -627,9 +627,9 @@ Obtains information about the current process, including the PID and process nam
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getProcessInfo((err, data) => { context.getProcessInfo((err, data) => {
console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getProcessInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -653,9 +653,9 @@ Obtains information about the current process, including the PID and process nam ...@@ -653,9 +653,9 @@ Obtains information about the current process, including the PID and process nam
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getProcessInfo().then((data) => { context.getProcessInfo().then((data) => {
console.info("getProcessInfo data: " + JSON.stringify(data)); console.info('getProcessInfo data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -681,9 +681,9 @@ This API is available only to Page abilities. ...@@ -681,9 +681,9 @@ This API is available only to Page abilities.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getElementName((err, data) => { context.getElementName((err, data) => {
console.info("getElementName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getElementName err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -709,9 +709,9 @@ This API is available only to Page abilities. ...@@ -709,9 +709,9 @@ This API is available only to Page abilities.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getElementName().then((data) => { context.getElementName().then((data) => {
console.info("getElementName data: " + JSON.stringify(data)); console.info('getElementName data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -733,9 +733,9 @@ Obtains the name of the current process. This API uses an asynchronous callback ...@@ -733,9 +733,9 @@ Obtains the name of the current process. This API uses an asynchronous callback
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getProcessName((err, data) => { context.getProcessName((err, data) => {
console.info("getProcessName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getProcessName err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -759,9 +759,9 @@ Obtains the name of the current process. This API uses a promise to return the r ...@@ -759,9 +759,9 @@ Obtains the name of the current process. This API uses a promise to return the r
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getProcessName().then((data) => { context.getProcessName().then((data) => {
console.info("getProcessName data: " + JSON.stringify(data)); console.info('getProcessName data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -785,9 +785,9 @@ Obtains the bundle name of the caller ability. This API uses an asynchronous cal ...@@ -785,9 +785,9 @@ Obtains the bundle name of the caller ability. This API uses an asynchronous cal
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getCallingBundle((err, data) => { context.getCallingBundle((err, data) => {
console.info("getCallingBundle err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getCallingBundle err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -811,9 +811,9 @@ Obtains the bundle name of the caller ability. This API uses a promise to return ...@@ -811,9 +811,9 @@ Obtains the bundle name of the caller ability. This API uses a promise to return
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getCallingBundle().then((data) => { context.getCallingBundle().then((data) => {
console.info("getCallingBundle data: " + JSON.stringify(data)); console.info('getCallingBundle data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -835,9 +835,9 @@ Obtains the cache directory of the application in the internal storage. This API ...@@ -835,9 +835,9 @@ Obtains the cache directory of the application in the internal storage. This API
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getCacheDir((err, data) => { context.getCacheDir((err, data) => {
console.info("getCacheDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getCacheDir err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -859,9 +859,9 @@ Obtains the cache directory of the application in the internal storage. This API ...@@ -859,9 +859,9 @@ Obtains the cache directory of the application in the internal storage. This API
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getCacheDir().then((data) => { context.getCacheDir().then((data) => {
console.info("getCacheDir data: " + JSON.stringify(data)); console.info('getCacheDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -883,9 +883,9 @@ Obtains the file directory of the application in the internal storage. This API ...@@ -883,9 +883,9 @@ Obtains the file directory of the application in the internal storage. This API
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getFilesDir((err, data) => { context.getFilesDir((err, data) => {
console.info("getFilesDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getFilesDir err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -907,9 +907,9 @@ Obtains the file directory of the application in the internal storage. This API ...@@ -907,9 +907,9 @@ Obtains the file directory of the application in the internal storage. This API
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getFilesDir().then((data) => { context.getFilesDir().then((data) => {
console.info("getFilesDir data: " + JSON.stringify(data)); console.info('getFilesDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -933,9 +933,9 @@ If the distributed file path does not exist, the system will create one and retu ...@@ -933,9 +933,9 @@ If the distributed file path does not exist, the system will create one and retu
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getOrCreateDistributedDir((err, data) => { context.getOrCreateDistributedDir((err, data) => {
console.info("getOrCreateDistributedDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getOrCreateDistributedDir err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -959,9 +959,9 @@ If the distributed file path does not exist, the system will create one and retu ...@@ -959,9 +959,9 @@ If the distributed file path does not exist, the system will create one and retu
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getOrCreateDistributedDir().then((data) => { context.getOrCreateDistributedDir().then((data) => {
console.info("getOrCreateDistributedDir data: " + JSON.stringify(data)); console.info('getOrCreateDistributedDir data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -983,9 +983,9 @@ Obtains the application type. This API uses an asynchronous callback to return t ...@@ -983,9 +983,9 @@ Obtains the application type. This API uses an asynchronous callback to return t
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAppType((err, data) => { context.getAppType((err, data) => {
console.info("getAppType err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getAppType err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1007,9 +1007,9 @@ Obtains the application type. This API uses a promise to return the result. ...@@ -1007,9 +1007,9 @@ Obtains the application type. This API uses a promise to return the result.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAppType().then((data) => { context.getAppType().then((data) => {
console.info("getAppType data: " + JSON.stringify(data)); console.info('getAppType data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1031,9 +1031,9 @@ Obtains the **ModuleInfo** object of the application. This API uses an asynchron ...@@ -1031,9 +1031,9 @@ Obtains the **ModuleInfo** object of the application. This API uses an asynchron
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getHapModuleInfo((err, data) => { context.getHapModuleInfo((err, data) => {
console.info("getHapModuleInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getHapModuleInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1055,9 +1055,9 @@ Obtains the **ModuleInfo** object of the application. This API uses a promise to ...@@ -1055,9 +1055,9 @@ Obtains the **ModuleInfo** object of the application. This API uses a promise to
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getHapModuleInfo().then((data) => { context.getHapModuleInfo().then((data) => {
console.info("getHapModuleInfo data: " + JSON.stringify(data)); console.info('getHapModuleInfo data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1079,9 +1079,9 @@ Obtains the version information of the application. This API uses an asynchronou ...@@ -1079,9 +1079,9 @@ Obtains the version information of the application. This API uses an asynchronou
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAppVersionInfo((err, data) => { context.getAppVersionInfo((err, data) => {
console.info("getAppVersionInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getAppVersionInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1103,9 +1103,9 @@ Obtains the version information of the application. This API uses a promise to r ...@@ -1103,9 +1103,9 @@ Obtains the version information of the application. This API uses a promise to r
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAppVersionInfo().then((data) => { context.getAppVersionInfo().then((data) => {
console.info("getAppVersionInfo data: " + JSON.stringify(data)); console.info('getAppVersionInfo data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1127,9 +1127,9 @@ Obtains information about this ability. This API uses an asynchronous callback t ...@@ -1127,9 +1127,9 @@ Obtains information about this ability. This API uses an asynchronous callback t
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAbilityInfo((err, data) => { context.getAbilityInfo((err, data) => {
console.info("getAbilityInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('getAbilityInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1151,9 +1151,9 @@ Obtains information about this ability. This API uses a promise to return the re ...@@ -1151,9 +1151,9 @@ Obtains information about this ability. This API uses a promise to return the re
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getAbilityInfo().then((data) => { context.getAbilityInfo().then((data) => {
console.info("getAbilityInfo data: " + JSON.stringify(data)); console.info('getAbilityInfo data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1175,7 +1175,7 @@ Obtains the context of the application. ...@@ -1175,7 +1175,7 @@ Obtains the context of the application.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext().getApplicationContext(); let context = featureAbility.getContext().getApplicationContext();
``` ```
## Context.isUpdatingConfigurations<sup>7+</sup> ## Context.isUpdatingConfigurations<sup>7+</sup>
...@@ -1196,9 +1196,9 @@ Checks whether the configuration of this ability is being updated. This API uses ...@@ -1196,9 +1196,9 @@ Checks whether the configuration of this ability is being updated. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.isUpdatingConfigurations((err, data) => { context.isUpdatingConfigurations((err, data) => {
console.info("isUpdatingConfigurations err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info('isUpdatingConfigurations err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1220,9 +1220,9 @@ Checks whether the configuration of this ability is being updated. This API uses ...@@ -1220,9 +1220,9 @@ Checks whether the configuration of this ability is being updated. This API uses
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.isUpdatingConfigurations().then((data) => { context.isUpdatingConfigurations().then((data) => {
console.info("isUpdatingConfigurations data: " + JSON.stringify(data)); console.info('isUpdatingConfigurations data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1244,9 +1244,9 @@ Notifies the system of the time required to draw this page function. This API us ...@@ -1244,9 +1244,9 @@ Notifies the system of the time required to draw this page function. This API us
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.printDrawnCompleted((err) => { context.printDrawnCompleted((err) => {
console.error('printDrawnCompleted err: ' + JSON.stringify(err)); console.error('printDrawnCompleted err: ${JSON.stringify(err)}');
}); });
``` ```
...@@ -1268,9 +1268,9 @@ Notifies the system of the time required to draw this page function. This API us ...@@ -1268,9 +1268,9 @@ Notifies the system of the time required to draw this page function. This API us
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.printDrawnCompleted().then((data) => { context.printDrawnCompleted().then((data) => {
console.info("printDrawnCompleted data: " + JSON.stringify(data)); console.info('printDrawnCompleted data: ${JSON.stringify(data)}');
}); });
``` ```
...@@ -1293,13 +1293,3 @@ context.printDrawnCompleted().then((data) => { ...@@ -1293,13 +1293,3 @@ context.printDrawnCompleted().then((data) => {
| requestCode | Read-only | number | Yes | Request code passed.| | requestCode | Read-only | number | Yes | Request code passed.|
| permissions | Read-only | Array\<string> | Yes | Permissions requested. | | permissions | Read-only | Array\<string> | Yes | Permissions requested. |
| authResults | Read-only | Array\<number> | Yes | Permission request result. | | authResults | Read-only | Array\<number> | Yes | Permission request result. |
## AppVersionInfo<sup>7+</sup>
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
| Name | Type | Readable | Writable | Description |
| ----------- | ------ | ---- | ---- | ------- |
| appName | string | Yes | No | Module name. |
| versionCode | number | Yes | No | Module description.|
| versionName | string | Yes | No | Module description ID.|
...@@ -4,9 +4,7 @@ The **ProcessInfo** module defines process information. You can use [getProcessI ...@@ -4,9 +4,7 @@ The **ProcessInfo** module defines process information. You can use [getProcessI
> **NOTE** > **NOTE**
> >
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 7. The APIs of this module can be used only in the FA model. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> The APIs of this module can be used only in the FA model.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -19,10 +17,12 @@ The **ProcessInfo** module defines process information. You can use [getProcessI ...@@ -19,10 +17,12 @@ The **ProcessInfo** module defines process information. You can use [getProcessI
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); let context = featureAbility.getContext();
context.getProcessInfo((err, data) => { context.getProcessInfo((err, data) => {
console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); if (err.code !== 0) {
console.info('getProcessInfo err: ${JSON.stringify(err)}, data: ${JSON.stringify(data)}');
let pid = data.pid; let pid = data.pid;
let processName = data.processName; let processName = data.processName;
}
}); });
``` ```
...@@ -38,17 +38,17 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r ...@@ -38,17 +38,17 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) => { abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback"); console.info('addAbilityMonitor callback');
}); });
``` ```
...@@ -78,17 +78,17 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul ...@@ -78,17 +78,17 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor).then(() => { abilityDelegator.addAbilityMonitor(monitor).then(() => {
console.info("addAbilityMonitor promise"); console.info('addAbilityMonitor promise');
}); });
``` ```
...@@ -113,17 +113,17 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t ...@@ -113,17 +113,17 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor, (err : any) => { abilityDelegator.removeAbilityMonitor(monitor, (err : any) => {
console.info("removeAbilityMonitor callback"); console.info('removeAbilityMonitor callback');
}); });
``` ```
...@@ -153,17 +153,17 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re ...@@ -153,17 +153,17 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor).then(() => { abilityDelegator.removeAbilityMonitor(monitor).then(() => {
console.info("removeAbilityMonitor promise"); console.info('removeAbilityMonitor promise');
}); });
``` ```
...@@ -188,17 +188,17 @@ Waits for the **Ability** instance that matches the **AbilityMonitor** instance ...@@ -188,17 +188,17 @@ Waits for the **Ability** instance that matches the **AbilityMonitor** instance
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => { abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => {
console.info("waitAbilityMonitor callback"); console.info('waitAbilityMonitor callback');
}); });
``` ```
...@@ -225,17 +225,17 @@ let abilityDelegator; ...@@ -225,17 +225,17 @@ let abilityDelegator;
let timeout = 100; let timeout = 100;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) => { abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) => {
console.info("waitAbilityMonitor callback"); console.info('waitAbilityMonitor callback');
}); });
``` ```
...@@ -268,17 +268,17 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo ...@@ -268,17 +268,17 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => { abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => {
console.info("waitAbilityMonitor promise"); console.info('waitAbilityMonitor promise');
}); });
``` ```
...@@ -333,10 +333,10 @@ let ability; ...@@ -333,10 +333,10 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
let state = abilityDelegator.getAbilityState(ability); let state = abilityDelegator.getAbilityState(ability);
console.info("getAbilityState" + state); console.info('getAbilityState ${state}');
}); });
``` ```
...@@ -362,7 +362,7 @@ let ability; ...@@ -362,7 +362,7 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
}); });
``` ```
...@@ -389,7 +389,7 @@ let ability; ...@@ -389,7 +389,7 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility().then((data : any) => { abilityDelegator.getCurrentTopAbility().then((data : any) => {
console.info("getCurrentTopAbility promise"); console.info('getCurrentTopAbility promise');
ability = data; ability = data;
}); });
``` ```
...@@ -414,13 +414,13 @@ Starts an ability. This API uses an asynchronous callback to return the result. ...@@ -414,13 +414,13 @@ Starts an ability. This API uses an asynchronous callback to return the result.
```ts ```ts
let abilityDelegator; let abilityDelegator;
let want = { let want = {
bundleName: "bundleName", bundleName: 'bundleName',
abilityName: "abilityName" abilityName: 'abilityName'
}; };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want, (err : any, data : any) => { abilityDelegator.startAbility(want, (err : any, data : any) => {
console.info("startAbility callback"); console.info('startAbility callback');
}); });
``` ```
...@@ -449,13 +449,13 @@ Starts an ability. This API uses a promise to return the result. ...@@ -449,13 +449,13 @@ Starts an ability. This API uses a promise to return the result.
```ts ```ts
let abilityDelegator; let abilityDelegator;
let want = { let want = {
bundleName: "bundleName", bundleName: 'bundleName',
abilityName: "abilityName" abilityName: 'abilityName'
}; };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want).then((data: any) => { abilityDelegator.startAbility(want).then((data: any) => {
console.info("startAbility promise"); console.info('startAbility promise');
}); });
``` ```
...@@ -482,10 +482,10 @@ let ability; ...@@ -482,10 +482,10 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
abilityDelegator.doAbilityForeground(ability, (err : any, data : any) => { abilityDelegator.doAbilityForeground(ability, (err : any, data : any) => {
console.info("doAbilityForeground callback"); console.info('doAbilityForeground callback');
}); });
}); });
``` ```
...@@ -518,10 +518,10 @@ let ability; ...@@ -518,10 +518,10 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
abilityDelegator.doAbilityForeground(ability).then((data : any) => { abilityDelegator.doAbilityForeground(ability).then((data : any) => {
console.info("doAbilityForeground promise"); console.info('doAbilityForeground promise');
}); });
}); });
``` ```
...@@ -549,10 +549,10 @@ let ability; ...@@ -549,10 +549,10 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
abilityDelegator.doAbilityBackground(ability, (err : any, data : any) => { abilityDelegator.doAbilityBackground(ability, (err : any, data : any) => {
console.info("doAbilityBackground callback"); console.info('doAbilityBackground callback');
}); });
}); });
``` ```
...@@ -585,10 +585,10 @@ let ability; ...@@ -585,10 +585,10 @@ let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info('getCurrentTopAbility callback');
ability = data; ability = data;
abilityDelegator.doAbilityBackground(ability).then((data : any) => { abilityDelegator.doAbilityBackground(ability).then((data : any) => {
console.info("doAbilityBackground promise"); console.info('doAbilityBackground promise');
}); });
}); });
``` ```
...@@ -611,7 +611,7 @@ Prints log information to the unit test console. ...@@ -611,7 +611,7 @@ Prints log information to the unit test console.
```ts ```ts
let abilityDelegator; let abilityDelegator;
let msg = "msg"; let msg = 'msg';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.printSync(msg); abilityDelegator.printSync(msg);
...@@ -636,11 +636,11 @@ Prints log information to the unit test console. This API uses an asynchronous c ...@@ -636,11 +636,11 @@ Prints log information to the unit test console. This API uses an asynchronous c
```ts ```ts
let abilityDelegator; let abilityDelegator;
let msg = "msg"; let msg = 'msg';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg, (err : any) => { abilityDelegator.print(msg, (err : any) => {
console.info("print callback"); console.info('print callback');
}); });
``` ```
...@@ -668,11 +668,11 @@ Prints log information to the unit test console. This API uses a promise to retu ...@@ -668,11 +668,11 @@ Prints log information to the unit test console. This API uses a promise to retu
```ts ```ts
let abilityDelegator; let abilityDelegator;
let msg = "msg"; let msg = 'msg';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg).then(() => { abilityDelegator.print(msg).then(() => {
console.info("print promise"); console.info('print promise');
}); });
``` ```
...@@ -695,11 +695,11 @@ Executes a shell command. This API uses an asynchronous callback to return the r ...@@ -695,11 +695,11 @@ Executes a shell command. This API uses an asynchronous callback to return the r
```ts ```ts
let abilityDelegator; let abilityDelegator;
let cmd = "cmd"; let cmd = 'cmd';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => { abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
console.info("executeShellCommand callback"); console.info('executeShellCommand callback');
}); });
``` ```
...@@ -723,12 +723,12 @@ Executes a shell command with the timeout period specified. This API uses an asy ...@@ -723,12 +723,12 @@ Executes a shell command with the timeout period specified. This API uses an asy
```ts ```ts
let abilityDelegator; let abilityDelegator;
let cmd = "cmd"; let cmd = 'cmd';
let timeout = 100; let timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
console.info("executeShellCommand callback"); console.info('executeShellCommand callback');
}); });
``` ```
...@@ -757,12 +757,12 @@ Executes a shell command with the timeout period specified. This API uses a prom ...@@ -757,12 +757,12 @@ Executes a shell command with the timeout period specified. This API uses a prom
```ts ```ts
let abilityDelegator; let abilityDelegator;
let cmd = "cmd"; let cmd = 'cmd';
let timeout = 100; let timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
console.info("executeShellCommand promise"); console.info('executeShellCommand promise');
}); });
``` ```
...@@ -786,11 +786,11 @@ Finishes the test and prints log information to the unit test console. This API ...@@ -786,11 +786,11 @@ Finishes the test and prints log information to the unit test console. This API
```ts ```ts
let abilityDelegator; let abilityDelegator;
let msg = "msg"; let msg = 'msg';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0, (err : any) => { abilityDelegator.finishTest(msg, 0, (err : any) => {
console.info("finishTest callback"); console.info('finishTest callback');
}); });
``` ```
...@@ -819,11 +819,11 @@ Finishes the test and prints log information to the unit test console. This API ...@@ -819,11 +819,11 @@ Finishes the test and prints log information to the unit test console. This API
```ts ```ts
let abilityDelegator; let abilityDelegator;
let msg = "msg"; let msg = 'msg';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0).then(() => { abilityDelegator.finishTest(msg, 0).then(() => {
console.info("finishTest promise"); console.info('finishTest promise');
}); });
``` ```
...@@ -848,13 +848,13 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes ...@@ -848,13 +848,13 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes
let abilityDelegator; let abilityDelegator;
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => { abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => {
console.info("addAbilityStageMonitor callback"); console.info('addAbilityStageMonitor callback');
}); });
``` ```
...@@ -884,13 +884,13 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes ...@@ -884,13 +884,13 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes
let abilityDelegator; let abilityDelegator;
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityStageMonitor(monitor).then(() => { abilityDelegator.addAbilityStageMonitor(monitor).then(() => {
console.info("addAbilityStageMonitor promise"); console.info('addAbilityStageMonitor promise');
}); });
``` ```
...@@ -915,13 +915,13 @@ Removes an **AbilityStageMonitor** instance from the application memory. This AP ...@@ -915,13 +915,13 @@ Removes an **AbilityStageMonitor** instance from the application memory. This AP
let abilityDelegator; let abilityDelegator;
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => { abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => {
console.info("removeAbilityStageMonitor callback"); console.info('removeAbilityStageMonitor callback');
}); });
``` ```
...@@ -951,13 +951,13 @@ Removes an **AbilityStageMonitor** object from the application memory. This API ...@@ -951,13 +951,13 @@ Removes an **AbilityStageMonitor** object from the application memory. This API
let abilityDelegator; let abilityDelegator;
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityStageMonitor(monitor).then(() => { abilityDelegator.removeAbilityStageMonitor(monitor).then(() => {
console.info("removeAbilityStageMonitor promise"); console.info('removeAbilityStageMonitor promise');
}); });
``` ```
...@@ -982,17 +982,17 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A ...@@ -982,17 +982,17 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, (err : any, data : any) => { abilityDelegator.waitAbilityStageMonitor(monitor, (err : any, data : any) => {
console.info("waitAbilityStageMonitor callback"); console.info('waitAbilityStageMonitor callback');
}); });
``` ```
...@@ -1023,17 +1023,17 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A ...@@ -1023,17 +1023,17 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A
let abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor).then((data : any) => { abilityDelegator.waitAbilityStageMonitor(monitor).then((data : any) => {
console.info("waitAbilityStageMonitor promise"); console.info('waitAbilityStageMonitor promise');
}); });
``` ```
...@@ -1060,16 +1060,16 @@ let abilityDelegator; ...@@ -1060,16 +1060,16 @@ let abilityDelegator;
let timeout = 100; let timeout = 100;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
let monitor = { let monitor = {
moduleName: "moduleName", moduleName: 'moduleName',
srcEntrance: "srcEntrance", srcEntrance: 'srcEntrance',
} };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => { abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => {
console.info("waitAbilityStageMonitor callback"); console.info('waitAbilityStageMonitor callback');
}); });
``` ```
...@@ -28,5 +28,5 @@ Describes the ability delegator arguments. ...@@ -28,5 +28,5 @@ Describes the ability delegator arguments.
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
var args = AbilityDelegatorRegistry.getArguments(); let args = AbilityDelegatorRegistry.getArguments();
``` ```
...@@ -19,6 +19,7 @@ Describes an ability monitor. ...@@ -19,6 +19,7 @@ Describes an ability monitor.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | | ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| abilityName | string | Yes | Yes | Name of the ability bound to the ability monitor.| | abilityName | string | Yes | Yes | Name of the ability bound to the ability monitor.|
| moduleName? | string | Yes | Yes | Name of the module bound to the ability monitor.|
| onAbilityCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability is created.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.| | onAbilityCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability is created.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.|
| onAbilityForeground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability starts to run in the foreground.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.| | onAbilityForeground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability starts to run in the foreground.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.|
| onAbilityBackground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability starts to run in the background.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.| | onAbilityBackground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | Yes | Yes | Called when the ability starts to run in the background.<br>If this attribute is not set, the corresponding lifecycle callback cannot be received.|
...@@ -33,16 +34,17 @@ Describes an ability monitor. ...@@ -33,16 +34,17 @@ Describes an ability monitor.
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info('onAbilityCreateCallback');
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: 'abilityname',
moduleName: "moduleName",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} };
var abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) => { abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback"); console.info('addAbilityMonitor callback');
}); });
``` ```
...@@ -31,15 +31,15 @@ The ability running information is obtained by calling [getAbilityRunningInfos]( ...@@ -31,15 +31,15 @@ The ability running information is obtained by calling [getAbilityRunningInfos](
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => { abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); console.log('getAbilityRunningInfos err: ${err}, data: ${JSON.stringify(data)}');
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
let abilityinfo = data[i]; let abilityinfo = data[i];
console.log("abilityinfo.ability: " + JSON.stringify(abilityinfo.ability)); console.log('abilityinfo.ability: ${JSON.stringify(abilityinfo.ability)}');
console.log("abilityinfo.pid: " + JSON.stringify(abilityinfo.pid)); console.log('abilityinfo.pid: ${JSON.stringify(abilityinfo.pid)}');
console.log("abilityinfo.uid: " + JSON.stringify(abilityinfo.uid)); console.log('abilityinfo.uid: ${JSON.stringify(abilityinfo.uid)}');
console.log("abilityinfo.processName: " + JSON.stringify(abilityinfo.processName)); console.log('abilityinfo.processName: ${JSON.stringify(abilityinfo.processName)}');
console.log("abilityinfo.startTime: " + JSON.stringify(abilityinfo.startTime)); console.log('abilityinfo.startTime: ${JSON.stringify(abilityinfo.startTime)}');
console.log("abilityinfo.abilityState: " + JSON.stringify(abilityinfo.abilityState)); console.log('abilityinfo.abilityState: ${JSON.stringify(abilityinfo.abilityState)}');
} }
}); });
``` ```
# AbilityStageContext # AbilityStageContext
The **AbilityStageContext** module, inherited from [Context](js-apis-application-context.md), implements the context of an ability stage. The **AbilityStageContext** module, inherited from [Context](js-apis-inner-application-context.md), implements the context of an ability stage.
This module provides APIs for accessing a specific ability stage. You can use the APIs to obtain the **ModuleInfo** object and environment configuration of an ability stage. This module provides APIs for accessing a specific ability stage. You can use the APIs to obtain the **ModuleInfo** object and environment configuration of an ability stage.
...@@ -29,5 +29,5 @@ class MyAbilityStage extends AbilityStage { ...@@ -29,5 +29,5 @@ class MyAbilityStage extends AbilityStage {
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | Yes| No| **ModuleInfo** object corresponding to the **AbilityStage**.| | currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | Yes| No| **ModuleInfo** object corresponding to the **AbilityStage**.|
| config | [Configuration](js-apis-app-ability-configuration.md) | Yes| No| Configuration for the environment where the application is running.| | config | [Configuration](js-apis-app-ability-configuration.md) | Yes| No| Configuration for the environment where the application is running.|
...@@ -14,12 +14,12 @@ The **AbilityStageMonitor** module provides conditions for matching **AbilitySta ...@@ -14,12 +14,12 @@ The **AbilityStageMonitor** module provides conditions for matching **AbilitySta
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
let monitor = { let monitor = {
moduleName: "feature_as1", moduleName: 'feature_as1',
srcEntrance: "./ets/Application/MyAbilityStage.ts", srcEntrance: './ets/Application/MyAbilityStage.ts',
}; };
let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => { abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => {
console.info("stageMonitor waitAbilityStageMonitor, abilityStage = " + JSON.stringify(data)); console.info('stageMonitor waitAbilityStageMonitor, abilityStage = ${JSON.stringify(data)}');
}); });
``` ```
...@@ -15,20 +15,19 @@ The **AppStateData** module defines the application state data, which can be obt ...@@ -15,20 +15,19 @@ The **AppStateData** module defines the application state data, which can be obt
**Example** **Example**
```ts ```ts
import appManager from "@ohos.app.ability.appManager" import appManager from '@ohos.app.ability.appManager';
function getForegroundAppInfos() { function getForegroundAppInfos() {
appManager.getForegroundApplications((error, data) => { appManager.getForegroundApplications((error, data) => {
if (error && error.code) { if (error && error.code) {
console.log('getForegroundApplications failed, error.code: ' + JSON.stringify(error.code) + console.log('getForegroundApplications failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
let appStateData = data[i]; let appStateData = data[i];
console.log('appStateData.bundleName: ' + appStateData.bundleName); console.log('appStateData.bundleName: ${appStateData.bundleName}');
console.log('appStateData.uid: ' + appStateData.uid); console.log('appStateData.uid: ${appStateData.uid}');
console.log('appStateData.state: ' + appStateData.state); console.log('appStateData.state: ${appStateData.state}');
} }
}); });
} }
......
...@@ -15,9 +15,9 @@ Before calling any APIs in **ApplicationContext**, obtain an **ApplicationContex ...@@ -15,9 +15,9 @@ Before calling any APIs in **ApplicationContext**, obtain an **ApplicationContex
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
``` ```
## ApplicationContext.registerAbilityLifecycleCallback ## ApplicationContext.on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback)
registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**; on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback): **number**;
Registers a listener to monitor the ability lifecycle of the application. Registers a listener to monitor the ability lifecycle of the application.
...@@ -27,6 +27,7 @@ Registers a listener to monitor the ability lifecycle of the application. ...@@ -27,6 +27,7 @@ Registers a listener to monitor the ability lifecycle of the application.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| type | 'abilityLifecycle' | Yes | Event type.|
| callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | Yes | Callback used to return the ID of the registered listener.| | callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | Yes | Callback used to return the ID of the registered listener.|
**Return value** **Return value**
...@@ -40,56 +41,56 @@ Registers a listener to monitor the ability lifecycle of the application. ...@@ -40,56 +41,56 @@ Registers a listener to monitor the ability lifecycle of the application.
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var lifecycleId; let lifecycleId;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log('MyAbility onCreate');
let AbilityLifecycleCallback = { let AbilityLifecycleCallback = {
onAbilityCreate(ability) { onAbilityCreate(ability) {
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onAbilityCreate ability: ${ability}');
}, },
onWindowStageCreate(ability, windowStage) { onWindowStageCreate(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onWindowStageCreate ability: ${ability}');
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); console.log('AbilityLifecycleCallback onWindowStageCreate windowStage: ${windowStage}');
}, },
onWindowStageActive(ability, windowStage) { onWindowStageActive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onWindowStageActive ability: ${ability}');
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); console.log('AbilityLifecycleCallback onWindowStageActive windowStage: ${windowStage}');
}, },
onWindowStageInactive(ability, windowStage) { onWindowStageInactive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onWindowStageInactive ability: ${ability}');
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); console.log('AbilityLifecycleCallback onWindowStageInactive windowStage: ${windowStage}');
}, },
onWindowStageDestroy(ability, windowStage) { onWindowStageDestroy(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onWindowStageDestroy ability: ${ability}');
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); console.log('AbilityLifecycleCallback onWindowStageDestroy windowStage: ${windowStage}');
}, },
onAbilityDestroy(ability) { onAbilityDestroy(ability) {
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onAbilityDestroy ability: ${ability}');
}, },
onAbilityForeground(ability) { onAbilityForeground(ability) {
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onAbilityForeground ability: ${ability}');
}, },
onAbilityBackground(ability) { onAbilityBackground(ability) {
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onAbilityBackground ability: ${ability}');
}, },
onAbilityContinue(ability) { onAbilityContinue(ability) {
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); console.log('AbilityLifecycleCallback onAbilityContinue ability: ${ability}');
} }
} }
// 1. Obtain applicationContext through the context attribute. // 1. Obtain applicationContext through the context attribute.
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
// 2. Use applicationContext to register a listener for the ability lifecycle in the application. // 2. Use applicationContext to register a listener for the ability lifecycle in the application.
lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); lifecycleId = applicationContext.on('abilityLifecycle', AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); console.log('registerAbilityLifecycleCallback number: ' + JSON.stringify(lifecycleId));
} }
} }
``` ```
## ApplicationContext.unregisterAbilityLifecycleCallback ## ApplicationContext.off(type: 'abilityLifecycle', callbackId: number, callback: AsyncCallback<void>)
unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; off(type: 'abilityLifecycle', callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
Deregisters the listener that monitors the ability lifecycle of the application. Deregisters the listener that monitors the ability lifecycle of the application.
...@@ -99,6 +100,7 @@ Deregisters the listener that monitors the ability lifecycle of the application. ...@@ -99,6 +100,7 @@ Deregisters the listener that monitors the ability lifecycle of the application.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------- | -------- | ---- | -------------------------- | | ------------- | -------- | ---- | -------------------------- |
| type | 'abilityLifecycle' | Yes | Event type.|
| callbackId | number | Yes | ID of the listener to deregister.| | callbackId | number | Yes | ID of the listener to deregister.|
| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void> | Yes | Callback used to return the result. |
...@@ -107,22 +109,53 @@ Deregisters the listener that monitors the ability lifecycle of the application. ...@@ -107,22 +109,53 @@ Deregisters the listener that monitors the ability lifecycle of the application.
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var lifecycleId; let lifecycleId;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onDestroy() { onDestroy() {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
console.log("stage applicationContext: " + JSON.stringify(applicationContext)); console.log('stage applicationContext: ' + applicationContext);
applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { applicationContext.off(type: 'abilityLifecycle', lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); console.log('unregisterAbilityLifecycleCallback success, err: ' + JSON.stringify(error));
}); });
} }
} }
``` ```
## ApplicationContext.registerEnvironmentCallback ## ApplicationContext.off(type: 'abilityLifecycle', callbackId: number)
registerEnvironmentCallback(callback: EnvironmentCallback): **number**; off(type: 'abilityLifecycle', callbackId: **number**): **void**;
Deregisters the listener that monitors the ability lifecycle of the application.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name | Type | Mandatory| Description |
| ------------- | -------- | ---- | -------------------------- |
| type | 'abilityLifecycle' | Yes | Event type.|
| callbackId | number | Yes | ID of the listener to deregister.|
**Example**
```ts
import Ability from '@ohos.app.ability.UIAbility';
let lifecycleId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
console.log('stage applicationContext: ' + applicationContext);
applicationContext.off(type: 'abilityLifecycle', lifecycleId);
}
}
```
## ApplicationContext.on(type: 'environment', callback: EnvironmentCallback)
on(type: 'environment', callback: EnvironmentCallback): **number**;
Registers a listener for system environment changes. This API uses an asynchronous callback to return the result. Registers a listener for system environment changes. This API uses an asynchronous callback to return the result.
...@@ -132,6 +165,7 @@ Registers a listener for system environment changes. This API uses an asynchrono ...@@ -132,6 +165,7 @@ Registers a listener for system environment changes. This API uses an asynchrono
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| type | 'environment' | Yes | Event type.|
| callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | Yes | Callback used to return the ID of the registered listener.| | callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | Yes | Callback used to return the ID of the registered listener.|
**Return value** **Return value**
...@@ -145,32 +179,32 @@ Registers a listener for system environment changes. This API uses an asynchrono ...@@ -145,32 +179,32 @@ Registers a listener for system environment changes. This API uses an asynchrono
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var callbackId; let callbackId;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log('MyAbility onCreate')
globalThis.applicationContext = this.context.getApplicationContext(); globalThis.applicationContext = this.context.getApplicationContext();
let EnvironmentCallback = { let EnvironmentCallback = {
onConfigurationUpdated(config){ onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config)); console.log('onConfigurationUpdated config:' + JSON.stringify(config));
}, },
onMemoryLevel(level){ onMemoryLevel(level){
console.log("onMemoryLevel level:" + level); console.log('onMemoryLevel level:' + level);
} }
} }
// 1. Obtain an applicationContext object. // 1. Obtain an applicationContext object.
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
// 2. Use applicationContext to register a listener for the ability lifecycle in the application. // 2. Use applicationContext to register a listener for the ability lifecycle in the application.
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); callbackId = applicationContext.on('environment', EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); console.log('registerEnvironmentCallback number: ' + JSON.stringify(callbackId));
} }
} }
``` ```
## ApplicationContext.unregisterEnvironmentCallback ## ApplicationContext.off(type: 'environment', callbackId: number, callback: AsyncCallback<void>)
unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; off(type: 'environment', callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
Deregisters the listener for system environment changes. This API uses an asynchronous callback to return the result. Deregisters the listener for system environment changes. This API uses an asynchronous callback to return the result.
...@@ -180,6 +214,7 @@ Deregisters the listener for system environment changes. This API uses an asynch ...@@ -180,6 +214,7 @@ Deregisters the listener for system environment changes. This API uses an asynch
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------- | -------- | ---- | -------------------------- | | ------------- | -------- | ---- | -------------------------- |
| type | 'environment' | Yes | Event type.|
| callbackId | number | Yes | ID of the listener to deregister. | | callbackId | number | Yes | ID of the listener to deregister. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void> | Yes | Callback used to return the result. |
...@@ -188,14 +223,148 @@ Deregisters the listener for system environment changes. This API uses an asynch ...@@ -188,14 +223,148 @@ Deregisters the listener for system environment changes. This API uses an asynch
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
var callbackId; let callbackId;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onDestroy() { onDestroy() {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { applicationContext.off('environment', callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); console.log('unregisterEnvironmentCallback success, err: ' + JSON.stringify(error));
}); });
} }
} }
``` ```
## ApplicationContext.off(type: 'environment', callbackId: number)
off(type: 'environment', callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
Deregisters the listener for system environment changes. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters**
| Name | Type | Mandatory| Description |
| ------------- | -------- | ---- | -------------------------- |
| type | 'environment' | Yes | Event type.|
| callbackId | number | Yes | ID of the listener to deregister. |
**Example**
```ts
import Ability from '@ohos.app.ability.UIAbility';
let callbackId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.off('environment', callbackId);
}
}
```
## ApplicationContext.getRunningProcessInformation<sup>9+</sup>
getRunningProcessInformation(): Promise\<Array\<ProcessInformation>>;
Obtains information about the running processes. This API uses a promise to return the result.
**Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**System API**: This is a system API and cannot be called by third-party applications.
**Return value**
| Type| Description|
| -------- | -------- |
| Promise\<Array\<[ProcessInformation](js-apis-inner-application-processInformation.md)>> | Promise used to return the API call result and the process running information. You can perform error handling or custom processing in this callback.|
**Example**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.getRunningProcessInformation().then((data) => {
console.log('The process running information is: ${JSON.stringify(data)}');
}).catch((error) => {
console.log('error: ${JSON.stringify(error)}');
});
```
## ApplicationContext.getRunningProcessInformation<sup>9+</sup>
getRunningProcessInformation(callback: AsyncCallback\<Array\<ProcessInformation>>): void;
Obtains information about the running processes. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**System API**: This is a system API and cannot be called by third-party applications.
**Return value**
| Type| Description|
| -------- | -------- |
|AsyncCallback\<Array\<[ProcessInformation](js-apis-inner-application-processInformation.md)>> | Callback used to return the API call result and the process running information. You can perform error handling or custom processing in this callback.|
**Example**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.getRunningProcessInformation((err, data) => {
if (err.code !== 0) {
console.error('getRunningProcessInformation faile, err: ${JSON.stringify(err)}');
} else {
console.log('The process running information is: ${JSON.stringify(data)}');
}
})
```
## ApplicationContext.killAllProcesses<sup>9+</sup>
killAllProcesses(): Promise\<void\>;
Kills all the processes where the application is located. This API uses a promise to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Return value**
| Type| Description|
| -------- | -------- |
| Promise\<void\> | Promise used to return the result.|
**Example**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.killAllProcesses();
```
## ApplicationContext.killAllProcesses<sup>9+</sup>
killAllProcesses(callback: AsyncCallback\<void\>);
Kills all the processes where the application is located. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Return value**
| Type| Description|
| -------- | -------- |
|AsyncCallback\<void\> | Callback used to return the result.|
**Example**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.killAllProcesses(err => {
console.error('killAllProcesses result: ${JSON.stringify(err)}');
});
```
...@@ -16,24 +16,24 @@ The **ApplicationStateObserver** module defines an observer to listen for applic ...@@ -16,24 +16,24 @@ The **ApplicationStateObserver** module defines an observer to listen for applic
**Example** **Example**
```ts ```ts
import appManager from "@ohos.app.ability.appManager"; import appManager from '@ohos.app.ability.appManager';
let applicationStateObserver = { let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData)); console.log('onForegroundApplicationChanged appStateData: ${JSON.stringify(appStateData)}');
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData)); console.log('onAbilityStateChanged onAbilityStateChanged: ${JSON.stringify(abilityStateData)}');
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData)); console.log('onProcessCreated onProcessCreated: ${JSON.stringify(processData)}');
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData)); console.log('onProcessDied onProcessDied: ${JSON.stringify(processData)}');
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('onProcessStateChanged onProcessStateChanged: ' + JSON.stringify(processData)); console.log('onProcessStateChanged onProcessStateChanged: ${JSON.stringify(processData)}');
} }
} };
let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver); let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
``` ```
...@@ -22,7 +22,7 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -22,7 +22,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility { class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
// EntryAbility onCreate, isStageMode: true // EntryAbility onCreate, isStageMode: true
console.log("EntryAbility onCreate, isStageMode: " + this.context.stageMode); console.log('EntryAbility onCreate, isStageMode: ${this.context.stageMode}');
} }
} }
``` ```
...@@ -62,8 +62,7 @@ let bundleContext; ...@@ -62,8 +62,7 @@ let bundleContext;
try { try {
bundleContext = this.context.createBundleContext('com.example.test'); bundleContext = this.context.createBundleContext('com.example.test');
} catch (error) { } catch (error) {
console.log('createBundleContext failed, error.code: ' + JSON.stringify(error.code) + console.log('createBundleContext failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
``` ```
...@@ -102,11 +101,12 @@ let moduleContext; ...@@ -102,11 +101,12 @@ let moduleContext;
try { try {
moduleContext = this.context.createModuleContext('entry'); moduleContext = this.context.createModuleContext('entry');
} catch (error) { } catch (error) {
console.log('createModuleContext failed, error.code: ' + JSON.stringify(error.code) + console.log('createModuleContext failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
``` ```
## Context.createModuleContext
createModuleContext(bundleName: string, moduleName: string): Context; createModuleContext(bundleName: string, moduleName: string): Context;
Creates the context based on the bundle name and module name. Creates the context based on the bundle name and module name.
...@@ -141,8 +141,7 @@ let moduleContext; ...@@ -141,8 +141,7 @@ let moduleContext;
try { try {
moduleContext = this.context.createModuleContext('com.example.test', 'entry'); moduleContext = this.context.createModuleContext('com.example.test', 'entry');
} catch (error) { } catch (error) {
console.log('createModuleContext failed, error.code: ' + JSON.stringify(error.code) + console.log('createModuleContext failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
``` ```
...@@ -167,7 +166,6 @@ let applicationContext; ...@@ -167,7 +166,6 @@ let applicationContext;
try { try {
applicationContext = this.context.getApplicationContext(); applicationContext = this.context.getApplicationContext();
} catch (error) { } catch (error) {
console.log('getApplicationContext failed, error.code: ' + JSON.stringify(error.code) + console.log('getApplicationContext failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
``` ```
...@@ -19,28 +19,27 @@ Called when the mission continuation is complete. ...@@ -19,28 +19,27 @@ Called when the mission continuation is complete.
**Example** **Example**
```ts ```ts
import distributedMissionManager from '@ohos.distributedMissionManager' import distributedMissionManager from '@ohos.distributedMissionManager';
let continueDeviceInfo = { let continueDeviceInfo = {
srcDeviceId: "123", srcDeviceId: '123',
dstDeviceId: "456", dstDeviceId: '456',
missionId: 123, missionId: 123,
wantParam: { wantParam: {
"key":"value" 'key':'value'
} }
}; };
let continueCallback = { let continueCallback = {
onContinueDone(result) { onContinueDone(result) {
console.log('onContinueDone, result: ' + JSON.stringify(result)); console.log('onContinueDone, result: ${JSON.stringify(result)}');
} }
}; };
distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => { distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => {
if (error && error.code) { if (error && error.code) {
console.log('continueMission failed, error.code: ' + JSON.stringify(error.code) + console.log('continueMission failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
console.log('continueMission finished'); console.log('continueMission finished');
}) });
``` ```
...@@ -14,28 +14,27 @@ The **ContinueDeviceInfo** module defines the parameters required for initiating ...@@ -14,28 +14,27 @@ The **ContinueDeviceInfo** module defines the parameters required for initiating
**Example** **Example**
```ts ```ts
import distributedMissionManager from '@ohos.distributedMissionManager' import distributedMissionManager from '@ohos.distributedMissionManager';
let continueDeviceInfo = { let continueDeviceInfo = {
srcDeviceId: "123", srcDeviceId: '123',
dstDeviceId: "456", dstDeviceId: '456',
missionId: 123, missionId: 123,
wantParam: { wantParam: {
"key":"value" 'key':'value'
} }
}; };
let continueCallback = { let continueCallback = {
onContinueDone(result) { onContinueDone(result) {
console.log('onContinueDone, result: ' + JSON.stringify(result)); console.log('onContinueDone, result: ${JSON.stringify(result)}');
} }
}; };
distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => { distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => {
if (error && error.code) { if (error && error.code) {
console.log('continueMission failed, error.code: ' + JSON.stringify(error.code) + console.log('continueMission failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
} }
console.log('continueMission finished'); console.log('continueMission finished');
}) });
``` ```
...@@ -16,11 +16,11 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -16,11 +16,11 @@ import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
eventFunc(){ eventFunc(){
console.log("eventFunc is called"); console.log('eventFunc is called');
} }
onForeground() { onForeground() {
this.context.eventHub.on("myEvent", this.eventFunc); this.context.eventHub.on('myEvent', this.eventFunc);
} }
} }
``` ```
...@@ -47,19 +47,19 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -47,19 +47,19 @@ import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onForeground() { onForeground() {
this.context.eventHub.on("myEvent", this.eventFunc); this.context.eventHub.on('myEvent', this.eventFunc);
// Anonymous functions can be used to subscribe to events. // Anonymous functions can be used to subscribe to events.
this.context.eventHub.on("myEvent", () => { this.context.eventHub.on('myEvent', () => {
console.log("call anonymous eventFunc"); console.log('call anonymous eventFunc');
}); });
// Result // Result
// eventFunc is called // eventFunc is called
// call anonymous eventFunc // call anonymous eventFunc
this.context.eventHub.emit("myEvent"); this.context.eventHub.emit('myEvent');
} }
eventFunc() { eventFunc() {
console.log("eventFunc is called"); console.log('eventFunc is called');
} }
} }
``` ```
...@@ -88,19 +88,19 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -88,19 +88,19 @@ import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onForeground() { onForeground() {
this.context.eventHub.on("myEvent", this.eventFunc1); this.context.eventHub.on('myEvent', this.eventFunc1);
this.context.eventHub.off("myEvent", this.eventFunc1); // Unsubscribe from the myEvent event with the callback eventFunc1. this.context.eventHub.off('myEvent', this.eventFunc1); // Unsubscribe from the myEvent event with the callback eventFunc1.
this.context.eventHub.on("myEvent", this.eventFunc1); this.context.eventHub.on('myEvent', this.eventFunc1);
this.context.eventHub.on("myEvent", this.eventFunc2); this.context.eventHub.on('myEvent', this.eventFunc2);
this.context.eventHub.off("myEvent"); // Unsubscribe from the myEvent event with all the callbacks (eventFunc1 and eventFunc2). this.context.eventHub.off('myEvent'); // Unsubscribe from the myEvent event with all the callbacks (eventFunc1 and eventFunc2).
} }
eventFunc1() { eventFunc1() {
console.log("eventFunc1 is called"); console.log('eventFunc1 is called');
} }
eventFunc2() { eventFunc2() {
console.log("eventFunc2 is called"); console.log('eventFunc2 is called');
} }
} }
``` ```
...@@ -127,20 +127,20 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -127,20 +127,20 @@ import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onForeground() { onForeground() {
this.context.eventHub.on("myEvent", this.eventFunc); this.context.eventHub.on('myEvent', this.eventFunc);
// Result // Result
// eventFunc is called,undefined,undefined // eventFunc is called,undefined,undefined
this.context.eventHub.emit("myEvent"); this.context.eventHub.emit('myEvent');
// Result // Result
// eventFunc is called,1,undefined // eventFunc is called,1,undefined
this.context.eventHub.emit("myEvent", 1); this.context.eventHub.emit('myEvent', 1);
// Result // Result
// eventFunc is called,1,2 // eventFunc is called,1,2
this.context.eventHub.emit("myEvent", 1, 2); this.context.eventHub.emit('myEvent', 1, 2);
} }
eventFunc(argOne, argTwo) { eventFunc(argOne, argTwo) {
console.log("eventFunc is called," + argOne + "," + argTwo); console.log('eventFunc is called, ${argOne}, ${argTwo}');
} }
} }
``` ```
...@@ -36,22 +36,22 @@ import Want from '@ohos.app.ability.Want'; ...@@ -36,22 +36,22 @@ import Want from '@ohos.app.ability.Want';
export default class TheServiceExtension extends ServiceExtension { export default class TheServiceExtension extends ServiceExtension {
onCreate(want:Want) { onCreate(want:Want) {
console.log('ServiceAbility onCreate, want: ' + want.abilityName); console.log('ServiceAbility onCreate, want: ${want.abilityName}');
// Pass ExtensionContext to entry via globalThis. // Pass ExtensionContext to entry via globalThis.
globalThis.ExtensionContext = this.context; globalThis.ExtensionContext = this.context;
} }
onRequest(want, startId) { onRequest(want, startId) {
console.log('ServiceAbility onRequest, want: ' + want.abilityName + ', startId: ' + startId); console.log('ServiceAbility onRequest, want: ${want.abilityName}, startId: ${startId}');
} }
onConnect(want) { onConnect(want) {
console.log('ServiceAbility onConnect, want:' + want.abilityName); console.log('ServiceAbility onConnect, want: ${want.abilityName}');
return null; return null;
} }
onDisconnect(want) { onDisconnect(want) {
console.log('ServiceAbility onDisconnect, want:' + want.abilityName); console.log('ServiceAbility onDisconnect, want: ${want.abilityName}');
} }
onDestroy() { onDestroy() {
...@@ -66,11 +66,11 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -66,11 +66,11 @@ import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("[Demo] EntryAbility onCreate"); console.log('[Demo] EntryAbility onCreate');
let wantExt = { let wantExt = {
deviceId: "", deviceId: '',
bundleName: "com.example.TheServiceExtension", bundleName: 'com.example.TheServiceExtension',
abilityName: "TheServiceExtension", abilityName: 'TheServiceExtension',
}; };
this.context.startServiceExtensionAbility(wantExt); this.context.startServiceExtensionAbility(wantExt);
} }
...@@ -85,29 +85,29 @@ export default class ServiceModel { ...@@ -85,29 +85,29 @@ export default class ServiceModel {
constructor() {} constructor() {}
executeTask() { executeTask() {
if (globalThis.ExtensionContext == undefined) { if (globalThis.ExtensionContext === undefined) {
console.log("ERROR, ServiceExtension does not exist"); console.log('ERROR, ServiceExtension does not exist');
return; return;
} }
var moduleInfo = globalThis.ExtensionContext.currentHapModuleInfo; let moduleInfo = globalThis.ExtensionContext.currentHapModuleInfo;
this.moduleName = moduleInfo.name; this.moduleName = moduleInfo.name;
// Execute service logic based on the module name, which differentiates devices with different performance. // Execute service logic based on the module name, which differentiates devices with different performance.
switch (this.moduleName) { switch (this.moduleName) {
case "highPerformance": case 'highPerformance':
console.log("This is high performance device."); console.log('This is high performance device.');
// Execute the corresponding service logic. // Execute the corresponding service logic.
break; break;
case "midPerformance": case 'midPerformance':
console.log("This is mid performance device."); console.log('This is mid performance device.');
// Execute the corresponding service logic. // Execute the corresponding service logic.
break; break;
case "lowPerformance": case 'lowPerformance':
console.log("This is low performance device."); console.log('This is low performance device.');
// Execute the corresponding service logic. // Execute the corresponding service logic.
break; break;
default: default:
console.log("ERROR, invalid moduleName."); console.log('ERROR, invalid moduleName.');
break; break;
} }
} }
......
...@@ -27,26 +27,25 @@ Import the **abilityManager** module and obtain the ExtensionAbility running inf ...@@ -27,26 +27,25 @@ Import the **abilityManager** module and obtain the ExtensionAbility running inf
**Example** **Example**
```ts ```ts
import abilityManager from '@ohos.app.ability.abilityManager' import abilityManager from '@ohos.app.ability.abilityManager';
var upperLimit = 1; let upperLimit = 1;
function getExtensionInfos() { function getExtensionInfos() {
abilityManager.getExtensionRunningInfos(upperLimit, (error, data) => { abilityManager.getExtensionRunningInfos(upperLimit, (error, data) => {
if (error && error.code) { if (error && error.code) {
console.log('getForegroundApplications failed, error.code: ' + JSON.stringify(error.code) + console.log('getForegroundApplications failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
let extensionRunningInfo = data[i]; let extensionRunningInfo = data[i];
console.log("extensionRunningInfo.extension: " + JSON.stringify(extensionRunningInfo.extension)); console.log('extensionRunningInfo.extension: ${JSON.stringify(extensionRunningInfo.extension)}');
console.log("extensionRunningInfo.pid: " + JSON.stringify(extensionRunningInfo.pid)); console.log('extensionRunningInfo.pid: ${JSON.stringify(extensionRunningInfo.pid)}');
console.log("extensionRunningInfo.uid: " + JSON.stringify(extensionRunningInfo.uid)); console.log('extensionRunningInfo.uid: ${JSON.stringify(extensionRunningInfo.uid)}');
console.log("extensionRunningInfo.processName: " + JSON.stringify(extensionRunningInfo.processName)); console.log('extensionRunningInfo.processName: ${JSON.stringify(extensionRunningInfo.processName)}');
console.log("extensionRunningInfo.startTime: " + JSON.stringify(extensionRunningInfo.startTime)); console.log('extensionRunningInfo.startTime: ${JSON.stringify(extensionRunningInfo.startTime)}');
console.log("extensionRunningInfo.clientPackage: " + JSON.stringify(extensionRunningInfo.clientPackage)); console.log('extensionRunningInfo.clientPackage: ${JSON.stringify(extensionRunningInfo.clientPackage)}');
console.log("extensionRunningInfo.type: " + JSON.stringify(extensionRunningInfo.type)); console.log('extensionRunningInfo.type: ${JSON.stringify(extensionRunningInfo.type)}');
} }
}); });
} }
......
...@@ -22,8 +22,8 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -22,8 +22,8 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
let formContext = this.context; // Obtain a FormExtensionContext instance. let formContext = this.context; // Obtain a FormExtensionContext instance.
// ... // ...
let dataObj1 = { let dataObj1 = {
temperature: "11c", temperature: '11c',
"time": "11:00" 'time': '11:00'
}; };
let obj1 = formBindingData.createFormBindingData(dataObj1); let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1; return obj1;
...@@ -56,18 +56,18 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -56,18 +56,18 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
// Call startAbility() when the message event is triggered. // Call startAbility() when the message event is triggered.
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message); console.log('FormExtensionAbility onFormEvent, formId: ${formId}, message:${message}');
let want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.formstartability", bundleName: 'com.example.formstartability',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
"message": message 'message': message
} }
}; };
this.context.startAbility(want, (error, data) => { this.context.startAbility(want, (error, data) => {
if (error) { if (error) {
console.log('FormExtensionContext startAbility, error:' + JSON.stringify(error)); console.log('FormExtensionContext startAbility, error:${JSON.stringify(error)}');
} else { } else {
console.log('FormExtensionContext startAbility success'); console.log('FormExtensionContext startAbility success');
} }
...@@ -106,19 +106,19 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -106,19 +106,19 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
// Call startAbility() when the message event is triggered. // Call startAbility() when the message event is triggered.
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message); console.log('FormExtensionAbility onFormEvent, formId:${formId}, message:${message}');
let want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.formstartability", bundleName: 'com.example.formstartability',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
parameters: { parameters: {
"message": message 'message': message
} }
}; };
this.context.startAbility(want).then(() => { this.context.startAbility(want).then(() => {
console.info("StartAbility Success"); console.info('StartAbility Success');
}).catch((error) => { }).catch((error) => {
console.info("StartAbility failed"); console.info('StartAbility failed');
}); });
} }
}; };
......
...@@ -15,19 +15,19 @@ The **MissionCallback** module defines the callbacks invoked after synchronizati ...@@ -15,19 +15,19 @@ The **MissionCallback** module defines the callbacks invoked after synchronizati
import distributedMissionManager from '@ohos.distributedMissionManager'; import distributedMissionManager from '@ohos.distributedMissionManager';
let missionDeviceInfo = { let missionDeviceInfo = {
deviceId: "123456" deviceId: '123456'
}; };
let missionCallback = { let missionCallback = {
notifyMissionsChanged: function (deviceId) { notifyMissionsChanged: function (deviceId) {
console.log("notifyMissionsChanged deviceId: " + JSON.stringify(deviceId)); console.log('notifyMissionsChanged deviceId: ${JSON.stringify(deviceId)}');
}, },
notifySnapshot: function (deviceId, mission) { notifySnapshot: function (deviceId, mission) {
console.log("notifySnapshot deviceId: " + JSON.stringify(deviceId)); console.log('notifySnapshot deviceId: ${JSON.stringify(deviceId)}');
console.log("notifySnapshot mission: " + JSON.stringify(mission)); console.log('notifySnapshot mission: ${JSON.stringify(mission)}');
}, },
notifyNetDisconnect: function (deviceId, state) { notifyNetDisconnect: function (deviceId, state) {
console.log("notifyNetDisconnect deviceId: " + JSON.stringify(deviceId)); console.log('notifyNetDisconnect deviceId: ${JSON.stringify(deviceId)}');
console.log("notifyNetDisconnect state: " + JSON.stringify(state)); console.log('notifyNetDisconnect state: ${JSON.stringify(state)}');
} }
}; };
distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback); distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback);
......
...@@ -13,19 +13,19 @@ The **MissionDeviceInfo** module defines the parameters required for registering ...@@ -13,19 +13,19 @@ The **MissionDeviceInfo** module defines the parameters required for registering
import distributedMissionManager from '@ohos.distributedMissionManager'; import distributedMissionManager from '@ohos.distributedMissionManager';
let missionDeviceInfo = { let missionDeviceInfo = {
deviceId: "123456" deviceId: '123456'
}; };
let missionCallback = { let missionCallback = {
notifyMissionsChanged: function (deviceId) { notifyMissionsChanged: function (deviceId) {
console.log("notifyMissionsChanged deviceId: " + JSON.stringify(deviceId)); console.log('notifyMissionsChanged deviceId: ${JSON.stringify(deviceId)}');
}, },
notifySnapshot: function (mission, deviceId) { notifySnapshot: function (mission, deviceId) {
console.log("notifySnapshot mission: " + JSON.stringify(mission)); console.log('notifySnapshot mission: ${JSON.stringify(mission)}');
console.log("notifySnapshot deviceId: " + JSON.stringify(deviceId)); console.log('notifySnapshot deviceId: ${JSON.stringify(deviceId)}');
}, },
notifyNetDisconnect: function (mission, state) { notifyNetDisconnect: function (mission, state) {
console.log("notifyNetDisconnect mission: " + JSON.stringify(mission)); console.log('notifyNetDisconnect mission: ${JSON.stringify(mission)}');
console.log("notifyNetDisconnect state: " + JSON.stringify(state)); console.log('notifyNetDisconnect state: ${JSON.stringify(state)}');
} }
}; };
distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback); distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback);
......
...@@ -19,27 +19,26 @@ The **MissionInfo** module defines detailed information about a mission. The inf ...@@ -19,27 +19,26 @@ The **MissionInfo** module defines detailed information about a mission. The inf
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager';
try { try {
missionManager.getMissionInfo("", 1, (error, data) => { missionManager.getMissionInfo('', 1, (error, data) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfo failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log('getMissionInfo missionId is:' + JSON.stringify(data.missionId)); console.log('getMissionInfo missionId is: ${JSON.stringify(data.missionId)}');
console.log('getMissionInfo runningState is:' + JSON.stringify(data.runningState)); console.log('getMissionInfo runningState is: ${JSON.stringify(data.runningState)}');
console.log('getMissionInfo lockedState is:' + JSON.stringify(data.lockedState)); console.log('getMissionInfo lockedState is: ${JSON.stringify(data.lockedState)}');
console.log('getMissionInfo timestamp is:' + JSON.stringify(data.timestamp)); console.log('getMissionInfo timestamp is: ${JSON.stringify(data.timestamp)}');
console.log('getMissionInfo want is:' + JSON.stringify(data.want)); console.log('getMissionInfo want is: ${JSON.stringify(data.want)}');
console.log('getMissionInfo label is:' + JSON.stringify(data.label)); console.log('getMissionInfo label is: ${JSON.stringify(data.label)}');
console.log('getMissionInfo iconPath is:' + JSON.stringify(data.iconPath)); console.log('getMissionInfo iconPath is: ${JSON.stringify(data.iconPath)}');
console.log('getMissionInfo continuable is:' + JSON.stringify(data.continuable)); console.log('getMissionInfo continuable is: ${JSON.stringify(data.continuable)}');
}); });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -16,32 +16,32 @@ The **MissionListener** module defines the listeners used to observe the mission ...@@ -16,32 +16,32 @@ The **MissionListener** module defines the listeners used to observe the mission
**Example** **Example**
```ts ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager';
let listener = { let listener = {
onMissionCreated: function (mission) { onMissionCreated: function (mission) {
console.log("onMissionCreated mission: " + JSON.stringify(mission)); console.log('onMissionCreated mission: ${JSON.stringify(mission)}');
}, },
onMissionDestroyed: function (mission) { onMissionDestroyed: function (mission) {
console.log("onMissionDestroyed mission: " + JSON.stringify(mission)); console.log('onMissionDestroyed mission: ${JSON.stringify(mission)}');
}, },
onMissionSnapshotChanged: function (mission) { onMissionSnapshotChanged: function (mission) {
console.log("onMissionSnapshotChanged mission: " + JSON.stringify(mission)); console.log('onMissionSnapshotChanged mission: ${JSON.stringify(mission)}');
}, },
onMissionMovedToFront: function (mission) { onMissionMovedToFront: function (mission) {
console.log("onMissionMovedToFront mission: " + JSON.stringify(mission)); console.log('onMissionMovedToFront mission: ${JSON.stringify(mission)}');
}, },
onMissionIconUpdated: function (mission, icon) { onMissionIconUpdated: function (mission, icon) {
console.log("onMissionIconUpdated mission: " + JSON.stringify(mission)); console.log('onMissionIconUpdated mission: ${JSON.stringify(mission)}');
}, },
onMissionClosed: function (mission) { onMissionClosed: function (mission) {
console.log("onMissionClosed mission: " + JSON.stringify(mission)); console.log('onMissionClosed mission: ${JSON.stringify(mission)}');
} }
}; };
try { try {
let listenerId = missionManager.on("mission", listener); let listenerId = missionManager.on('mission', listener);
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -15,17 +15,17 @@ The **MissionParameter** module defines the parameters required for mission sync ...@@ -15,17 +15,17 @@ The **MissionParameter** module defines the parameters required for mission sync
import distributedMissionManager from '@ohos.distributedMissionManager'; import distributedMissionManager from '@ohos.distributedMissionManager';
let missionParameter = { let missionParameter = {
deviceId: "123456", deviceId: '123456',
fixConflict: true, fixConflict: true,
tag: 123 tag: 123
}; };
try { try {
distributedMissionManager.startSyncRemoteMissions(missionParameter, distributedMissionManager.startSyncRemoteMissions(missionParameter,
(err, data) => { (err, data) => {
console.log("startSyncRemoteMissions, data: " + JSON.stringify(data)); console.log('startSyncRemoteMissions, data: ${JSON.stringify(data)}');
} }
); );
} catch (err) { } catch (err) {
console.error('startSyncRemoteMissions fail: ' + JSON.stringify(err)); console.error('startSyncRemoteMissions fail: ${JSON.stringify(err)}');
} }
``` ```
...@@ -25,28 +25,26 @@ The mission snapshot information can be obtained by using **getMissionSnapShot** ...@@ -25,28 +25,26 @@ The mission snapshot information can be obtained by using **getMissionSnapShot**
import missionManager from '@ohos.app.ability.missionManager'; import missionManager from '@ohos.app.ability.missionManager';
try { try {
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos('', 10, (error, missions) => {
if (error.code) { if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + console.log('getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
"error.message:" + JSON.stringify(error.message));
return; return;
} }
console.log("size = " + missions.length); console.log('size = ${missions.length}');
console.log("missions = " + JSON.stringify(missions)); console.log('missions = ${JSON.stringify(missions)}');
var id = missions[0].missionId; let id = missions[0].missionId;
missionManager.getMissionSnapShot("", id, (err, snapshot) => { missionManager.getMissionSnapShot('', id, (err, snapshot) => {
if (err.code) { if (err.code) {
console.log("getMissionInfos failed, err.code:" + JSON.stringify(err.code) + console.log('getMissionInfos failed, err.code: ${JSON.stringify(err.code)}, err.message: ${JSON.stringify(err.message)}');
"err.message:" + JSON.stringify(err.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
console.log("bundleName = " + snapshot.ability.bundleName); console.log('bundleName = ${snapshot.ability.bundleName}');
}) });
}) });
} catch (paramError) { } catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message); console.log('error: ${paramError.code}, ${paramError.message}');
} }
``` ```
...@@ -21,24 +21,24 @@ import appManager from '@ohos.app.ability.appManager'; ...@@ -21,24 +21,24 @@ import appManager from '@ohos.app.ability.appManager';
let applicationStateObserver = { let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData)); console.log('onForegroundApplicationChanged appStateData: ${JSON.stringify(appStateData)}');
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData)); console.log('onAbilityStateChanged onAbilityStateChanged: ${JSON.stringify(abilityStateData)}');
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData)); console.log('onProcessCreated onProcessCreated: ${JSON.stringify(processData)}');
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData)); console.log('onProcessDied onProcessDied: ${JSON.stringify(processData)}');
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('onProcessStateChanged processData.pid : ' + JSON.stringify(processData.pid)); console.log('onProcessStateChanged processData.pid : ${JSON.stringify(processData.pid)}');
console.log('onProcessStateChanged processData.bundleName : ' + JSON.stringify(processData.bundleName)); console.log('onProcessStateChanged processData.bundleName : ${JSON.stringify(processData.bundleName)}');
console.log('onProcessStateChanged processData.uid : ' + JSON.stringify(processData.uid)); console.log('onProcessStateChanged processData.uid : ${JSON.stringify(processData.uid)}');
console.log('onProcessStateChanged processData.isContinuousTask : ' + JSON.stringify(processData.isContinuousTask)); console.log('onProcessStateChanged processData.isContinuousTask : ${JSON.stringify(processData.isContinuousTask)}');
console.log('onProcessStateChanged processData.isKeepAlive : ' + JSON.stringify(processData.isKeepAlive)); console.log('onProcessStateChanged processData.isKeepAlive : ${JSON.stringify(processData.isKeepAlive)}');
} }
} };
let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver); let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
``` ```
...@@ -28,5 +28,3 @@ appManager.getRunningProcessInformation((error, data) => { ...@@ -28,5 +28,3 @@ appManager.getRunningProcessInformation((error, data) => {
| uid | number | Yes| No| User ID.| | uid | number | Yes| No| User ID.|
| processName | string | Yes| No| Process name.| | processName | string | Yes| No| Process name.|
| bundleNames | Array&lt;string&gt; | Yes| No| Names of all running bundles in the process.| | bundleNames | Array&lt;string&gt; | Yes| No| Names of all running bundles in the process.|
<!--no_check-->
\ No newline at end of file
...@@ -16,7 +16,7 @@ Before using the **ServiceExtensionContext** module, you must define a child cla ...@@ -16,7 +16,7 @@ Before using the **ServiceExtensionContext** module, you must define a child cla
```ts ```ts
import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility';
let context = undefined; let context;
class EntryAbility extends ServiceExtensionAbility { class EntryAbility extends ServiceExtensionAbility {
onCreate() { onCreate() {
context = this.context; // Obtain a ServiceExtensionContext instance. context = this.context; // Obtain a ServiceExtensionContext instance.
...@@ -68,17 +68,16 @@ Starts an ability. This API uses an asynchronous callback to return the result. ...@@ -68,17 +68,16 @@ Starts an ability. This API uses an asynchronous callback to return the result.
**Example** **Example**
```ts ```ts
var want = { let want = {
bundleName: "com.example.myapp", bundleName: 'com.example.myapp',
abilityName: "MyAbility" abilityName: 'MyAbility'
}; };
try { try {
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -86,8 +85,7 @@ Starts an ability. This API uses an asynchronous callback to return the result. ...@@ -86,8 +85,7 @@ Starts an ability. This API uses an asynchronous callback to return the result.
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -141,11 +139,11 @@ Starts an ability. This API uses a promise to return the result. ...@@ -141,11 +139,11 @@ Starts an ability. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
var want = { let want = {
bundleName: "com.example.myapp", bundleName: 'com.example.myapp',
abilityName: "MyAbility" abilityName: 'MyAbility'
}; };
var options = { let options = {
windowMode: 0, windowMode: 0,
}; };
...@@ -157,13 +155,11 @@ Starts an ability. This API uses a promise to return the result. ...@@ -157,13 +155,11 @@ Starts an ability. This API uses a promise to return the result.
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -212,12 +208,12 @@ Starts an ability with the start options specified. This API uses an asynchronou ...@@ -212,12 +208,12 @@ Starts an ability with the start options specified. This API uses an asynchronou
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var options = { let options = {
windowMode: 0 windowMode: 0
}; };
...@@ -225,8 +221,7 @@ Starts an ability with the start options specified. This API uses an asynchronou ...@@ -225,8 +221,7 @@ Starts an ability with the start options specified. This API uses an asynchronou
this.context.startAbility(want, options, (error) => { this.context.startAbility(want, options, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -234,8 +229,7 @@ Starts an ability with the start options specified. This API uses an asynchronou ...@@ -234,8 +229,7 @@ Starts an ability with the start options specified. This API uses an asynchronou
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -290,19 +284,18 @@ Observe the following when using this API: ...@@ -290,19 +284,18 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
try { try {
this.context.startAbilityWithAccount(want, accountId, (error) => { this.context.startAbilityWithAccount(want, accountId, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -310,8 +303,7 @@ Observe the following when using this API: ...@@ -310,8 +303,7 @@ Observe the following when using this API:
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -367,13 +359,13 @@ Observe the following when using this API: ...@@ -367,13 +359,13 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
var options = { let options = {
windowMode: 0 windowMode: 0
}; };
...@@ -381,8 +373,7 @@ Observe the following when using this API: ...@@ -381,8 +373,7 @@ Observe the following when using this API:
this.context.startAbilityWithAccount(want, accountId, options, (error) => { this.context.startAbilityWithAccount(want, accountId, options, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -390,8 +381,7 @@ Observe the following when using this API: ...@@ -390,8 +381,7 @@ Observe the following when using this API:
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -453,13 +443,13 @@ Observe the following when using this API: ...@@ -453,13 +443,13 @@ Observe the following when using this API:
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
var options = { let options = {
windowMode: 0 windowMode: 0
}; };
...@@ -471,13 +461,11 @@ Observe the following when using this API: ...@@ -471,13 +461,11 @@ Observe the following when using this API:
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -518,18 +506,17 @@ Starts a new ServiceExtensionAbility. This API uses an asynchronous callback to ...@@ -518,18 +506,17 @@ Starts a new ServiceExtensionAbility. This API uses an asynchronous callback to
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
try { try {
this.context.startServiceExtensionAbility(want, (error) => { this.context.startServiceExtensionAbility(want, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('startServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -537,8 +524,7 @@ Starts a new ServiceExtensionAbility. This API uses an asynchronous callback to ...@@ -537,8 +524,7 @@ Starts a new ServiceExtensionAbility. This API uses an asynchronous callback to
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -584,10 +570,10 @@ Starts a new ServiceExtensionAbility. This API uses a promise to return the resu ...@@ -584,10 +570,10 @@ Starts a new ServiceExtensionAbility. This API uses a promise to return the resu
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
try { try {
...@@ -598,13 +584,11 @@ Starts a new ServiceExtensionAbility. This API uses a promise to return the resu ...@@ -598,13 +584,11 @@ Starts a new ServiceExtensionAbility. This API uses a promise to return the resu
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('startServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -650,19 +634,18 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use ...@@ -650,19 +634,18 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
try { try {
this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => { this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('startServiceExtensionAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -670,8 +653,7 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use ...@@ -670,8 +653,7 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -721,12 +703,12 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use ...@@ -721,12 +703,12 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
try { try {
this.context.startServiceExtensionAbilityWithAccount(want, accountId) this.context.startServiceExtensionAbilityWithAccount(want, accountId)
...@@ -736,13 +718,11 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use ...@@ -736,13 +718,11 @@ Starts a new ServiceExtensionAbility with the account ID specified. This API use
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('startServiceExtensionAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -780,18 +760,17 @@ Stops a ServiceExtensionAbility in the same application. This API uses an asynch ...@@ -780,18 +760,17 @@ Stops a ServiceExtensionAbility in the same application. This API uses an asynch
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
try { try {
this.context.stopServiceExtensionAbility(want, (error) => { this.context.stopServiceExtensionAbility(want, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('stopServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -799,8 +778,7 @@ Stops a ServiceExtensionAbility in the same application. This API uses an asynch ...@@ -799,8 +778,7 @@ Stops a ServiceExtensionAbility in the same application. This API uses an asynch
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -843,10 +821,10 @@ Stops a ServiceExtensionAbility in the same application. This API uses a promise ...@@ -843,10 +821,10 @@ Stops a ServiceExtensionAbility in the same application. This API uses a promise
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
try { try {
...@@ -857,13 +835,11 @@ Stops a ServiceExtensionAbility in the same application. This API uses a promise ...@@ -857,13 +835,11 @@ Stops a ServiceExtensionAbility in the same application. This API uses a promise
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('stopServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -905,19 +881,18 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec ...@@ -905,19 +881,18 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
try { try {
this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => { this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ${JSON.stringify(error.code), error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -925,8 +900,7 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec ...@@ -925,8 +900,7 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -973,12 +947,12 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec ...@@ -973,12 +947,12 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
}; };
var accountId = 100; let accountId = 100;
try { try {
this.context.stopServiceExtensionAbilityWithAccount(want, accountId) this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
...@@ -988,13 +962,11 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec ...@@ -988,13 +962,11 @@ Stops a ServiceExtensionAbility in the same application with the account ID spec
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -1031,8 +1003,7 @@ Terminates this ability. This API uses an asynchronous callback to return the re ...@@ -1031,8 +1003,7 @@ Terminates this ability. This API uses an asynchronous callback to return the re
this.context.terminateSelf((error) => { this.context.terminateSelf((error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) + console.log('terminateSelf failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -1075,8 +1046,7 @@ Terminates this ability. This API uses a promise to return the result. ...@@ -1075,8 +1046,7 @@ Terminates this ability. This API uses a promise to return the result.
console.log('terminateSelf succeed'); console.log('terminateSelf succeed');
}).catch((error) => { }).catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) + console.log('terminateSelf failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
``` ```
...@@ -1118,23 +1088,22 @@ Connects this ability to a ServiceAbility. ...@@ -1118,23 +1088,22 @@ Connects this ability to a ServiceAbility.
**Example** **Example**
```ts ```ts
var want = { let want = {
bundleName: "com.example.myapp", bundleName: 'com.example.myapp',
abilityName: "MyAbility" abilityName: 'MyAbility'
}; };
var options = { let options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') } onFailed(code) { console.log('----------- onFailed -----------') }
} };
var connection = null; let connection = null;
try { try {
connection = this.context.connectServiceExtensionAbility(want, options); connection = this.context.connectServiceExtensionAbility(want, options);
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -1178,25 +1147,24 @@ Uses the **AbilityInfo.AbilityType.SERVICE** template and account ID to connect ...@@ -1178,25 +1147,24 @@ Uses the **AbilityInfo.AbilityType.SERVICE** template and account ID to connect
**Example** **Example**
```ts ```ts
var want = { let want = {
deviceId: "", deviceId: '',
bundleName: "com.example.myapplication", bundleName: 'com.example.myapplication',
abilityName: "EntryAbility" abilityName: 'EntryAbility'
};
let accountId = 100;
let options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------'); },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------'); },
onFailed(code) { console.log('----------- onFailed -----------'); }
}; };
var accountId = 100;
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
var connection = null; let connection = null;
try { try {
connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options); connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -1214,7 +1182,7 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous ...@@ -1214,7 +1182,7 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | Yes| Number returned after **connectAbility** is called.| | connection | number | Yes| Number returned after **connectServiceExtensionAbility** is called.|
| callback | AsyncCallback&lt;void&gt; | No| Callback used to return the result.| | callback | AsyncCallback&lt;void&gt; | No| Callback used to return the result.|
**Error codes** **Error codes**
...@@ -1232,14 +1200,13 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous ...@@ -1232,14 +1200,13 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous
```ts ```ts
// connection is the return value of connectServiceExtensionAbility. // connection is the return value of connectServiceExtensionAbility.
var connection = 1; let connection = 1;
try { try {
this.context.disconnectServiceExtensionAbility(connection, (error) => { this.context.disconnectServiceExtensionAbility(connection, (error) => {
if (error.code) { if (error.code) {
// Process service logic errors. // Process service logic errors.
console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('disconnectServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
return; return;
} }
// Carry out normal service processing. // Carry out normal service processing.
...@@ -1247,8 +1214,7 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous ...@@ -1247,8 +1214,7 @@ Disconnects this ability from the ServiceAbility. This API uses an asynchronous
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -1266,7 +1232,7 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret ...@@ -1266,7 +1232,7 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | Yes| Number returned after **connectAbility** is called.| | connection | number | Yes| Number returned after **connectServiceExtensionAbility** is called.|
**Return value** **Return value**
...@@ -1288,8 +1254,8 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret ...@@ -1288,8 +1254,8 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret
**Example** **Example**
```ts ```ts
// connection is the return value of connectAbility. // connection is the return value of connectServiceExtensionAbility.
var connection = 1; let connection = 1;
try { try {
this.context.disconnectServiceExtensionAbility(connection) this.context.disconnectServiceExtensionAbility(connection)
...@@ -1299,13 +1265,11 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret ...@@ -1299,13 +1265,11 @@ Disconnects this ability from the ServiceAbility. This API uses a promise to ret
}) })
.catch((error) => { .catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + console.log('disconnectServiceExtensionAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -1355,14 +1319,14 @@ Observe the following when using this API: ...@@ -1355,14 +1319,14 @@ Observe the following when using this API:
Start an ability in the background. Start an ability in the background.
```ts ```ts
var caller = undefined; let caller;
// Start an ability in the background by not passing parameters. // Start an ability in the background by not passing parameters.
var wantBackground = { let wantBackground = {
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
moduleName: "entry", moduleName: 'entry',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
deviceId: "" deviceId: ''
}; };
try { try {
...@@ -1373,29 +1337,27 @@ Observe the following when using this API: ...@@ -1373,29 +1337,27 @@ Observe the following when using this API:
console.log('startAbilityByCall succeed'); console.log('startAbilityByCall succeed');
}).catch((error) => { }).catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbilityByCall failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
Start an ability in the foreground. Start an ability in the foreground.
```ts ```ts
var caller = undefined; let caller;
// Start an ability in the foreground with ohos.aafwk.param.callAbilityToForeground in parameters set to true. // Start an ability in the foreground with 'ohos.aafwk.param.callAbilityToForeground' in parameters set to true.
var wantForeground = { let wantForeground = {
bundleName: "com.example.myservice", bundleName: 'com.example.myservice',
moduleName: "entry", moduleName: 'entry',
abilityName: "EntryAbility", abilityName: 'EntryAbility',
deviceId: "", deviceId: '',
parameters: { parameters: {
"ohos.aafwk.param.callAbilityToForeground": true 'ohos.aafwk.param.callAbilityToForeground': true
} }
}; };
...@@ -1407,12 +1369,10 @@ Observe the following when using this API: ...@@ -1407,12 +1369,10 @@ Observe the following when using this API:
console.log('startAbilityByCall succeed'); console.log('startAbilityByCall succeed');
}).catch((error) => { }).catch((error) => {
// Process service logic errors. // Process service logic errors.
console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) + console.log('startAbilityByCall failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
' error.message: ' + JSON.stringify(error.message));
}); });
} catch (paramError) { } catch (paramError) {
// Process input parameter errors. // Process input parameter errors.
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
...@@ -19,13 +19,13 @@ The result is obtained by calling [executeShellCommand](js-apis-inner-applicatio ...@@ -19,13 +19,13 @@ The result is obtained by calling [executeShellCommand](js-apis-inner-applicatio
**Example** **Example**
```ts ```ts
import AbilityDelegatorRegistry from "@ohos.app.ability.abilityDelegatorRegistry"; import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
let abilityDelegator; let abilityDelegator;
let cmd = "cmd"; let cmd = 'cmd';
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => { abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => {
console.info("executeShellCommand callback, result: ", err); console.info('executeShellCommand callback, result: ', err);
console.info("executeShellCommand callback, data: ", data); console.info('executeShellCommand callback, data: ', data);
}); });
``` ```
# WindowExtensionContext
The **WindowExtensionContext** module, inherited from [ExtensionContext](js-apis-inner-application-extensionContext.md), is the context environment of the WindowExtensionAbility.
The **WindowExtensionContext** module provides the capabilities of the [WindowExtensionAbility](js-apis-application-windowExtensionAbility.md), including starting the ability.
> **NOTE**
>
> - The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> - The APIs provided by this module are system APIs.
>
> - The APIs of this module can be used only in the stage model.
## Usage
Before using the **WindowExtensionContext** module, you must define a child class that inherits from **WindowExtensionAbility**.
```ts
import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility';
let context;
class WindowExtAbility extends WindowExtensionAbility {
onConnect() {
context = this.context; // Obtain a WindowExtensionContext instance.
}
}
```
## WindowExtensionContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
Starts an ability. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | Yes| Want information about the target ability.|
| options | [StartOptions](js-apis-app-ability-startOptions.md) | Yes| Parameters used for starting the ability.|
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
**Example**
```ts
var want = {
bundleName: 'com.example.myapplication',
abilityName: 'MainAbility'
};
var options = {
windowMode: 102
};
try {
this.context.startAbility(want, options, (error) => {
if (error.code) {
// Process service logic errors.
console.log('startAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
return;
}
// Carry out normal service processing.
console.log('startAbility succeed');
});
} catch (paramError) {
// Process input parameter errors.
console.error('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
}
```
## WindowExtensionContext.startAbility
startAbility(want: Want, options?: StartOptions): Promise\<void>
Starts an ability. This API uses a promise to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | Yes| Want information about the target ability, such as the ability name and bundle name.|
| options | [StartOptions](js-apis-app-ability-startOptions.md) | No| Parameters used for starting the ability.|
**Return value**
| Type| Description|
| -------- | -------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Example**
```ts
var want = {
bundleName: 'com.example.myapp',
abilityName: 'MainAbility'
};
var options = {
windowMode: 102,
};
try {
this.context.startAbility(want, options)
.then((data) => {
// Carry out normal service processing.
console.log('startAbility succeed');
})
.catch((error) => {
// Process service logic errors.
console.log('startAbility failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
});
} catch (paramError) {
// Process input parameter errors.
console.error('error.code: ${JSON.stringify(paramError.code)}, error.message: ${JSON.stringify(paramError.message)}');
}
```
...@@ -7,7 +7,7 @@ The **WantAgentInfo** module defines the information required for triggering a * ...@@ -7,7 +7,7 @@ The **WantAgentInfo** module defines the information required for triggering a *
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------------- | ------------------------------- | ---- | ---------------------- | | -------------- | ------------------------------- | ---- | ---------------------- |
| wants | Array\<Want\> | Yes | Array of all **Want** objects. | | wants | Array\<Want\> | Yes | Array of all **Want** objects. |
| operationType | wantAgent.OperationType | Yes | Operation type. | | operationType | [wantAgent.OperationType](js-apis-app-ability-wantAgent.md#operationtype) | Yes | Operation type. |
| requestCode | number | Yes | Request code defined by the user.| | requestCode | number | Yes | Request code defined by the user.|
| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-app-ability-wantAgent.md#wantagentflags)> | No | Array of flags for using the **WantAgent** object. | | wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-app-ability-wantAgent.md#wantagentflags)> | No | Array of flags for using the **WantAgent** object. |
| extraInfo | {[key: string]: any} | No | Extra information. | | extraInfo | {[key: string]: any} | No | Extra information. |
# @ohos.wantAgent (wantAgent) # @ohos.wantAgent (WantAgent)
The **WantAgent** module provides APIs for creating and comparing **WantAgent** objects, and obtaining the user ID and bundle name of a **WantAgent** object. The **WantAgent** module provides APIs for creating and comparing **WantAgent** objects, and obtaining the user ID and bundle name of a **WantAgent** object.
...@@ -16,7 +16,7 @@ import WantAgent from '@ohos.wantAgent'; ...@@ -16,7 +16,7 @@ import WantAgent from '@ohos.wantAgent';
getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void
Obtains a **WantAgent** object. This API uses an asynchronous callback to return the result. Obtains a **WantAgent** object. This API uses an asynchronous callback to return the result. If the creation fails, a null **WantAgent** object is returned.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -75,7 +75,7 @@ WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); ...@@ -75,7 +75,7 @@ WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
Obtains a **WantAgent** object. This API uses a promise to return the result. Obtains a **WantAgent** object. This API uses a promise to return the result. If the creation fails, a null **WantAgent** object is returned.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -160,8 +160,15 @@ function getWantAgentCallback(err, data) { ...@@ -160,8 +160,15 @@ function getWantAgentCallback(err, data) {
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
// getBundleName callback
function getBundleNameCallback(err, data) {
console.info('==========================>getBundleNameCallback=======================>');
}
WantAgent.getBundleName(wantAgent, getBundleNameCallback);
} }
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -192,12 +199,6 @@ let wantAgentInfo = { ...@@ -192,12 +199,6 @@ let wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
// getBundleName callback
function getBundleNameCallback(err, data) {
console.info('==========================>getBundleNameCallback=======================>');
}
WantAgent.getBundleName(wantAgent, getBundleNameCallback);
``` ```
...@@ -261,10 +262,11 @@ let wantAgentInfo = { ...@@ -261,10 +262,11 @@ let wantAgentInfo = {
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info('==========================>getWantAgentCallback=======================>'); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.getBundleName(wantAgent).then((data) => {
WantAgent.getBundleName(wantAgent).then((data) => {
console.info('==========================>getBundleNameCallback=======================>'); console.info('==========================>getBundleNameCallback=======================>');
});
}
}); });
``` ```
...@@ -300,8 +302,15 @@ function getWantAgentCallback(err, data) { ...@@ -300,8 +302,15 @@ function getWantAgentCallback(err, data) {
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
// getUid callback
function getUidCallback(err, data) {
console.info('==========================>getUidCallback=======================>');
}
WantAgent.getUid(wantAgent, getUidCallback);
} }
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -332,12 +341,6 @@ let wantAgentInfo = { ...@@ -332,12 +341,6 @@ let wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
// getUid callback
function getUidCallback(err, data) {
console.info('==========================>getUidCallback=======================>');
}
WantAgent.getUid(wantAgent, getUidCallback);
``` ```
...@@ -402,10 +405,11 @@ let wantAgentInfo = { ...@@ -402,10 +405,11 @@ let wantAgentInfo = {
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info('==========================>getWantAgentCallback=======================>'); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.getUid(wantAgent).then((data) => {
WantAgent.getUid(wantAgent).then((data) => {
console.info('==========================>getUidCallback=======================>'); console.info('==========================>getUidCallback=======================>');
});
}
}); });
``` ```
...@@ -440,8 +444,15 @@ function getWantAgentCallback(err, data) { ...@@ -440,8 +444,15 @@ function getWantAgentCallback(err, data) {
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
}
// cancel callback
function cancelCallback(err, data) {
console.info('==========================>cancelCallback=======================>');
} }
WantAgent.cancel(wantAgent, cancelCallback);
} }
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -472,12 +483,6 @@ let wantAgentInfo = { ...@@ -472,12 +483,6 @@ let wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
// cancel callback
function cancelCallback(err, data) {
console.info('==========================>cancelCallback=======================>');
}
WantAgent.cancel(wantAgent, cancelCallback);
``` ```
...@@ -542,10 +547,11 @@ let wantAgentInfo = { ...@@ -542,10 +547,11 @@ let wantAgentInfo = {
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info('==========================>getWantAgentCallback=======================>'); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.cancel(wantAgent).then((data) => {
WantAgent.cancel(wantAgent).then((data) => {
console.info('==========================>cancelCallback=======================>'); console.info('==========================>cancelCallback=======================>');
});
}
}); });
``` ```
...@@ -582,8 +588,19 @@ function getWantAgentCallback(err, data) { ...@@ -582,8 +588,19 @@ function getWantAgentCallback(err, data) {
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
// trigger callback
function triggerCallback(data) {
console.info('==========================>triggerCallback=======================>');
}
var triggerInfo = {
code:0
}
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
} }
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -614,16 +631,6 @@ let wantAgentInfo = { ...@@ -614,16 +631,6 @@ let wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
// trigger callback
function triggerCallback(data) {
console.info('==========================>triggerCallback=======================>');
}
var triggerInfo = {
code:0
}
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
``` ```
...@@ -661,8 +668,15 @@ function getWantAgentCallback(err, data) { ...@@ -661,8 +668,15 @@ function getWantAgentCallback(err, data) {
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
}
// equal callback
function equalCallback(err, data) {
console.info('==========================>equalCallback=======================>');
} }
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
} }
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -693,12 +707,6 @@ let wantAgentInfo = { ...@@ -693,12 +707,6 @@ let wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
// equal callback
function equalCallback(err, data) {
console.info('==========================>equalCallback=======================>');
}
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
``` ```
...@@ -766,6 +774,11 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -766,6 +774,11 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info('==========================>getWantAgentCallback=======================>'); console.info('==========================>getWantAgentCallback=======================>');
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
if (data) {
WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
console.info('==========================>equalCallback=======================>');
});
}
}); });
WantAgent.equal(wantAgent1, wantAgent2).then((data) => { WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
...@@ -827,11 +840,12 @@ let wantAgentInfo = { ...@@ -827,11 +840,12 @@ let wantAgentInfo = {
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info('==========================>getWantAgentCallback=======================>'); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (data) {
WantAgent.getOperationType(wantAgent, (OperationType) => {
WantAgent.getOperationType(wantAgent, (OperationType) => {
console.log('----------- getOperationType ----------, OperationType: ' + OperationType); console.log('----------- getOperationType ----------, OperationType: ' + OperationType);
}) })
}
});
``` ```
## WantAgent.getOperationType<sup>9+</sup> ## WantAgent.getOperationType<sup>9+</sup>
...@@ -901,7 +915,6 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -901,7 +915,6 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => {
}); });
``` ```
## WantAgentFlags ## WantAgentFlags
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -940,5 +953,5 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -940,5 +953,5 @@ WantAgent.getWantAgent(wantAgentInfo).then((data) => {
| info | WantAgent | Yes | A triggered **WantAgent** object. | | info | WantAgent | Yes | A triggered **WantAgent** object. |
| want | Want | Yes | An existing triggered **want**. | | want | Want | Yes | An existing triggered **want**. |
| finalCode | number | Yes | Request code that triggers the **WantAgent** object.| | finalCode | number | Yes | Request code that triggers the **WantAgent** object.|
| finalData | string | No | Final data collected by the common event. | | finalData | string | Yes | Final data collected by the common event. |
| extraInfo | {[key: string]: any} | No | Extra information. | | extraInfo | {[key: string]: any} | No | Extra information. |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册