Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 40e767be 编写于 作者: Y yfwang6
浏览文件
操作

wangyongfei6@huawei.com 

modify appstorage get method description
Signed-off-by: Nyfwang6 <wangyongfei6@huawei.com>
上级 b50e3c24
隐藏空白更改
内联 并排
Showing with 282 addition and 348 deletion
zh-cn/application-dev/ability/fa-serviceability.md
浏览文件 @ 40e767be
...@@ -3,17 +3,21 @@ ...@@ -3,17 +3,21 @@
## 场景介绍 ## 场景介绍
基于Service模板的Ability（以下简称“Service”）主要用于后台运行任务（如执行音乐播放、文件下载等），但不提供用户交互界面。Service可由其他应用或Ability启动。即使用户切换到其他应用，Service仍将在后台继续运行。 基于Service模板的Ability（以下简称“Service”）主要用于后台运行任务（如执行音乐播放、文件下载等），但不提供用户交互界面。Service可由其他应用或Ability启动。即使用户切换到其他应用，Service仍将在后台继续运行。
## 接口说明 ## 生命周期
**表1** Service中相关生命周期API功能介绍 **表1** Service中相关生命周期API功能介绍
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|onStart?(): void|该方法在创建Service的时候调用，用于Service的初始化。在Service的整个生命周期只会调用一次，调用时传入的Want应为空。| |onStart?(): void|该方法在创建Service的时候调用，用于Service的初始化，在Service的整个生命周期只会调用一次。|
|onCommand?(want: Want, startId: number): void|在Service创建完成之后调用，该方法在客户端每次启动该Service时都会调用，开发者可以在该方法中做一些调用统计、初始化类的操作。| |onCommand?(want: Want, startId: number): void|在Service创建完成之后调用，该方法在客户端每次启动该Service时都会调用，开发者可以在该方法中做一些调用统计、初始化类的操作。|
|onConnect?(want: Want): rpc.RemoteObject|在Ability和Service连接时调用。| |onConnect?(want: Want): rpc.RemoteObject|在Ability和Service连接时调用。|
|onDisconnect?(want: Want): void|在Ability与绑定的Service断开连接时调用。| |onDisconnect?(want: Want): void|在Ability与绑定的Service断开连接时调用。|
|onStop?(): void|在Service销毁时调用。开发者应通过实现此方法来清理资源，如关闭线程、注册的侦听器等。| |onStop?(): void|在Service销毁时调用。开发者应通过实现此方法来清理资源，如关闭线程、注册的侦听器等。|
onCommand()与onConnect()的区别在于：
- onCommand()只能被startAbility或startAbilityForResult触发，客户端每次启动Service均会触发该回调
- onConnect()只能被connectAbility触发，客户端每次与Servcie建立新的连接时会触发该回调
## 开发步骤 ## 开发步骤
### 创建注册Service ### 创建注册Service
...@@ -22,45 +26,46 @@ ...@@ -22,45 +26,46 @@
创建Service的代码示例如下： 创建Service的代码示例如下：
```javascript ```ts
export default { export default {
onStart() { onStart() {
console.log('ServiceAbility onStart'); console.log('ServiceAbility onStart');
}, },
onCommand(want, startId) { onCommand(want, startId) {
console.log('ServiceAbility onCommand'); console.log('ServiceAbility onCommand');
}, },
onConnect(want) { onConnect(want) {
console.log('ServiceAbility OnConnect'); console.log('ServiceAbility OnConnect');
return new FirstServiceAbilityStub('test'); // ServiceAbilityStub的实现在下文给出
}, return new ServiceAbilityStub('test');
onDisconnect(want) { },
console.log('ServiceAbility OnDisConnect'); onDisconnect(want) {
}, console.log('ServiceAbility OnDisConnect');
onStop() { },
console.log('ServiceAbility onStop'); onStop() {
}, console.log('ServiceAbility onStop');
} }
}
``` ```
2. 注册Service。 2. 注册Service。
Service需要在应用配置文件config.json中进行注册，注册类型type需要设置为service。 Service需要在应用配置文件config.json中进行注册，注册类型type需要设置为service。
```javascript ```json
{ {
"module": { "module": {
"abilities": [ "abilities": [
{ {
"name": ".ServiceAbility", "name": ".ServiceAbility",
"type": "service", "type": "service",
"visible": true "visible": true
...
}
]
... ...
} }
]
... ...
}
...
} }
``` ```
...@@ -72,50 +77,61 @@ Ability为开发者提供了startAbility()方法来启动另外一个Ability。 ...@@ -72,50 +77,61 @@ Ability为开发者提供了startAbility()方法来启动另外一个Ability。
开发者可以通过构造包含bundleName与abilityName的Want对象来设置目标Service信息。参数的含义如下： 开发者可以通过构造包含bundleName与abilityName的Want对象来设置目标Service信息。参数的含义如下：
- bundleName：表示包名称。 - bundleName：表示对端应用的包名称。
- abilityName：表示待启动的Ability名称。 - abilityName：表示待启动的Ability名称。
启动本地设备Service的代码示例如下： 启动本地设备Service的代码示例如下：
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility'
let promise = featureAbility.startAbility(
featureAbility.startAbility(
{ {
want: want:
{ {
bundleName: "com.jstest.service", bundleName: "com.jstest.service",
abilityName: "com.jstest.service.ServiceAbility", abilityName: "com.jstest.service.ServiceAbility"
}, }
} }
); ).then((err) => {
console.log("startService success");
}).catch (err => {
console.log("startService FAILED");
});
``` ```
执行上述代码后，Ability将通过startAbility() 方法来启动Service。 执行上述代码后，Ability将通过startAbility() 方法来启动Service。
- 如果Service尚未运行，则系统会先调用onStart()来初始化Service，再回调Service的onCommand()方法来启动Service。 - 如果Service尚未运行，则系统会先初始化Service，然后回调onStart()来启动Service，再回调onCommand()方法。
- 如果Service正在运行，则系统会直接回调Service的onCommand()方法来启动Service。 - 如果Service正在运行，则系统会直接回调Service的onCommand()方法。
启动远端设备Service的代码示例如下，详见[连接远程Service](fa-serviceability.md#连接远程service当前仅对系统应用开放)：
启动远端设备Service的代码示例如下，getRemoteDeviceId()方法详见[连接远程Service](#连接远程service当前仅对系统应用开放)： ```ts
import featureAbility from '@ohos.ability.featureAbility'
```javascript featureAbility.startAbility(
import featureAbility from '@ohos.ability.featureAbility';
let promise = featureAbility.startAbility(
{ {
want: want:
{ {
deviceId: getRemoteDeviceId(), //远端设备Id deviceId: remoteDeviceId, // 远端设备Id
bundleName: "com.jstest.service", bundleName: "com.jstest.service",
abilityName: "com.jstest.service.ServiceAbility", abilityName: "com.jstest.service.ServiceAbility"
}, }
} }
); ).then((err) => {
console.log("startService success");
}).catch (err => {
console.log("startService FAILED");
});
``` ```
### 停止Service ### 停止Service
Service一旦创建就会一直保持在后台运行，除非必须回收内存资源，否则系统不会停止或销毁Service。 常规情况下，Service可以将自己停止，或者被系统停止，具体场景如下：
- Service调用particleAbility.terminateSelf()方法将自己停止。
- Service所在的应用进程退出，Service将随着进程被回收。
- 若Service仅仅是通过connectAbility()方法被访问的（从未执行过onCommand()回调）,那么当最后一个连接被断开后，系统会将Service停止。
### 连接本地Service ### 连接本地Service
...@@ -128,281 +144,199 @@ let promise = featureAbility.startAbility( ...@@ -128,281 +144,199 @@ let promise = featureAbility.startAbility(
使用OpenHarmony IDL（OpenHarmony Interface Definition Language）来自动生成对应客户端服务端及IRemoteObject代码，具体示例代码和说明请参考： 使用OpenHarmony IDL（OpenHarmony Interface Definition Language）来自动生成对应客户端服务端及IRemoteObject代码，具体示例代码和说明请参考：
- [`OpenHarmony IDL`：TS开发步骤](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/IDL/idl-guidelines.md#ts%E5%BC%80%E5%8F%91%E6%AD%A5%E9%AA%A4) - [`OpenHarmony IDL`：TS开发步骤](../IDL/idl-guidelines.md#ts)
2. 在对应文件编写代码 2. 在对应文件编写代码
在使用connectAbility()处理回调时，需要传入目标Service的Want与IAbilityConnection的实例。IAbilityConnection提供了以下方法供开发者实现：onConnect()是用来处理连接Service成功的回调，onDisconnect()是用来处理Service异常死亡的回调，onFailed()是用来处理连接Service失败的回调。 在使用connectAbility()时，需要传入目标Service的Want与ConnectOptions的实例，其中ConnectOptions封装了三个回调，分别对应不同情况，开发者需自行实现：
- onConnect()：用来处理连接Service成功的回调。
- onDisconnect()：用来处理Service断连或异常死亡的回调。
- onFailed()：用来处理连接Service失败的回调。
创建连接本地Service回调实例的代码示例如下： 创建连接本地Service回调实例的代码示例如下：
```javascript ```ts
import prompt from '@system.prompt' import prompt from '@system.prompt'
var option = { var option = {
onConnect: function onConnectCallback(element, proxy) { onConnect: function onConnectCallback(element, proxy) {
console.log(`onConnectLocalService onConnectDone`) console.log(`onConnectLocalService onConnectDone`);
if (proxy === null) { if (proxy === null) {
prompt.showToast({ prompt.showToast({
message: "Connect service failed" message: "Connect service failed"
}) });
return return;
} }
let data = rpc.MessageParcel.create() // 得到Service的proxy对象后便可以与其进行通信
let reply = rpc.MessageParcel.create() let data = rpc.MessageParcel.create();
let option = new rpc.MessageOption() let reply = rpc.MessageParcel.create();
data.writeInterfaceToken("connect.test.token") let option = new rpc.MessageOption();
proxy.sendRequest(0, data, reply, option) data.writeString("InuptString");
proxy.sendRequest(0, data, reply, option);
prompt.showToast({ prompt.showToast({
message: "Connect service success" message: "Connect service success"
}) });
}, },
onDisconnect: function onDisconnectCallback(element) { onDisconnect: function onDisconnectCallback(element) {
console.log(`onConnectLocalService onDisconnectDone element:${element}`) console.log(`onConnectLocalService onDisconnectDone element:${element}`);
prompt.showToast({ prompt.showToast({
message: "Disconnect service success" message: "Disconnect service success"
}) });
}, },
onFailed: function onFailedCallback(code) { onFailed: function onFailedCallback(code) {
console.log(`onConnectLocalService onFailed errCode:${code}`) console.log(`onConnectLocalService onFailed errCode:${code}`);
prompt.showToast({ prompt.showToast({
message: "Connect local service onFailed" message: "Connect local service onFailed"
}) });
} }
} };
``` ```
连接本地Service的代码示例如下： 连接本地Service的代码示例如下：
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility'
let connectId = featureAbility.connectAbility(
{ let want = {
bundleName: "com.jstest.service", bundleName: "com.jstest.service",
abilityName: "com.jstest.service.ServiceAbility", abilityName: "com.jstest.service.ServiceAbility"
}, };
{ let connectId = featureAbility.connectAbility(want, option);
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
``` ```
同时，Service侧也需要在onConnect()时返回IRemoteObject，从而定义与Service进行通信的接口。onConnect()需要返回一个IRemoteObject对象。OpenHarmony提供了IRemoteObject的默认实现，开发者可以通过继承rpc.RemoteObject来创建自定义的实现类。 同时，Service侧也需要在onConnect()时返回IRemoteObject，从而定义与Service进行通信的接口。onConnect()需要返回一个IRemoteObject对象。OpenHarmony提供了IRemoteObject的默认实现，开发者可以通过继承rpc.RemoteObject来创建自定义的实现类，从而实现与Service的通信。具体使用方法可参考[ohos.rpc API文档](..\reference\apis\js-apis-rpc.md)。
Service侧把自身的实例返回给调用侧的代码示例如下： Service侧把自身的实例返回给调用侧的代码示例如下：
```javascript ```ts
import rpc from "@ohos.rpc"; import rpc from "@ohos.rpc"
class ServiceAbilityStub extends rpc.RemoteObject {
constructor(des: any) {
if (typeof des === 'string') {
super(des);
} else {
console.log("Error, the input param is not string");
return;
}
}
class FirstServiceAbilityStub extends rpc.RemoteObject { onRemoteRequest(code: number, data: any, reply: any, option: any) {
constructor(des: any) { console.log("onRemoteRequest called");
if (typeof des === 'string') { // 可根据code执行不同的业务逻辑
super(des) if (code === 1) {
} else { // 将传入的字符串进行排序
return let string = data.readString();
console.log(`Input string = ${string}`);
let result = Array.from(string).sort().join('');
console.log(`Output result = ${result}`);
reply.writeString(result);
} else {
console.log(`Unknown request code`);
}
return true;
} }
} }
onRemoteRequest(code: number, data: any, reply: any, option: any) { export default {
console.log(printLog + ` onRemoteRequest called`) onStart() {
if (code === 1) { console.log('ServiceAbility onStart');
let string = data.readString() },
console.log(printLog + ` string=${string}`) onCommand(want, startId) {
let result = Array.from(string).sort().join('') console.log('ServiceAbility onCommand');
console.log(printLog + ` result=${result}`) },
reply.writeString(result) onConnect(want) {
} else { console.log('ServiceAbility OnConnect');
console.log(printLog + ` unknown request code`) return new ServiceAbilityStub('ServiceAbilityRemoteObject');
},
onDisconnect(want) {
console.log('ServiceAbility OnDisConnect');
},
onStop() {
console.log('ServiceAbility onStop');
} }
return true;
} }
``` ```
### 连接远程Service（当前仅对系统应用开放） ### 连接远程Service（当前仅对系统应用开放）
>说明：由于DeviceManager的getTrustedDeviceListSync接口仅对系统应用开放，当前连接远程Service仅支持系统应用。 连接远程Service，构造ConnectOptions的方法与连接本地Serivce相同，区别在于：
- 应用需要向用户申请数据同步权限
如果Service需要与Page Ability或其他应用的Service Ability进行跨设备交互，则须创建用于连接的Connection。Service支持其他Ability通过connectAbility()方法与其进行跨设备连接。 - 目标Service的Want需要包含对端设备的deviceId
在使用connectAbility()处理回调时，需要传入目标Service的Want与IAbilityConnection的实例。IAbilityConnection提供了以下方法供开发者实现：onConnect()是用来处理连接Service成功的回调，onDisconnect()是用来处理Service异常死亡的回调，onFailed()是用来处理连接Service失败的回调。 > 说明：
> (1) 由于DeviceManager的getTrustedDeviceList等接口仅对系统应用开放，当前仅系统应用支持连接远程Service。
创建连接远程Service回调实例的代码示例如下： > (2) API定义可见：[deviceManager模块](..\reference\apis\js-apis-device-manager.md)
> (3) 参考Demo可见：[分布式Demo](https://gitee.com/openharmony/applications_app_samples/tree/master/ability/DMS)
```ts
import prompt from '@system.prompt' 在跨设备场景下，需要向用户申请数据同步的权限，首先在config.json里配置权限：
var option = { ```json
onConnect: function onConnectCallback(element, proxy) { {
console.log(`onConnectRemoteService onConnectDone`) ...
if (proxy === null) { "module": {
prompt.showToast({ ...
message: "Connect service failed" "reqPermissions": [{
}) "name": "ohos.permission.DISTRIBUTED_DATASYNC"
return }]
} }
let data = rpc.MessageParcel.create()
let reply = rpc.MessageParcel.create()
let option = new rpc.MessageOption()
data.writeInterfaceToken("connect.test.token")
proxy.sendRequest(0, data, reply, option)
prompt.showToast({
message: "Connect service success"
})
},
onDisconnect: function onDisconnectCallback(element) {
console.log(`onConnectRemoteService onDisconnectDone element:${element}`)
prompt.showToast({
message: "Disconnect service success"
})
},
onFailed: function onFailedCallback(code) {
console.log(`onConnectRemoteService onFailed errCode:${code}`)
prompt.showToast({
message: "Connect local service onFailed"
})
}
} }
``` ```
目标Service的Want需要包含远程deviceId，该远程deviceId可通过deviceManager获取,具体示例代码如下： DISTRIBUTED_DATASYNC权限需要用户授予，在应用启动时需要向用户弹框请求授予权限，示例代码如下：
```ts ```ts
import deviceManager from '@ohos.distributedHardware.deviceManager'; import abilityAccessCtrl from "@ohos.abilityAccessCtrl"
import bundle from '@ohos.bundle'
//dmClass具体实现请参考：相关实例 分布式Demo 章节中的实现 async function RequestPermission() {
let dmClass; console.info('RequestPermission begin');
let array: Array<string> = ["ohos.permission.DISTRIBUTED_DATASYNC"];
function getRemoteDeviceId() { let bundleFlag = 0;
if (typeof dmClass === 'object' && dmClass != null) { let tokenID = undefined;
let list = dmClass.getTrustedDeviceListSync(); let userID = 100;
if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') { let appInfo = await bundle.getApplicationInfo('ohos.samples.etsDemo', bundleFlag, userID);
console.log("MainAbility onButtonClick getRemoteDeviceId err: list is null"); tokenID = appInfo.accessTokenId;
return; let atManager = abilityAccessCtrl.createAtManager();
let requestPermissions: Array<string> = [];
for (let i = 0;i < array.length; i++) {
let result = await atManager.verifyAccessToken(tokenID, array[i]);
console.info("verifyAccessToken result:" + JSON.stringify(result));
if (result != abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
requestPermissions.push(array[i]);
} }
console.log("MainAbility onButtonClick getRemoteDeviceId success:" + list[0].deviceId);
return list[0].deviceId;
} else {
console.log("MainAbility onButtonClick getRemoteDeviceId err: dmClass is null");
} }
} console.info("requestPermissions:" + JSON.stringify(requestPermissions));
``` if (requestPermissions.length == 0 || requestPermissions == []) {
return;
连接远程Service的代码示例如下：
```ts
import featureAbility from '@ohos.ability.featureAbility';
let connectId = featureAbility.connectAbility(
{
deviceId: getRemoteDeviceId(),
bundleName: "ohos.samples.etsDemo",
abilityName: "ohos.samples.etsDemo.ServiceAbility",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
```
在跨设备场景下，需要向用户申请数据同步的权限。具体示例代码如下：
```ts
import abilityAccessCtrl from "@ohos.abilityAccessCtrl";
import bundle from '@ohos.bundle';
async function RequestPermission() {
console.info('RequestPermission begin');
let array: Array<string> = ["ohos.permission.DISTRIBUTED_DATASYNC"];
let bundleFlag = 0;
let tokenID = undefined;
let userID = 100;
let appInfo = await bundle.getApplicationInfo('ohos.samples.etsDemo', bundleFlag, userID);
tokenID = appInfo.accessTokenId;
let atManager = abilityAccessCtrl.createAtManager();
let requestPermissions: Array<string> = [];
for (let i = 0;i < array.length; i++) {
let result = await atManager.verifyAccessToken(tokenID, array[i]);
console.info("verifyAccessToken result:" + JSON.stringify(result));
if (result == abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
} else {
requestPermissions.push(array[i]);
} }
} let context = featureAbility.getContext();
console.info("requestPermissions:" + JSON.stringify(requestPermissions)); context.requestPermissionsFromUser(requestPermissions, 1, (data)=>{
if (requestPermissions.length == 0 || requestPermissions == []) { console.info("data:" + JSON.stringify(data));
return; });
} console.info('RequestPermission end');
let context = featureAbility.getContext();
context.requestPermissionsFromUser(requestPermissions, 1, (data)=>{
console.info("data:" + JSON.stringify(data));
});
console.info('RequestPermission end');
} }
``` ```
同时，Service侧也需要在onConnect()时返回IRemoteObject，从而定义与Service进行通信的接口。onConnect()需要返回一个IRemoteObject对象。OpenHarmony提供了IRemoteObject的默认实现，开发者可以通过继承rpc.RemoteObject来创建自定义的实现类。 获取deviceId需要导入`@ohos.distributedHardware.deviceManager`模块，其中提供了getTrustedDeviceList等接口用于获取远端设备的deviceId。
- 接口使用可参考[deviceManager模块](..\reference\apis\js-apis-device-manager.md)
- 具体实现可参考[分布式Demo](https://gitee.com/openharmony/applications_app_samples/tree/master/ability/DMS)
Service侧把自身的实例返回给调用侧的代码示例如下： 连接远程Service，只需要在want内定义deviceId即可，示例代码如下：
```ts ```ts
import rpc from "@ohos.rpc"; import featureAbility from '@ohos.ability.featureAbility'
class FirstServiceAbilityStub extends rpc.RemoteObject {
constructor(des: any) {
if (typeof des === 'string') {
super(des)
} else {
return
}
}
onRemoteRequest(code: number, data: any, reply: any, option: any) {
console.log(printLog + ` onRemoteRequest called`)
if (code === 1) {
let string = data.readString()
console.log(printLog + ` string=${string}`)
let result = Array.from(string).sort().join('')
console.log(printLog + ` result=${result}`)
reply.writeString(result)
} else {
console.log(printLog + ` unknown request code`)
}
return true;
}
}
export default { let want = {
onStart() { deviceId: remoteDeviceId,
console.info('ServiceAbility onStart'); bundleName: "com.jstest.service",
}, abilityName: "com.jstest.service.ServiceAbility"
onStop() {
console.info('ServiceAbility onStop');
},
onConnect(want) {
console.log("ServiceAbility onConnect");
try {
let value = JSON.stringify(want);
console.log("ServiceAbility want:" + value);
} catch(error) {
console.log("ServiceAbility error:" + error);
}
return new FirstServiceAbilityStub("first ts service stub");
},
onDisconnect(want) {
console.log("ServiceAbility onDisconnect");
let value = JSON.stringify(want);
console.log("ServiceAbility want:" + value);
},
onCommand(want, startId) {
console.info('ServiceAbility onCommand');
let value = JSON.stringify(want);
console.log("ServiceAbility want:" + value);
console.log("ServiceAbility startId:" + startId);
}
}; };
let connectId = featureAbility.connectAbility(want, option);
``` ```
其余实现均与本地连接Service相同，参考[连接本地Service](fa-serviceability.md#连接本地service)的示例代码即可。
## 相关实例 ## 相关实例
针对ServiceAbility开发，有以下相关实例可供参考： 针对ServiceAbility开发，有以下相关实例可供参考：
......
zh-cn/application-dev/media/avsession-guidelines.md
浏览文件 @ 40e767be
...@@ -361,7 +361,7 @@ currentSession.deactivate().then(() => { ...@@ -361,7 +361,7 @@ currentSession.deactivate().then(() => {
| sendControlCommand(command: AVControlCommand, callback: AsyncCallback\<void>): void | 发送控制命令 | | sendControlCommand(command: AVControlCommand, callback: AsyncCallback\<void>): void | 发送控制命令 |
| sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback\<void>): void | 发送系统按键命令 | | sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback\<void>): void | 发送系统按键命令 |
| sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback\<void>): void | 发送系统控制命令 | | sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback\<void>): void | 发送系统控制命令 |
| castAudio(session: SessionToken | 'all', audioDevices: Array\<audio.AudioDeviceDescriptor>, callback: AsyncCallback\<void>): void | 远端投播 | | castAudio(session: SessionToken \| 'all', audioDevices: Array\<audio.AudioDeviceDescriptor>, callback: AsyncCallback\<void>): void | 远端投播 |
### 开发步骤 ### 开发步骤
1.导入模块接口 1.导入模块接口
......
zh-cn/application-dev/quick-start/arkts-rendering-control.md
浏览文件 @ 40e767be
...@@ -34,7 +34,7 @@ Column() { ...@@ -34,7 +34,7 @@ Column() {
通过循环渲染（ForEach）从数组中获取数据，并为每个数据项创建相应的组件，可减少代码复杂度。 通过循环渲染（ForEach）从数组中获取数据，并为每个数据项创建相应的组件，可减少代码复杂度。
``` ```ts
ForEach( ForEach(
arr: any[], arr: any[],
itemGenerator: (item: any, index?: number) => void, itemGenerator: (item: any, index?: number) => void,
......
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @ 40e767be
...@@ -17,7 +17,7 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓 ...@@ -17,7 +17,7 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) |
| config | Configuration | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) | | config | Configuration | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) |
| extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。<br>(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) | | extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。<br>(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) |
## 使用场景 ## 使用场景
ExtensionContext主要用于查询所属Extension的信息、Module的配置信息以及Hap包的信息，开发者可根据自身业务需求使用对应的信息。此处以ServiceExtension为例，展示ExtensionContext的一种使用场景。 ExtensionContext主要用于查询所属Extension的信息、Module的配置信息以及Hap包的信息，开发者可根据自身业务需求使用对应的信息。此处以ServiceExtension为例，展示ExtensionContext的一种使用场景。
......
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @ 40e767be
...@@ -43,7 +43,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater ...@@ -43,7 +43,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -83,7 +83,7 @@ getRestorer(): Restorer ...@@ -83,7 +83,7 @@ getRestorer(): Restorer
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -115,7 +115,7 @@ getLocalUpdater(): LocalUpdater ...@@ -115,7 +115,7 @@ getLocalUpdater(): LocalUpdater
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -151,7 +151,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void ...@@ -151,7 +151,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -183,7 +183,7 @@ checkNewVersion(): Promise\<CheckResult> ...@@ -183,7 +183,7 @@ checkNewVersion(): Promise\<CheckResult>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -219,7 +219,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void ...@@ -219,7 +219,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -252,7 +252,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo> ...@@ -252,7 +252,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -283,13 +283,13 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption ...@@ -283,13 +283,13 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
| ------------------ | ---------------------------------------- | ---- | -------------- | | ------------------ | ---------------------------------------- | ---- | -------------- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | | descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | 是 | 回调函数，返回新版本描述文件。 | | callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>> | 是 | 回调函数，返回新版本描述文件。 |
**错误码**： **错误码**：
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -340,7 +340,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption ...@@ -340,7 +340,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -385,7 +385,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void ...@@ -385,7 +385,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -419,7 +419,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo> ...@@ -419,7 +419,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -450,13 +450,13 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A ...@@ -450,13 +450,13 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ---------------------------------------- | ---- | --------------- | | ------------------ | ---------------------------------------- | ---- | --------------- |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | | descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | 是 | 回调函数，返回当前版本描述文件。 | | callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>> | 是 | 回调函数，返回当前版本描述文件。 |
**错误码**： **错误码**：
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -501,7 +501,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A ...@@ -501,7 +501,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -541,7 +541,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void ...@@ -541,7 +541,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -573,7 +573,7 @@ getTaskInfo(): Promise\<TaskInfo> ...@@ -573,7 +573,7 @@ getTaskInfo(): Promise\<TaskInfo>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -609,7 +609,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, ...@@ -609,7 +609,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions,
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -658,7 +658,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions) ...@@ -658,7 +658,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions)
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -704,7 +704,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu ...@@ -704,7 +704,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -752,7 +752,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu ...@@ -752,7 +752,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -797,7 +797,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD ...@@ -797,7 +797,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -845,7 +845,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD ...@@ -845,7 +845,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -890,7 +890,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca ...@@ -890,7 +890,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -938,7 +938,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P ...@@ -938,7 +938,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -983,7 +983,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal ...@@ -983,7 +983,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1031,7 +1031,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr ...@@ -1031,7 +1031,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1074,7 +1074,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void ...@@ -1074,7 +1074,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1107,7 +1107,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy> ...@@ -1107,7 +1107,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1143,7 +1143,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void ...@@ -1143,7 +1143,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1186,7 +1186,7 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void> ...@@ -1186,7 +1186,7 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1225,7 +1225,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void ...@@ -1225,7 +1225,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1257,7 +1257,7 @@ terminateUpgrade(): Promise\<void> ...@@ -1257,7 +1257,7 @@ terminateUpgrade(): Promise\<void>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1290,7 +1290,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi ...@@ -1290,7 +1290,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1325,7 +1325,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v ...@@ -1325,7 +1325,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1364,7 +1364,7 @@ factoryReset(callback: AsyncCallback\<void>): void ...@@ -1364,7 +1364,7 @@ factoryReset(callback: AsyncCallback\<void>): void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1396,7 +1396,7 @@ factoryReset(): Promise\<void> ...@@ -1396,7 +1396,7 @@ factoryReset(): Promise\<void>
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1434,7 +1434,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn ...@@ -1434,7 +1434,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1478,7 +1478,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void ...@@ -1478,7 +1478,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1516,7 +1516,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn ...@@ -1516,7 +1516,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1553,7 +1553,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void ...@@ -1553,7 +1553,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1589,7 +1589,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi ...@@ -1589,7 +1589,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1620,13 +1620,13 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v ...@@ -1620,13 +1620,13 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------------- | ---- | ---- | | ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | | eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 |
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | | taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 否 | 事件回调。 |
**错误码**： **错误码**：
以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | ---------------------------------------------------- | | ------- | ---------------------------------------------------- |
| 11500104 | BusinessError 11500104: IPC error. | | 11500104 | BusinessError 11500104: IPC error. |
...@@ -1651,7 +1651,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1651,7 +1651,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------ | | ------------ | ----------------------------- | ---- | ------ |
| upgradeApp | string | 是 | 调用方包名。 | | upgradeApp | string | 是 | 调用方包名。 |
| businessType | [BusinessType](#businesstype) | 是 | 升级业务类型。 | | businessType | [BusinessType](#businesstype) | 是 | 升级业务类型。 |
...@@ -1662,7 +1662,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1662,7 +1662,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------- | ---- | ---- | | ------- | ----------------------------------- | ---- | ---- |
| vendor | [BusinessVendor](#businessvendor) | 是 | 供应商。 | | vendor | [BusinessVendor](#businessvendor) | 是 | 供应商。 |
| subType | [BusinessSubType](#businesssubtype) | 是 | 类型。 | | subType | [BusinessSubType](#businesssubtype) | 是 | 类型。 |
...@@ -1673,7 +1673,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1673,7 +1673,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | --------------------------------- | ---- | ------ | | ----------------- | --------------------------------- | ---- | ------ |
| isExistNewVersion | bool | 是 | 是否有新版本。 | | isExistNewVersion | bool | 是 | 是否有新版本。 |
| newVersionInfo | [NewVersionInfo](#newversioninfo) | 否 | 新版本数据。 | | newVersionInfo | [NewVersionInfo](#newversioninfo) | 否 | 新版本数据。 |
...@@ -1684,7 +1684,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1684,7 +1684,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------------- | ---- | ---- | | ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 |
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 是 | 版本组件。 | | versionComponents | Array\<[VersionComponent](#versioncomponent)> | 是 | 版本组件。 |
...@@ -1695,7 +1695,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1695,7 +1695,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------- | ------ | ---- | ---- | | ------------- | ------ | ---- | ---- |
| versionDigest | string | 是 | 版本摘要。 | | versionDigest | string | 是 | 版本摘要。 |
...@@ -1705,7 +1705,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1705,7 +1705,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------- | ----------------------------------- | ---- | -------- | | --------------- | ----------------------------------- | ---- | -------- |
| componentId | string | 是 | 组件标识。 | | componentId | string | 是 | 组件标识。 |
| componentType | [ComponentType](#componenttype) | 是 | 组件类型。 | | componentType | [ComponentType](#componenttype) | 是 | 组件类型。 |
...@@ -1722,7 +1722,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1722,7 +1722,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------ | | -------- | --------------------------------------- | ---- | ------ |
| format | [DescriptionFormat](#descriptionformat) | 是 | 描述文件格式。 | | format | [DescriptionFormat](#descriptionformat) | 是 | 描述文件格式。 |
| language | string | 是 | 描述文件语言。 | | language | string | 是 | 描述文件语言。 |
...@@ -1733,7 +1733,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1733,7 +1733,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------- | ----------------------------------- | ---- | ------ | | --------------- | ----------------------------------- | ---- | ------ |
| componentId | string | 是 | 组件标识。 | | componentId | string | 是 | 组件标识。 |
| descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 描述文件信息。 | | descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 描述文件信息。 |
...@@ -1744,7 +1744,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1744,7 +1744,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------- | ----------------------------------- | ---- | ------ | | --------------- | ----------------------------------- | ---- | ------ |
| descriptionType | [DescriptionType](#descriptiontype) | 是 | 描述文件类型。 | | descriptionType | [DescriptionType](#descriptiontype) | 是 | 描述文件类型。 |
| content | string | 是 | 描述文件内容。 | | content | string | 是 | 描述文件内容。 |
...@@ -1755,7 +1755,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1755,7 +1755,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------------- | ---- | ----- | | ----------------- | ---------------------------------------- | ---- | ----- |
| osVersion | string | 是 | 系统版本号。 | | osVersion | string | 是 | 系统版本号。 |
| deviceName | string | 是 | 设备名。 | | deviceName | string | 是 | 设备名。 |
...@@ -1767,7 +1767,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1767,7 +1767,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- | ---- | | ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | 是 | 网络类型。 | | allowNetwork | [NetType](#nettype) | 是 | 网络类型。 |
| order | [Order](#order) | 是 | 升级指令。 | | order | [Order](#order) | 是 | 升级指令。 |
...@@ -1778,7 +1778,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1778,7 +1778,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- | ---- | | ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | 是 | 网络类型。 | | allowNetwork | [NetType](#nettype) | 是 | 网络类型。 |
...@@ -1788,7 +1788,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1788,7 +1788,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | ---- | ---- | -------- | | ----------------- | ---- | ---- | -------- |
| isAllowAutoResume | bool | 是 | 是否允许自动恢复。 | | isAllowAutoResume | bool | 是 | 是否允许自动恢复。 |
...@@ -1798,7 +1798,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1798,7 +1798,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | --------------- | ---- | ---- | | ----- | --------------- | ---- | ---- |
| order | [Order](#order) | 是 | 升级指令。 | | order | [Order](#order) | 是 | 升级指令。 |
...@@ -1808,7 +1808,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1808,7 +1808,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | ---- | | ------ | ------------------------------- | ---- | ---- |
| status | [UpgradeStatus](#upgradestatus) | 是 | 异常状态。 | | status | [UpgradeStatus](#upgradestatus) | 是 | 异常状态。 |
...@@ -1818,7 +1818,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1818,7 +1818,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------------- | --------------------------------------- | ---- | ------- | | ------------------- | --------------------------------------- | ---- | ------- |
| downloadStrategy | bool | 是 | 自动下载策略。 | | downloadStrategy | bool | 是 | 自动下载策略。 |
| autoUpgradeStrategy | bool | 是 | 自动升级策略。 | | autoUpgradeStrategy | bool | 是 | 自动升级策略。 |
...@@ -1830,7 +1830,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1830,7 +1830,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ---- | | ----- | ------ | ---- | ---- |
| start | number | 是 | 开始时间。 | | start | number | 是 | 开始时间。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间。 |
...@@ -1841,7 +1841,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1841,7 +1841,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | --------------------- | ---- | ------ | | --------- | --------------------- | ---- | ------ |
| existTask | bool | 是 | 是否存在任务。 | | existTask | bool | 是 | 是否存在任务。 |
| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 | | taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 |
...@@ -1852,7 +1852,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1852,7 +1852,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---- | | -------- | --------------------- | ---- | ---- |
| eventId | [EventId](#eventid) | 是 | 事件ID。 | | eventId | [EventId](#eventid) | 是 | 事件ID。 |
| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 | | taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 |
...@@ -1863,7 +1863,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1863,7 +1863,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------------- | ---- | ---- | | ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 |
| status | [UpgradeStatus](#upgradestatus) | 是 | 升级状态。 | | status | [UpgradeStatus](#upgradestatus) | 是 | 升级状态。 |
...@@ -1879,7 +1879,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1879,7 +1879,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ------ | ---- | ---- | | ------------ | ------ | ---- | ---- |
| errorCode | number | 是 | 错误码。 | | errorCode | number | 是 | 错误码。 |
| errorMessage | string | 是 | 错误描述。 | | errorMessage | string | 是 | 错误描述。 |
...@@ -1890,7 +1890,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1890,7 +1890,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ---- | | ------------- | ------------------------------- | ---- | ---- |
| eventClassify | [EventClassify](#eventclassify) | 是 | 事件类型。 | | eventClassify | [EventClassify](#eventclassify) | 是 | 事件类型。 |
| extraInfo | string | 是 | 额外信息。 | | extraInfo | string | 是 | 额外信息。 |
...@@ -1901,7 +1901,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1901,7 +1901,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---- | | -------- | ------------------------------- | ---- | ---- |
| fileType | [ComponentType](#componenttype) | 是 | 文件类型。 | | fileType | [ComponentType](#componenttype) | 是 | 文件类型。 |
| filePath | string | 是 | 文件路径。 | | filePath | string | 是 | 文件路径。 |
...@@ -1914,7 +1914,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1914,7 +1914,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ---- | | --------- | ----------------------- | ---- | ---- |
| eventInfo | [EventInfo](#eventinfo) | 是 | 事件信息。 | | eventInfo | [EventInfo](#eventinfo) | 是 | 事件信息。 |
...@@ -1924,7 +1924,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1924,7 +1924,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ------ | -------- | ---- | | ------ | -------- | ---- |
| PUBLIC | "public" | 开源。 | | PUBLIC | "public" | 开源。 |
...@@ -1934,7 +1934,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1934,7 +1934,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | ---- | ---- | | -------- | ---- | ---- |
| FIRMWARE | 1 | 固件。 | | FIRMWARE | 1 | 固件。 |
...@@ -1944,7 +1944,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1944,7 +1944,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ---- | ---- | ---- | | ---- | ---- | ---- |
| OTA | 1 | 固件。 | | OTA | 1 | 固件。 |
...@@ -1954,7 +1954,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1954,7 +1954,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | ---------- | ---- | | -------- | ---------- | ---- |
| UPGRADE | "upgrade" | 差分包。 | | UPGRADE | "upgrade" | 差分包。 |
| RECOVERY | "recovery" | 修复包。 | | RECOVERY | "recovery" | 修复包。 |
...@@ -1965,7 +1965,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1965,7 +1965,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | ---- | ---- | | ------------- | ---- | ---- |
| COLD | 1 | 冷升级。 | | COLD | 1 | 冷升级。 |
| LIVE | 2 | 热升级。 | | LIVE | 2 | 热升级。 |
...@@ -1977,7 +1977,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1977,7 +1977,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ------- | ---- | ---- | | ------- | ---- | ---- |
| CONTENT | 0 | 内容。 | | CONTENT | 0 | 内容。 |
| URI | 1 | 链接。 | | URI | 1 | 链接。 |
...@@ -1988,7 +1988,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1988,7 +1988,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ---------- | ---- | ---- | | ---------- | ---- | ---- |
| STANDARD | 0 | 标准格式。 | | STANDARD | 0 | 标准格式。 |
| SIMPLIFIED | 1 | 简易格式。 | | SIMPLIFIED | 1 | 简易格式。 |
...@@ -1999,7 +1999,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -1999,7 +1999,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ----------------- | ---- | --------- | | ----------------- | ---- | --------- |
| CELLULAR | 1 | 数据网络。 | | CELLULAR | 1 | 数据网络。 |
| METERED_WIFI | 2 | 热点WIFI。 | | METERED_WIFI | 2 | 热点WIFI。 |
...@@ -2013,7 +2013,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -2013,7 +2013,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------------------- | ---- | ----- | | -------------------- | ---- | ----- |
| DOWNLOAD | 1 | 下载。 | | DOWNLOAD | 1 | 下载。 |
| INSTALL | 2 | 安装。 | | INSTALL | 2 | 安装。 |
...@@ -2027,7 +2027,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -2027,7 +2027,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ---------------- | ---- | ---- | | ---------------- | ---- | ---- |
| WAITING_DOWNLOAD | 20 | 待下载。 | | WAITING_DOWNLOAD | 20 | 待下载。 |
| DOWNLOADING | 21 | 下载中。 | | DOWNLOADING | 21 | 下载中。 |
...@@ -2046,7 +2046,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -2046,7 +2046,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ---- | ---------- | ---- | | ---- | ---------- | ---- |
| TASK | 0x01000000 | 任务事件。 | | TASK | 0x01000000 | 任务事件。 |
...@@ -2056,7 +2056,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); ...@@ -2056,7 +2056,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**：SystemCapability.Update.UpdateService **系统能力**：SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| ---------------------- | ---------- | ------ | | ---------------------- | ---------- | ------ |
| EVENT_TASK_BASE | 0x01000000 | 任务事件。 | | EVENT_TASK_BASE | 0x01000000 | 任务事件。 |
| EVENT_TASK_RECEIVE | 0x01000001 | 收到任务。 | | EVENT_TASK_RECEIVE | 0x01000001 | 收到任务。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-state-management.md
浏览文件 @ 40e767be
...@@ -136,7 +136,7 @@ Get\<T>(propName: string): T | undefined ...@@ -136,7 +136,7 @@ Get\<T>(propName: string): T | undefined
| 类型 | 描述 | | 类型 | 描述 |
| ----------------- | ------------- | | ----------------- | ------------- |
| boolean或undefined | 返回属性的属性值是否存在。 | | T或undefined | 属性存在返回属性值，属性不存在返回undefined。 |
```ts ```ts
let simple = AppStorage.Get('simpleProp') let simple = AppStorage.Get('simpleProp')
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或