提交 80468ef5 编写于 作者: G Gloria

Update docs against 13788+14684

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 00bea328
...@@ -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.app.ability.wantConstant'; import wantConstant from '@ohos.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.app.ability.wantConstant'; import wantConstant from '@ohos.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';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( var dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
'dataability:///com.example.DataAbility' "dataability:///com.example.DataAbility"
); );
``` ```
...@@ -154,10 +154,7 @@ let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( ...@@ -154,10 +154,7 @@ let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
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: 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.
- 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.
...@@ -177,24 +174,24 @@ Observe the following when using this API: ...@@ -177,24 +174,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.app.ability.wantConstant'; import wantConstant from '@ohos.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));
} }
); );
``` ```
...@@ -203,10 +200,7 @@ featureAbility.startAbilityForResult( ...@@ -203,10 +200,7 @@ featureAbility.startAbilityForResult(
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
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: 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.
- 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.
...@@ -231,35 +225,35 @@ Observe the following when using this API: ...@@ -231,35 +225,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.app.ability.wantConstant'; import wantConstant from '@ohos.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));
}); });
``` ```
...@@ -282,35 +276,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe ...@@ -282,35 +276,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.app.ability.wantConstant'; import wantConstant from '@ohos.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.error('err: ${JSON.stringify(err)}'); console.info("err: " + JSON.stringify(err))
} }
); );
``` ```
...@@ -339,35 +333,35 @@ Terminates this ability. If the ability is started by calling [startAbilityForRe ...@@ -339,35 +333,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.app.ability.wantConstant'; import wantConstant from '@ohos.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=======================>");
}); });
``` ```
...@@ -390,7 +384,7 @@ Checks whether the main window of this ability has the focus. This API uses an a ...@@ -390,7 +384,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));
}); });
``` ```
...@@ -413,7 +407,7 @@ Checks whether the main window of this ability has the focus. This API uses a pr ...@@ -413,7 +407,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));
}); });
``` ```
...@@ -436,7 +430,7 @@ Obtains the Want corresponding to the ability to start. This API uses an asynchr ...@@ -436,7 +430,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));
}); });
``` ```
...@@ -459,7 +453,7 @@ Obtains the Want corresponding to the ability to start. This API uses a promise ...@@ -459,7 +453,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));
}); });
``` ```
...@@ -481,9 +475,9 @@ Obtains the application context. ...@@ -481,9 +475,9 @@ Obtains the application context.
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext(); var 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));
}); });
``` ```
...@@ -507,7 +501,7 @@ Terminates this ability. This API uses an asynchronous callback to return the re ...@@ -507,7 +501,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.error('err: ${JSON.stringify(err)}'); console.info("err: " + JSON.stringify(err))
} }
) )
``` ```
...@@ -531,7 +525,7 @@ Terminates this ability. This API uses a promise to return the result. ...@@ -531,7 +525,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=======================>");
}); });
``` ```
...@@ -568,19 +562,19 @@ Observe the following when using this API: ...@@ -568,19 +562,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)
} }
let connectId = featureAbility.connectAbility( var 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,
...@@ -611,18 +605,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses an asynch ...@@ -611,18 +605,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)
} }
let connectId = featureAbility.connectAbility( var 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,
...@@ -630,10 +624,11 @@ let connectId = featureAbility.connectAbility( ...@@ -630,10 +624,11 @@ let connectId = featureAbility.connectAbility(
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
var result = featureAbility.disconnectAbility(connectId,
featureAbility.disconnectAbility(connectId, (err) => { (error) => {
console.error('featureAbilityTest disconnectAbility err: ${JSON.stringify(err)}'); console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code)
}); },
);
``` ```
## featureAbility.disconnectAbility<sup>7+</sup> ## featureAbility.disconnectAbility<sup>7+</sup>
...@@ -662,18 +657,18 @@ Disconnects this ability from a specific ServiceAbility. This API uses a promise ...@@ -662,18 +657,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)
} }
let connectId = featureAbility.connectAbility( var 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,
...@@ -683,9 +678,9 @@ let connectId = featureAbility.connectAbility( ...@@ -683,9 +678,9 @@ let 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.error('featureAbilityTest result errCode : ${error.code}'); console.log('featureAbilityTest result errCode : ' + error.code);
}); });
``` ```
...@@ -708,7 +703,7 @@ Obtains the window corresponding to this ability. This API uses an asynchronous ...@@ -708,7 +703,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));
}); });
``` ```
...@@ -730,7 +725,7 @@ Obtains the window corresponding to this ability. This API uses a promise to ret ...@@ -730,7 +725,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));
}); });
``` ```
...@@ -750,8 +745,8 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED ...@@ -750,8 +745,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 left screen in horizontal direction or the upper screen in vertical direction is the primary window.| | 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_SECONDARY<sup>7+</sup> | 101 | The right screen in horizontal direction or the lower screen in vertical direction is the secondary 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_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.|
...@@ -771,9 +766,9 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -771,9 +766,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.error('particleAbility startAbility errCode: ${JSON.stringify(error)}, result: ${JSON.stringify(result)}'); console.log('particleAbility startAbility errCode:' + error + 'result:' + 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: ${JSON.stringify(error)}, result: ${JSON.stringify(result)}'); console.log('particleAbility terminateSelf errCode:' + error + 'result:' + 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'
let uri = ''; var 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)
} }
let connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: 'com.ix.ServiceAbility', bundleName: "com.ix.ServiceAbility",
abilityName: 'ServiceAbilityA', abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -441,9 +441,9 @@ let connId = particleAbility.connectAbility( ...@@ -441,9 +441,9 @@ let 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)
} }
let connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: 'com.ix.ServiceAbility', bundleName: "com.ix.ServiceAbility",
abilityName: 'ServiceAbilityA', abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -492,7 +492,8 @@ let connId = particleAbility.connectAbility( ...@@ -492,7 +492,8 @@ let connId = particleAbility.connectAbility(
); );
particleAbility.disconnectAbility(connId, (err) => { particleAbility.disconnectAbility(connId, (err) => {
console.log('particleAbilityTest disconnectAbility err: ${JSON.stringify(err)}'); console.log("particleAbilityTest disconnectAbility err====>"
+ ("json err=") + JSON.stringify(err));
}); });
``` ```
...@@ -518,21 +519,21 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -518,21 +519,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)
} }
let connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: 'com.ix.ServiceAbility', bundleName: "com.ix.ServiceAbility",
abilityName: 'ServiceAbilityA', abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
...@@ -542,9 +543,9 @@ let connId = particleAbility.connectAbility( ...@@ -542,9 +543,9 @@ let 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)
}); });
``` ```
......
...@@ -736,9 +736,15 @@ Rotates this image based on the input angle. This API uses an asynchronous callb ...@@ -736,9 +736,15 @@ Rotates this image based on the input angle. This API uses an asynchronous callb
**Example** **Example**
```js ```js
async function Demo() { var angle = 90.0;
await pixelmap.rotate(90.0); pixelmap.rotate(angle, (err) => {
} if (err) {
console.error("Failed to set rotation.");
return;
} else {
console.log("Succeeded in setting rotation.");
}
})
``` ```
### rotate<sup>9+</sup> ### rotate<sup>9+</sup>
...@@ -942,7 +948,8 @@ Creates an **ImageSource** instance based on the URI. ...@@ -942,7 +948,8 @@ Creates an **ImageSource** instance based on the URI.
**Example** **Example**
```js ```js
let path = this.context.getApplicationContext().fileDirs + "test.jpg"; let context = featureAbility.getContext();
let path = context.getCacheDir() + "test.jpg";
const imageSourceApi = image.createImageSource(path); const imageSourceApi = image.createImageSource(path);
``` ```
...@@ -2039,7 +2046,7 @@ Creates an **ImageCreator** instance by specifying the image width, height, form ...@@ -2039,7 +2046,7 @@ Creates an **ImageCreator** instance by specifying the image width, height, form
| Type | Description | | Type | Description |
| ------------------------------ | --------------------------------------- | | ------------------------------ | --------------------------------------- |
| [ImageCreator](#imagecreator9) | Returns an **ImageCreator** instance if the operation is successful.| | [ImageCreator](#imagecreator9) | Returns an **ImageCreator** instance if the operation is successful.|
**Example** **Example**
...@@ -2524,7 +2531,7 @@ Defines the option for image packing. ...@@ -2524,7 +2531,7 @@ Defines the option for image packing.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ------- | ------ | ---- | ---- | --------------------------------------------------- | | ------- | ------ | ---- | ---- | --------------------------------------------------- |
| format | string | Yes | Yes | Format of the packed image.<br>Currently, the following formats are supported: JPG, PNG, GIF, BMP, Webp, and RAW.| | format | string | Yes | Yes | Format of the packed image.<br>Only the JPG and WebP formats are supported.|
| quality | number | Yes | Yes | Quality of the output image in JPEG encoding. The value ranges from 1 to 100.| | quality | number | Yes | Yes | Quality of the output image in JPEG encoding. The value ranges from 1 to 100.|
| bufferSize<sup>9+</sup> | number | Yes | Yes | Buffer size, which is used to set the image size. The default value is 10 MB.| | bufferSize<sup>9+</sup> | number | Yes | Yes | Buffer size, which is used to set the image size. The default value is 10 MB.|
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册