Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 65eacf9e 编写于 作者: Y yuyaozhi
浏览文件
操作

Fix sample code of ability 

Signed-off-by: Nyuyaozhi <yuyaozhi@huawei.com>
上级 e3868b16
隐藏空白更改
内联 并排
Showing with 272 addition and 312 deletion
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @ 65eacf9e
# AbilityRunningInfo
AbilityRunningInfo模块提供对Ability运行的相关信息和状态进行设置和查询的能力。
AbilityRunningInfo模块提供对Ability运行的相关信息和状态的定义。
> **说明：**
>
......
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ 65eacf9e
......@@ -339,13 +339,15 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any})
**示例：**
```js
class myAbility extends Ability {
onSaveState(reason, wantParam) {
console.log('onSaveState');
wantParams["myData"] = "my1234567";
return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
}
}
import AbilityConstant from '@ohos.application.AbilityConstant'
class myAbility extends Ability {
onSaveState(reason, wantParam) {
console.log('onSaveState');
wantParam["myData"] = "my1234567";
return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
}
}
```
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
浏览文件 @ 65eacf9e
......@@ -22,7 +22,7 @@ abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
### addAbilityMonitor<sup>9+</sup>
addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void;
添加AbilityMonitor实例（callback形式）
......@@ -30,7 +30,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
**参数：**
| 参数名 | 类型 | 必填说明 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
......@@ -55,11 +55,9 @@ abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
});
```
### addAbilityMonitor<sup>9+</sup>
addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
添加AbilityMonitor实例（promise形式）
......@@ -101,7 +99,7 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => {
### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void;
删除已经添加的AbilityMonitor实例（callback形式）
......@@ -138,7 +136,7 @@ abilityDelegator.removeAbilityMonitor(monitor, (err : any) => {
### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
删除已经添加的AbilityMonitor实例（promise形式）
......@@ -146,7 +144,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 |
......@@ -180,7 +178,7 @@ abilityDelegator.removeAbilityMonitor(monitor).then(() => {
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>): void
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>): void;
等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式）
......@@ -191,7 +189,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 |
| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
**示例：**
......@@ -213,11 +211,9 @@ abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => {
});
```
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback\<Ability>): void
waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback\<UIAbility>): void;
设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式）
......@@ -229,7 +225,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 |
| timeout | number | 是 | 最大等待时间，单位毫秒（ms） |
| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
**示例：**
......@@ -256,7 +252,7 @@ abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) =>
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<UIAbility>;
设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（promise形式）
......@@ -273,7 +269,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
| 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------- |
| Promise\<[Ability](js-apis-application-ability.md#Ability)> | 以Promise形式返回Ability。 |
| Promise\<[UIAbility](js-apis-application-ability.md#Ability)> | 以Promise形式返回Ability。 |
**示例：**
......@@ -299,7 +295,7 @@ abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => {
### getAppContext<sup>9+</sup>
getAppContext(): Context
getAppContext(): Context;
获取应用Context
......@@ -324,7 +320,7 @@ var context = abilityDelegator.getAppContext();
### getAbilityState<sup>9+</sup>
getAbilityState(ability: Ability): number
getAbilityState(ability: UIAbility): number;
获取指定ability的生命周期状态
......@@ -334,7 +330,7 @@ getAbilityState(ability: Ability): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------- | ---- | --------------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 指定Ability对象 |
| ability | [UIAbility](js-apis-application-ability.md#Ability) | 是 | 指定Ability对象 |
**返回值：**
......@@ -361,7 +357,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(callback: AsyncCallback\<Ability>): void
getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void;
获取当前应用顶部ability（callback形式）
......@@ -371,7 +367,7 @@ getCurrentTopAbility(callback: AsyncCallback\<Ability>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 |
**示例：**
......@@ -390,7 +386,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(): Promise\<Ability>
getCurrentTopAbility(): Promise\<UIAbility>;
获取当前应用顶部ability（promise形式）
......@@ -400,7 +396,7 @@ getCurrentTopAbility(): Promise\<Ability>
| 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------------------- |
| Promise\<[Ability](js-apis-application-ability.md#Ability)> | 以Promise形式返回当前应用顶部ability。 |
| Promise\<[UIAbility](js-apis-application-ability.md#Ability)> | 以Promise形式返回当前应用顶部ability。 |
**示例：**
......@@ -419,7 +415,7 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => {
### startAbility<sup>9+</sup>
startAbility(want: Want, callback: AsyncCallback\<void>): void
startAbility(want: Want, callback: AsyncCallback\<void>): void;
启动指定ability（callback形式）
......@@ -451,7 +447,7 @@ abilityDelegator.startAbility(want, (err : any, data : any) => {
### startAbility<sup>9+</sup>
startAbility(want: Want): Promise\<void>
startAbility(want: Want): Promise\<void>;
启动指定ability（promise形式）
......@@ -488,7 +484,7 @@ abilityDelegator.startAbility(want).then((data: any) => {
### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void
doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void;
调度指定ability生命周期状态到Foreground状态（callback形式）
......@@ -498,8 +494,8 @@ doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------- |
| ability | Ability | 是 | 指定Ability对象 |
| callback | AsyncCallback\<boolean> | 是 | 表示指定的回调方法<br/>\- true：成功<br/>\- false：失败 |
| ability | UIAbility | 是 | 指定Ability对象 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法<br/>\- true：成功<br/>\- false：失败 |
**示例：**
......@@ -521,7 +517,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability: Ability): Promise\<boolean>
doAbilityForeground(ability: UIAbility): Promise\<void>;
调度指定ability生命周期状态到Foreground状态（promise形式）
......@@ -531,7 +527,7 @@ doAbilityForeground(ability: Ability): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | --------------- |
| ability | Ability | 是 | 指定Ability对象 |
| ability | UIAbility | 是 | 指定Ability对象 |
**返回值：**
......@@ -559,7 +555,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void
doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void;
调度指定ability生命周期状态到Background状态（callback形式）
......@@ -569,8 +565,8 @@ doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------- |
| ability | Ability | 是 | 指定Ability对象 |
| callback | AsyncCallback\<boolean> | 是 | 表示指定的回调方法<br/>\- true：成功<br/>\- false：失败 |
| ability | UIAbility | 是 | 指定Ability对象 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法<br/>\- true：成功<br/>\- false：失败 |
**示例：**
......@@ -592,7 +588,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability: Ability): Promise\<boolean>
doAbilityBackground(ability: UIAbility): Promise\<void>;
调度指定ability生命周期状态到Background状态（promise形式）
......@@ -602,7 +598,7 @@ doAbilityBackground(ability: Ability): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | --------------- |
| ability | Ability | 是 | 指定Ability对象 |
| ability | UIAbility | 是 | 指定Ability对象 |
**返回值：**
......@@ -630,7 +626,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### printSync<sup>9+</sup>
printSync(msg: string): void
printSync(msg: string): void;
打印日志信息到单元测试终端控制台
......@@ -656,7 +652,7 @@ abilityDelegator.printSync(msg);
### print
print(msg: string, callback: AsyncCallback\<void>): void
print(msg: string, callback: AsyncCallback\<void>): void;
打印日志信息到单元测试终端控制台（callback形式）
......@@ -685,7 +681,7 @@ abilityDelegator.print(msg, (err : any) => {
### print
print(msg: string): Promise\<void>
print(msg: string): Promise\<void>;
打印日志信息到单元测试终端控制台（promise形式）
......@@ -719,7 +715,7 @@ abilityDelegator.print(msg).then(() => {
### executeShellCommand
executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void
executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void;
执行指定的shell命令（callback形式）
......@@ -748,7 +744,7 @@ abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<ShellCmdResult>): void
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<ShellCmdResult>): void;
指定超时时间，并执行指定的shell命令（callback形式）
......@@ -779,7 +775,7 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>
executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>;
指定超时时间，并执行指定的shell命令（promise形式）
......@@ -815,7 +811,7 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void
finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void;
结束测试并打印日志信息到单元测试终端控制台（callback形式）
......@@ -845,7 +841,7 @@ abilityDelegator.finishTest(msg, 0, (err : any) => {
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number): Promise\<void>
finishTest(msg: string, code: number): Promise\<void>;
结束测试并打印日志信息到单元测试终端控制台（promise形式）
......@@ -886,7 +882,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo
**参数：**
| 参数名 | 类型 | 必填说明 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
......@@ -955,7 +951,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\
**参数：**
| 参数名 | 类型 | 必填说明 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
......@@ -1024,7 +1020,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A
**参数：**
| 参数名 | 类型 | 必填说明 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 |
| callback | AsyncCallback\<AbilityStage> | 是 | 成功返回AbilityStage对象，失败返回空。 |
......@@ -1062,7 +1058,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 |
| timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 |
| timeout | number | 是 | 超时最大等待时间，以毫秒为单位。 |
**返回值：**
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @ 65eacf9e
......@@ -156,16 +156,18 @@ onAbilityContinue(ability: Ability): void;
**示例：**
```js
import Ability from "@ohos.application.Ability";
export default class MyAbility extends Ability {
onCreate() {
console.log("MyAbility onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
```js
import AbilityStage from "@ohos.application.AbilityStage";
var lifecycleid;
export default class MyAbilityStage extends AbilityStage {
onCreate() {
console.log("MyAbilityStage onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
onWindowStageCreate(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage));
......@@ -182,30 +184,30 @@ onAbilityContinue(ability: Ability): void;
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage));
},
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
let lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid));
},
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
```
\ No newline at end of file
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid));
}
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md
浏览文件 @ 65eacf9e
......@@ -15,7 +15,6 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力，
let applicationContext = this.context.getApplicationContext();
```
## ApplicationContext.registerAbilityLifecycleCallback
registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**;
......@@ -38,7 +37,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
**示例：**
```js
```js
import Ability from "@ohos.application.Ability";
var lifecycleId;
......@@ -46,36 +45,36 @@ var lifecycleId;
export default class MyAbility extends Ability {
onCreate() {
console.log("MyAbility onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
let AbilityLifecycleCallback = {
onAbilityCreate(ability) {
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
onWindowStageCreate(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage));
onWindowStageCreate(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage));
},
onWindowStageActive(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage));
onWindowStageActive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage));
},
onWindowStageInactive(ability, windowStage){
onWindowStageInactive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage));
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage));
},
onWindowStageDestroy(ability, windowStage){
onWindowStageDestroy(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage));
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage));
},
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
onAbilityDestroy(ability) {
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
onAbilityForeground(ability) {
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
onAbilityBackground(ability) {
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
onAbilityContinue(ability) {
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
......@@ -84,16 +83,9 @@ export default class MyAbility extends Ability {
// 2.通过applicationContext注册监听应用内生命周期
lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId));
},
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
```
```
## ApplicationContext.unregisterAbilityLifecycleCallback
......@@ -112,14 +104,21 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
let lifecycleId = 1;
console.log("stage applicationContext: " + JSON.stringify(applicationContext));
applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
```
```js
import Ability from "@ohos.application.Ability";
var lifecycleId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
console.log("stage applicationContext: " + JSON.stringify(applicationContext));
applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
```
## ApplicationContext.registerEnvironmentCallback
......@@ -143,7 +142,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
**示例：**
```js
```js
import Ability from "@ohos.application.Ability";
var callbackId;
......@@ -163,14 +162,8 @@ export default class MyAbility extends Ability {
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId));
}
onDestroy() {
let applicationContext = globalThis.applicationContext;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
}
}
```
```
## ApplicationContext.unregisterEnvironmentCallback
......@@ -189,10 +182,17 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<*
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
let callbackId = 1;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
```
```js
import Ability from "@ohos.application.Ability";
var callbackId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
}
}
```
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ 65eacf9e
......@@ -67,17 +67,10 @@ createBundleContext(bundleName: string): Context;
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let test = "com.example.test";
let context = this.context.createBundleContext(test);
}
}
let test = "com.example.test";
let context = this.context.createBundleContext(test);
```
## Context.createModuleContext
createModuleContext(moduleName: string): Context;
......@@ -101,17 +94,10 @@ createModuleContext(moduleName: string): Context;
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let moduleName = "module";
let context = this.context.createModuleContext(moduleName);
}
}
let moduleName = "module";
let context = this.context.createModuleContext(moduleName);
```
## Context.createModuleContext
createModuleContext(bundleName: string, moduleName: string): Context;
......@@ -138,15 +124,9 @@ createModuleContext(bundleName: string, moduleName: string): Context;
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let bundleName = "com.example.bundle";
let moduleName = "module";
let context = this.context.createModuleContext(bundleName, moduleName);
}
}
let bundleName = "com.example.bundle";
let moduleName = "module";
let context = this.context.createModuleContext(bundleName, moduleName);
```
## Context.getApplicationContext
......@@ -166,16 +146,9 @@ getApplicationContext(): ApplicationContext;
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let applicationContext = this.context.getApplicationContext();
}
}
let applicationContext = this.context.getApplicationContext();
```
## AreaMode
访问的文件分区，每个文件分区有对应自己的内容。
......
zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md
浏览文件 @ 65eacf9e
......@@ -9,7 +9,7 @@ quickFixManager模块提供快速修复的能力，快速修复是OpenHarmony提
## 导入模块
```
import quickFixManager from '@ohos.application.quickFixManager';
import quickFixManager from '@ohos.app.ability.quickFixManager';
```
## HapModuleQuickFixInfo
......@@ -65,7 +65,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>, callback: AsyncCallback\<v
**示例：**
```js
import quickFixManager from '@ohos.application.quickFixManager'
import quickFixManager from '@ohos.app.ability.quickFixManager'
let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"]
quickFixManager.applyQuickFix(hapModuleQuickFixFiles, (error) => {
......@@ -104,7 +104,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>): Promise\<void>;
**示例：**
```js
import quickFixManager from '@ohos.application.quickFixManager'
import quickFixManager from '@ohos.app.ability.quickFixManager'
let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"]
quickFixManager.applyQuickFix(hapModuleQuickFixFiles).then(() => {
......@@ -136,7 +136,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\<Applicat
**示例：**
```js
import quickFixManager from '@ohos.application.quickFixManager'
import quickFixManager from '@ohos.app.ability.quickFixManager'
let bundleName = "bundleName"
quickFixManager.getApplicationQuickFixInfo(bundleName, (error, data) => {
......@@ -175,7 +175,7 @@ getApplicationQuickFixInfo(bundleName: string): Promise\<ApplicationQuickFixInfo
**示例：**
```js
import quickFixManager from '@ohos.application.quickFixManager'
import quickFixManager from '@ohos.app.ability.quickFixManager'
let bundleName = "bundleName"
quickFixManager.getApplicationQuickFixInfo(bundleName).then((data) => {
......
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ 65eacf9e
......@@ -9,7 +9,6 @@
使用前根据具体情况引入如下模块
```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
import ohos_data_rdb from '@ohos.data.rdb'
```
......@@ -24,11 +23,11 @@ openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法，返回文件描述符。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法，返回文件说明符。 |
**示例：**
......@@ -56,7 +55,7 @@ openFile(uri: string, mode: string): Promise\<number>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
......@@ -65,7 +64,7 @@ openFile(uri: string, mode: string): Promise\<number>
| 类型 | 说明 |
| ---------------- | ---------------- |
| Promise\<number> | 返回文件描述符。 |
| Promise\<number> | 返回文件说明符。 |
**示例：**
......@@ -92,7 +91,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
......@@ -125,7 +124,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
......@@ -162,7 +161,7 @@ getType(uri: string, callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<string> | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 |
......@@ -191,7 +190,7 @@ getType(uri: string): Promise\<string>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
......@@ -225,7 +224,7 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
......@@ -258,7 +257,7 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
......@@ -294,7 +293,7 @@ normalizeUri(uri: string, callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 |
......@@ -323,7 +322,7 @@ normalizeUri(uri: string): Promise\<string>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
......@@ -357,7 +356,7 @@ denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 |
......@@ -388,7 +387,7 @@ denormalizeUri(uri: string): Promise\<string>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
......@@ -422,7 +421,7 @@ notifyChange(uri: string, callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 |
......@@ -451,7 +450,7 @@ notifyChange(uri: string): Promise\<void>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
......@@ -485,7 +484,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<num
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
......@@ -522,7 +521,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
......@@ -564,7 +563,7 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: Async
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
......@@ -598,7 +597,7 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
......@@ -637,7 +636,7 @@ delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: Asy
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
......@@ -670,7 +669,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
......@@ -708,7 +707,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.Data
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
......@@ -749,7 +748,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
......@@ -795,7 +794,7 @@ query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityP
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
......@@ -833,7 +832,7 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
......@@ -874,7 +873,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
......@@ -910,7 +909,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
......@@ -943,7 +942,7 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: As
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 |
......@@ -976,7 +975,7 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Ar
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 |
......@@ -1009,7 +1008,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ |
| [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。|
......@@ -1017,7 +1016,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数类型 | 可读 | 可写 | 必填| 说明 |
| 名称 | 类型 | 可读 | 可写 | 必填| 说明 |
| -------- | -------- | -------- | -------- | --------| -------- |
| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 |
......@@ -1032,7 +1031,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数类型 | 可读 | 可写 | 必填 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @ 65eacf9e
......@@ -23,7 +23,6 @@ export default class MainAbility extends Ability {
}
```
## EventHub.on
on(event: string, callback: Function): void;
......
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ 65eacf9e
......@@ -27,7 +27,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 |
......@@ -70,7 +70,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
......@@ -109,7 +109,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
......@@ -138,7 +138,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 |
......@@ -179,7 +179,7 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | ------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability |
......@@ -235,7 +235,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | -------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
......@@ -287,7 +287,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability |
......@@ -343,7 +343,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
......@@ -389,7 +389,7 @@ getWant(callback: AsyncCallback\<Want>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是 | 被指定的回调方法。 |
......@@ -459,7 +459,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
......@@ -507,7 +507,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | --------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | [ConnectOptions](#connectoptions) | 是 | 被指定的回调方法。 |
......@@ -518,7 +518,7 @@ ConnectOptions类型说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 参数名 | 读写属性 | 类型 | 必填 | 说明 |
| ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect<sup>7+</sup> | 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect<sup>7+</sup> | 只读 | function | 是 | 连接失败时的回调函数。 |
......@@ -568,7 +568,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------- | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
......@@ -615,7 +615,7 @@ disconnectAbility(connection: number): Promise\<void>
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
......@@ -669,7 +669,7 @@ getWindow(callback: AsyncCallback\<window.Window>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<window.Window> | 是 | 返回与当前Ability对应的窗口。 |
......@@ -713,7 +713,7 @@ onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------- | ---- | -------- |
| elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 |
......@@ -756,7 +756,7 @@ onDisconnect(elementName: ElementName): void;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------- | ---- | ---- |
| elementName | ElementName | 是 | 元素名。 |
......@@ -798,7 +798,7 @@ ConnectAbility调用失败时的回调函数。
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| code | number | 是 | number类型。 |
......@@ -846,7 +846,7 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数 | 描述 |
| 名称 | 值 | 说明 |
| ---------------------------------------- | ---- | ---------------------------------------- |
| WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。 |
......@@ -869,11 +869,11 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数 | 描述 |
| 名称 | 值 | 说明 |
| ---------------------------- | --------------- | ---------------------------------------- |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的名称。 |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的名称。|
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的名称。 |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的参数名。 |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的参数名。|
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的参数名。 |
## ErrorCode
......@@ -881,7 +881,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR<sup>7+</sup> | 0 | 没有错误。 |
| INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。 |
......@@ -895,7 +895,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------------------------- |
| TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。 |
| TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。 |
......@@ -908,25 +908,25 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------------------- | ---- | ------------- | ---- | ------------------------------------- |
| resultCode<sup>7+</sup> | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want<sup>7+</sup> | 只读 | [Want](js-apis-application-Want.md) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
| 名称 | 类型 | 可读| 可写 | 必填 | 说明 |
| --------------- |-------- | ------ | ------------- | ---- | ------------------------------------- |
| resultCode<sup>7+</sup>| number| 是 | 否 | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want<sup>7+</sup> | [Want](js-apis-application-Want.md)| 是 | 否 | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
## StartAbilityParameter
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | ---- | -------------------- | ---- | -------------------------------------- |
| want | 只读 | [Want](js-apis-application-Want.md) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
| 参数名 | 类型 | 可读| 可写 | 必填 | 说明 |
| ------------------- | -------- | -------------------- | ---- | -------------------------------------- |
| want | [Want](js-apis-application-Want.md)| 是 | 否 | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | {[key: string]: any} | 是 |否 | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## flags说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数 | 描述 |
| 名称 | 值 | 说明 |
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
......
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @ 65eacf9e
......@@ -49,7 +49,8 @@ registerMissionListener(listener: MissionListener): number;
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
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-------")}
};
console.log("registerMissionListener")
var listenerid = missionManager.registerMissionListener(listener);
......@@ -84,7 +85,8 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
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-------")}
};
console.log("registerMissionListener")
var listenerid = missionManager.registerMissionListener(listener);
......@@ -128,7 +130,8 @@ unregisterMissionListener(listenerId: number): Promise&lt;void&gt;;
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
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-------")}
};
console.log("registerMissionListener")
var listenerid = missionManager.registerMissionListener(listener);
......
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ 65eacf9e
......@@ -27,8 +27,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>):
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
......@@ -59,8 +58,6 @@ particleAbility.startAbility(
)
```
## particleAbility.startAbility
startAbility(parameter: StartAbilityParameter): Promise\<void>;
......@@ -71,8 +68,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability |
......@@ -117,7 +113,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
......@@ -169,7 +165,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
......@@ -386,7 +382,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
......@@ -396,7 +392,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 参数名 | 读写属性 | 类型 | 必填 | 说明 |
| ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 |
......@@ -546,7 +542,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| INVALID_PARAMETER | -1 | 无效的参数。 |
......
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
浏览文件 @ 65eacf9e
# WantAgent模块
WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力，包括创建WantAgent实例、获取实例的用户ID、获取want信息等。
WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle参数名的能力，包括创建WantAgent实例、获取实例的用户ID、获取want信息等。
> **说明：**
>
......@@ -22,7 +22,7 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | --- | ---- | -------------------------- | ---- | ----------------------- |
| info | 是 | 否 | WantAgentInfo | 是 | WantAgent信息。 |
| callback | 是 | 否 | AsyncCallback\<WantAgent\> | 是 | 创建WantAgent的回调方法。 |
......@@ -79,7 +79,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---- | --- | ---- | ------------- | ---- | ------------- |
| info | 是 | 否 | WantAgentInfo | 是 | WantAgent信息。 |
......@@ -140,7 +140,7 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | --- | ---- | ----------------------- | ---- | --------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<string\> | 是 | 获取WantAgent实例的包名的回调方法。 |
......@@ -212,7 +212,7 @@ getBundleName(agent: WantAgent): Promise\<string\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -281,7 +281,7 @@ getUid(agent: WantAgent, callback: AsyncCallback\<number\>): void
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | --- | ---- | ----------------------- | ---- | ----------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<number\> | 是 | 获取WantAgent实例的用户ID的回调方法。 |
......@@ -353,7 +353,7 @@ getUid(agent: WantAgent): Promise\<number\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -424,7 +424,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | --- | ---- | --------------------- | ---- | ------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<Want\> | 是 | 获取WantAgent对象want的回调方法。 |
......@@ -498,7 +498,7 @@ getWant(agent: WantAgent): Promise\<Want\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -567,7 +567,7 @@ cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | --- | ---- | --------------------- | ---- | --------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 取消WantAgent实例的回调方法。 |
......@@ -639,7 +639,7 @@ cancel(agent: WantAgent): Promise\<void\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -708,7 +708,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<Complet
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | --- | ---- | ----------------------------- | ---- | ------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| triggerInfo | 是 | 否 | TriggerInfo | 是 | TriggerInfo对象。 |
......@@ -785,7 +785,7 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | ------------------------ | ---- | --------------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| otherAgent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -860,7 +860,7 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| otherAgent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -930,7 +930,7 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void;
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | ------------------------ | ---- | --------------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<number> | 是 | 获取一个WantAgent的OperationType信息的回调方法。 |
......@@ -991,7 +991,7 @@ getOperationType(agent: WantAgent): Promise\<number>;
**参数：**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 参数名 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
......@@ -1049,13 +1049,11 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => {
})
```
## WantAgentInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------------- | --- | ---- | ------------------------------- | ---- | ---------------------- |
| wants | 是 | 是 | Array\<Want\> | 是 | 将被执行的动作列表。 |
| operationType | 是 | 是 | wantAgent.OperationType | 是 | 动作类型。 |
......@@ -1063,26 +1061,22 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => {
| wantAgentFlags | 是 | 是 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
## WantAgentFlags
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ------------------- | -------------- | ------------------------------------------------------------ |
| ONE_TIME_FLAG | WantAgentFlags | WantAgent仅能使用一次。 |
| NO_BUILD_FLAG | WantAgentFlags | 如果描述WantAgent对象不存在，则不创建它，直接返回null。 |
| CANCEL_PRESENT_FLAG | WantAgentFlags | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。 |
| UPDATE_PRESENT_FLAG | WantAgentFlags | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。 |
| CONSTANT_FLAG | WantAgentFlags | WantAgent是不可变的。 |
| REPLACE_ELEMENT | WantAgentFlags | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 |
| REPLACE_ACTION | WantAgentFlags | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 |
| REPLACE_URI | WantAgentFlags | 当前Want中的uri属性可被WantAgent.trigger()中Want的uri属性取代 |
| REPLACE_ENTITIES | WantAgentFlags | 当前Want中的entities属性可被WantAgent.trigger()中Want的entities属性取代 |
| REPLACE_BUNDLE | WantAgentFlags | 当前Want中的bundleName属性可被WantAgent.trigger()中Want的bundleName属性取代 |
| ONE_TIME_FLAG | 0 | WantAgent仅能使用一次。 |
| NO_BUILD_FLAG | 1 | 如果说明WantAgent对象不存在，则不创建它，直接返回null。 |
| CANCEL_PRESENT_FLAG | 2 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。 |
| UPDATE_PRESENT_FLAG | 3 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。 |
| CONSTANT_FLAG | 4 | WantAgent是不可变的。 |
| REPLACE_ELEMENT | 5 | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 |
| REPLACE_ACTION | 6 | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 |
| REPLACE_URI | 7 | 当前Want中的uri属性可被WantAgent.trigger()中Want的uri属性取代 |
| REPLACE_ENTITIES | 8 | 当前Want中的entities属性可被WantAgent.trigger()中Want的entities属性取代 |
| REPLACE_BUNDLE | 9 | 当前Want中的bundleName属性可被WantAgent.trigger()中Want的bundleName属性取代 |
## OperationType
......@@ -1090,19 +1084,17 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => {
| 名称 | 值 | 说明 |
| ----------------- | ------------- | ------------------------- |
| UNKNOWN_TYPE | OperationType | 不识别的类型。 |
| START_ABILITY | OperationType | 开启一个有页面的Ability。 |
| START_ABILITIES | OperationType | 开启多个有页面的Ability。 |
| START_SERVICE | OperationType | 开启一个无页面的ability。 |
| SEND_COMMON_EVENT | OperationType | 发送一个公共事件。 |
| UNKNOWN_TYPE | 0 | 不识别的类型。 |
| START_ABILITY | 1 | 开启一个有页面的Ability。 |
| START_ABILITIES | 2 | 开启多个有页面的Ability。 |
| START_SERVICE | 3 | 开启一个无页面的ability。 |
| SEND_COMMON_EVENT | 4 | 发送一个公共事件。 |
## CompleteData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------------- | --- | ---- | ------------------------------ | ---- | ---------------------- |
| info | 是 | 是 | WantAgent | 是 | 触发的wantAgent。 |
| want | 是 | 是 | Want | 是 | 存在的被触发的want。 |
......@@ -1110,13 +1102,11 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => {
| finalData | 是 | 是 | string | 否 | 公共事件收集的最终数据。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
## TriggerInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | -------------------- | ---- | ----------- |
| code | 是 | 是 | number | 是 | result code。 |
| want | 是 | 是 | Want | 否 | Want。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或