提交 1bf08abf 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 65ab37ba
# Bundle模块(JS端SDK接口)
#### 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| Bundle.getApplicationInfo(bundleName: string, bundleFlags: number, userId: number) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback<ApplicationInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllBundleInfo(bundlelFlag: BundleFlag) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllBundleInfo(bundlelFlag: BundleFlag, callback: AsyncCallback<Array<BundleInfo>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleInfo(bundleName: string, bundleFlags: number) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllApplicationInfo(bundleFlags: number, userId: number) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array<ApplicationInfo>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.queryAbilityByWant(want: Want, bundleFlags: number, userId: number) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: AsyncCallback<Array<AbilityInfo>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getPermissionDef(permissionName: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getPermissionDef(permissionName: string, callback: AsyncCallback<permission.PermissionDef>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleArchiveInfo(hapFilePath: string, flags: number) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleArchiveInfo(hapFilePath: string, flags: number, callback: AsyncCallback<BundleInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleInstaller().install(bundleFilePaths: Array<string>, param: InstallParam, callback: AsyncCallback<InstallStatus>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getBundleInstaller().uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllShortcutInfo(bundleName: string): Promise<Array<ShortcutInfo>> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Bundle.getAllShortcutInfo(bundleName: string, callback: AsyncCallback<Array<ShortcutInfo>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| getModuleUsageRecords(maxNum: number): Promise<Array<ModuleUsageRecord>> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| getModuleUsageRecords(maxNum: number, callback: AsyncCallback<Array<ModuleUsageRecord>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| checkPermission(bundleName: string, permission: string): Promise<GrantStatus> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| checkPermission(bundleName: string, permission: string, callback: AsyncCallback<GrantStatus>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 权限列表
-
#### 导入模块
## 导入模块
```
import bundle from '@ohos.bundle';
```
## 权限列表
#### getApplicationInfo(bundleName: string, bundleFlags: number, userId: number)
* 功能说明
## bundle.getApplicationInfo
根据给定的bundle名称获取ApplicationInfo
* getApplicationInfo参数描述
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number): Promise\<ApplicationInfo>
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------- |
| bundleName | 只读 | string | 是 | 应用名 |
| bundleFlags | 只读 | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | 只读 | number | 是 | 用户ID |
* 返回值
根据给定的bundle名称获取ApplicationInfo,通过Promise获取返回值。
Promise<ApplicationInfo>:返回值为Promise对象,Promise中包含应用信息。
**参数:**
* 示例
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------- |
| bundleName | string | 是 | 应用名 |
| bundleFlags | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | number | 是 | 用户ID |
**返回值:**
| 类型 | 说明 |
| ----------- | -------- |
| Promise\<ApplicationInfo> | 返回值为Promise对象,Promise中包含应用信息。 |
**示例:**
```
bundle.getApplicationInfo('com.example.myapplicationInstall', 8, 0).then((data) => {
console.info("name: for begin");
console.info("name:" + data.name);
console.info("bundleName:" + data.bundleName);
console.info("description:" + data.description);
console.info("descriptionId:" + data.descriptionId);
console.info("iconPath:" + data.iconPath);
console.info("iconId:" + data.iconId);
console.info("label:" + data.label);
console.info("labelId:" + data.labelId);
console.info("deviceId:" + data.deviceId);
console.info("signatureKey:" + data.signatureKey);
console.info("process:" + data.process);
console.info("isSystemApp:" + data.isSystemApp);
console.info("isLauncherApp:" + data.isLauncherApp);
console.info("supportedModes:" + data.supportedModes);
console.info('getApplicationInfo permissions length [' + data.permissions.length + ']');
for (var j = 0; j < data.permissions.length; j++) {
console.info("permissions[" + j + "]:" + data.permissions[j]);
}
console.info('getApplicationInfo moduleSourceDirs length [' + data.moduleSourceDirs.length + ']');
for (var j = 0; j < data.moduleSourceDirs.length; j++) {
console.info("moduleSourceDirs[" + j + "]:" + data.moduleSourceDirs[j]);
}
console.info('getApplicationInfo moduleInfos length [' + data.moduleInfos.length + ']');
for (var j = 0; j < data.moduleInfos.length; j++) {
console.info("moduleInfos[" + j + "]moduleName:" + data.moduleInfos[j].moduleName);
console.info("moduleInfos[" + j + "]moduleSourceDir:" + data.moduleInfos[j].moduleSourceDir);
}
console.info("entryDir:" + data.entryDir);
console.info("codePath:" + data.codePath);
console.info("dataDir:" + data.dataDir);
console.info("dataBaseDir:" + data.dataBaseDir);
console.info("cacheDir:" + data.cacheDir);
console.info("name: for begin");
console.info("name:" + data.name);
console.info("bundleName:" + data.bundleName);
console.info("description:" + data.description);
console.info("descriptionId:" + data.descriptionId);
console.info("iconPath:" + data.iconPath);
console.info("iconId:" + data.iconId);
console.info("label:" + data.label);
console.info("labelId:" + data.labelId);
console.info("deviceId:" + data.deviceId);
console.info("signatureKey:" + data.signatureKey);
console.info("process:" + data.process);
console.info("isSystemApp:" + data.isSystemApp);
console.info("isLauncherApp:" + data.isLauncherApp);
console.info("supportedModes:" + data.supportedModes);
console.info('getApplicationInfo permissions length [' + data.permissions.length + ']');
for (var j = 0; j < data.permissions.length; j++) {
console.info("permissions[" + j + "]:" + data.permissions[j]);
}
console.info('getApplicationInfo moduleSourceDirs length [' + data.moduleSourceDirs.length + ']');
for (var j = 0; j < data.moduleSourceDirs.length; j++) {
console.info("moduleSourceDirs[" + j + "]:" + data.moduleSourceDirs[j]);
}
console.info('getApplicationInfo moduleInfos length [' + data.moduleInfos.length + ']');
for (var j = 0; j < data.moduleInfos.length; j++) {
console.info("moduleInfos[" + j + "]moduleName:" + data.moduleInfos[j].moduleName);
console.info("moduleInfos[" + j + "]moduleSourceDir:" + data.moduleInfos[j].moduleSourceDir);
}
console.info("entryDir:" + data.entryDir);
console.info("codePath:" + data.codePath);
console.info("dataDir:" + data.dataDir);
console.info("dataBaseDir:" + data.dataBaseDir);
console.info("cacheDir:" + data.cacheDir);
})
```
#### getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback<ApplicationInfo>)
## bundle.getApplicationInfo
* 功能说明
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback\<ApplicationInfo>): void
根据给定的bundle名称获取ApplicationInfo
* getApplicationInfo参数描述
根据给定的bundle名称获取ApplicationInfo,通过回调函数获取返回值。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------------------------------ | ---- | ------------------------------------------------------- |
| bundleName | 只读 | string | 是 | 应用名 |
| bundleFlags | 只读 | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | 只读 | number | 是 | 用户ID |
| callback | 只读 | AsyncCallback<ApplicationInfo> | 是 | 回调方法 |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------------- | ---- | ------------------------------------------------------- |
| bundleName | string | 是 | 应用名 |
| bundleFlags | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | number | 是 | 用户ID |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 回调方法 |
void
* 示例
**示例:**
```
bundle.getApplicationInfo('com.example.myapplicationInstall', 8, 0, OnReceiveEvent);
......@@ -164,23 +134,25 @@ function OnReceiveEvent(err, data) {
#### getAllBundleInfo(bundleFlag: BundleFlag)
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag): Promise<Array\<BundleInfo>>
* 功能说明
获取系统中所有可用的包信息,通过Promise获取返回值。
获取系统中所有可用的包信息
* getAllBundleInfo参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------- | ---- | ----------------------------------------------------------- |
| bundleFlag | 只读 | BundleFlag | 是 | 0:返回默认BundleInfo<br>1:返回包含abilityInfo的BundleInfo |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------- | ---- | ----------------------------------------------------------- |
| bundleFlag | BundleFlag | 是 | 0:返回默认BundleInfo<br>1:返回包含abilityInfo的BundleInfo |
* 返回值
**返回值:**
Promise<Array<BundleInfo>>:返回值为Promise对象,Promise中包含包信息列表。
| 类型 | 说明 |
| --------------------------- | ---------------------------------------------- |
| Promise<Array\<BundleInfo>> | 返回值为Promise对象,Promise中包含包信息列表。 |
* 示例
**示例:**
```
bundle.getAllBundleInfo(0).then((data) => {
......@@ -251,24 +223,20 @@ bundle.getAllBundleInfo(0).then((data) => {
#### getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback<Array<BundleInfo>>)
* 功能说明
## bundle.getAllBundleInfo
获取系统中所有可用的包信息
* getAllBundleInfo参数描述
getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback<Array\<BundleInfo>>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFlag | 只读 | BundleFlag | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | 只读 | AsyncCallback<Array<BundleInfo>> | 是 | 回调方法 |
获取系统中所有可用的包信息,通过回调函数获取返回值。
* 返回值
**参数:**
void
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | AsyncCallback<Array\<BundleInfo>> | 是 | 回调方法 |
* 示例
**示例:**
```
bundle.getAllBundleInfo(0, OnReceiveEvent);
......@@ -342,24 +310,26 @@ function OnReceiveEvent(err, data) {
#### getBundleInfo(bundleName: string, bundleFlags: number)
## bundle.getBundleInfo
* 功能说明
getBundleInfo(bundleName: string, bundleFlags: number): Promise\<BundleInfo>
根据bundle名称获取BundleInfo
* getBundleInfo参数描述
根据bundle名称获取BundleInfo,通过Promise获取返回值。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 是 | 包名 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
Promise<BundleInfo>:返回值为Promise对象,Promise中包含包信息。
**返回值:**
* 示例
| 类型 | 说明 |
| -------------------- | ------------------------------------------ |
| Promise\<BundleInfo> | 返回值为Promise对象,Promise中包含包信息。 |
**示例:**
```
bundle.getBundleInfo('com.example.myapplicationInstall', 1).then((data) => {
......@@ -427,25 +397,21 @@ bundle.getBundleInfo('com.example.myapplicationInstall', 1).then((data) => {
#### getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>)
* 功能说明
## bundle.getBundleInfo
根据bundle名称获取BundleInfo
* getBundleInfo参数描述
getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 是 | 包名 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | 只读 | AsyncCallback<BundleInfo> | 是 | 回调方法 |
根据bundle名称获取BundleInfo,通过回调函数获取返回值。
* 返回值
**参数:**
void
| 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | AsyncCallback\<BundleInfo> | 是 | 回调方法 |
* 示例
**示例:**
```
bundle.getBundleInfo('com.example.myapplicationInstall', 1, OnReceiveEvent);
......@@ -515,24 +481,26 @@ function OnReceiveEvent(err, data) {
#### getAllApplicationInfo(bundleFlags: number, userId: number)
## bundle.getAllApplicationInfo
getAllApplicationInfo(bundleFlags: number, userId: number): Promise<Array\<ApplicationInfo>>
* 功能说明
获取指定用户下所有已安装的应用信息,通过Promise获取返回值。
获取指定用户下所有已安装的应用信息
* getAllApplicationInfo参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------- |
| bundleFlags | 只读 | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | 只读 | number | 是 | 用户ID |
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------- |
| bundleFlags | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | number | 是 | 用户ID |
* 返回值
**返回值:**
Promise<Array<ApplicationInfo>>:返回值为Promise对象,Promise中包含应用信息列表。
| 类型 | 说明 |
| -------------------------------- | ------------------------------------------------ |
| Promise<Array\<ApplicationInfo>> | 返回值为Promise对象,Promise中包含应用信息列表。 |
* 示例
**示例:**
```
bundle.getAllApplicationInfo(8, 0).then((data) => {
......@@ -578,25 +546,21 @@ bundle.getAllApplicationInfo(8, 0).then((data) => {
#### getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array<ApplicationInfo>>)
## bundle.getAllApplicationInfo
* 功能说明
getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array\<ApplicationInfo>>): void
获取指定用户下所有已安装的应用信息
* getAllApplicationInfo参数描述
获取指定用户下所有已安装的应用信息,通过回调函数获取返回值。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------------------------------------- | ---- | ------------------------------------------------------- |
| bundleFlags | 只读 | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | 只读 | number | 是 | 用户ID |
| callback | 只读 | AsyncCallback<Array<ApplicationInfo>> | 是 | 回调方法 |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------- |
| bundleFlags | number | 是 | 0:返回默认app信息<<br/>8:返回包含permissions的app信息 |
| userId | number | 是 | 用户ID |
| callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 回调方法 |
void
* 示例
**示例:**
```
bundle.getAllApplicationInfo(8, 0, OnReceiveEvent);
......@@ -644,45 +608,26 @@ function OnReceiveEvent(err, data) {
#### queryAbilityByWant(want: Want, bundleFlags: number, userId: number)
* 功能说明
## bundle.queryAbilityByWant
通过Want获取对应的Ability信息
* queryAbilityInfo参数描述
queryAbilityByWant(want: Want, bundleFlags: number, userId: number): Promise<Array\<AbilityInfo>>
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| want | 只读 | Want | 是 | 指定Want信息 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| userId | 只读 | number | 是 | 用户ID |
通过Want获取对应的Ability信息,通过Promise获取返回值。
* Want类型说明
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| elementName | 只读 | ElementName | 是 | 表示运行指定Ability的ElementName。 |
| uri | 只读 | string | 否 | 表示Uri描述。 |
| flags | 只读 | int | 否 | Ability的flag,表示处理Want的方式。 |
| type | 只读 | string | 否 | Want中的type属性是指由Want的URI所指示的资源的MIME类型。 |
| action | 只读 | string | 否 | 表示动作,通常使用系统预置Action,应用也可以自定义Action。 |
| want_param | 只读 | {[key: string]: any} | 否 | want_param是一种支持自定义的数据结构,开发者可以通过want_param传递某些请求所需的额外信息。 |
| entities | 只读 | Array<string> | 否 | 表示类别,通常使用系统预置Entity,应用也可以自定义Entity。 |
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------- | ---- | ------------------------------------------------------------ |
| want | [Want](#want) | 是 | 指定Want信息 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| userId | number | 是 | 用户ID |
* ElementName类型说明
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ----------------------------------------------- |
| Promise<Array\<AbilityInfo>> | 返回值为Promise对象,Promise中包含Ability信息。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
* 返回值
Promise<Array<AbilityInfo>>:返回值为Promise对象,Promise中包含Ability信息。
* 示例
**示例:**
```
bundle.queryAbilityByWant({
......@@ -764,46 +709,22 @@ bundle.queryAbilityByWant({
#### queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: AsyncCallback<Array<AbilityInfo>>)
* 功能说明
通过Want获取对应的Ability信息
* queryAbilityInfo参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | Want | 是 | 指定Want信息 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| userId | 只读 | number | 是 | 用户ID |
| callback | 只读 | AsyncCallback<Array<AbilityInfo>> | 是 | 回调方法 |
## bundle.queryAbilityByWant
* Want类型说明
queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: AsyncCallback<Array\<AbilityInfo>>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| elementName | 只读 | ElementName | 是 | 表示运行指定Ability的ElementName。 |
| uri | 只读 | string | 否 | 表示Uri描述。 |
| flags | 只读 | int | 否 | Ability的flag,表示处理Want的方式。 |
| type | 只读 | string | 否 | Want中的type属性是指由Want的URI所指示的资源的MIME类型。 |
| action | 只读 | string | 否 | 表示动作,通常使用系统预置Action,应用也可以自定义Action。 |
| want_param | 只读 | {[key: string]: any} | 否 | want_param是一种支持自定义的数据结构,开发者可以通过want_param传递某些请求所需的额外信息。 |
| entities | 只读 | Array<string> | 否 | 表示类别,通常使用系统预置Entity,应用也可以自定义Entity。 |
通过Want获取对应的Ability信息,通过回调函数获取返回值。
* ElementName类型说明
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](#want) | 是 | 指定Want信息 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| userId | number | 是 | 用户ID |
| callback | AsyncCallback<Array\<AbilityInfo>> | 是 | 回调方法 |
* 返回值
void
* 示例
**示例:**
```
bundle.queryAbilityByWant(
......@@ -887,23 +808,24 @@ function OnReceiveEvent(err, data) {
#### getPermissionDef(permissionName: string)
* 功能说明
## bundle.getPermissionDef
获取指定权限的详细信息
getPermissionDef(permissionName: string): Promise\<BundleInfo>
* getPermissionDef参数描述
获取指定权限的详细信息,通过Promise获取返回值。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------ | ---- | ------ |
| permissionName | 只读 | string | 是 | 权限名 |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------ | ---- | ------ |
| permissionName | string | 是 | 权限名 |
Promise<BundleInfo>:返回值为bundle信息。
**返回值:**
| 类型 | 说明 |
| -------------------- | -------------------- |
| Promise\<BundleInfo> | 返回值为bundle信息。 |
* 示例
**示例:**
```
bundle.getPermissionDef('com.permission.CAMERA').then((data) => {
......@@ -918,24 +840,20 @@ bundle.getPermissionDef('com.permission.CAMERA').then((data) => {
#### getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>)
* 功能说明
获取指定权限的详细信息
## bundle.getPermissionDef
* getPermissionDef参数描述
getPermissionDef(permissionName: string, callback: AsyncCallback\<PermissionDef>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ---------------------------- | ---- | -------- |
| permissionName | 只读 | string | 是 | 权限名 |
| callback | 只读 | AsyncCallback<PermissionDef> | 是 | 回调方法 |
获取指定权限的详细信息,通过回调函数获取返回值。
* 返回值
**参数:**
void
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ----------------------------- | ---- | -------- |
| permissionName | string | 是 | 权限名 |
| callback | AsyncCallback\<PermissionDef> | 是 | 回调方法 |
* 示例
**示例:**
```
bundle.getBundleInstaller().then((data) => {
......@@ -954,24 +872,25 @@ bundle.getBundleInstaller().then((data) => {
#### getBundleArchiveInfo(hapFilePath: string, bundleFlags: number)
## bundle.getBundleArchiveInfo
* 功能说明
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number): Promise\<BundleInfo>
获取HAP包含的应用包信息
获取HAP包含的应用包信息,通过Promise获取返回值。
* getBundleArchiveInfo参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| hapFilePath | 只读 | string | 是 | hap包文件路径 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| hapFilePath | string | 是 | hap包文件路径 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
* 返回值
**返回值:**
| 类型 | 说明 |
| -------------------- | -------------------- |
| Promise\<BundleInfo> | 返回值为bundle信息。 |
Promise<BundleInfo>:返回值为bundle信息。
* 示例
**示例:**
```
bundle.getBundleArchiveInfo('/data/test.hap', 1).then((data) => {
......@@ -1036,27 +955,21 @@ bundle.getBundleArchiveInfo('/data/test.hap', 1).then((data) => {
})
```
## bundle.getBundleArchiveInfo
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>): void
#### getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>)
* 功能说明
获取HAP包含的应用包信息
获取HAP包含的应用包信息,通过回调函数获取返回值。
* getBundleArchiveInfo参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| hapFilePath | 只读 | string | 是 | hap包文件路径 |
| bundleFlags | 只读 | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | 只读 | AsyncCallback<BundleInfo> | 是 | 回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------- | ---- | ------------------------------------------------------------ |
| hapFilePath | string | 是 | hap包文件路径 |
| bundleFlags | number | 是 | 0:返回默认BundleInfo<br/>1:返回包含abilityInfo的BundleInfo |
| callback | AsyncCallback<BundleInfo> | 是 | 回调方法 |
* 返回值
void
* 示例
**示例:**
```
bundle.getBundleArchiveInfo('/data/test.hap', 1, OnReceiveEvent);
......@@ -1123,34 +1036,21 @@ function OnReceiveEvent(err, data) {
}
```
## install
install(bundleFilePaths: Array\<string>, param: InstallParam, callback: AsyncCallback\<InstallStatus>): void
#### install(bundleFilePaths: Array<string>, param: InstallParam, callback: AsyncCallback<InstallStatus>)
* 功能说明
安装hap包。
安装hap包
* install参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| bundleFilePaths | 只读 | Array<string> | 是 | 安装用包路径 |
| param | 只读 | InstallParam | 是 | userId:用户ID<br/>installFlag:安装标识。<br/> NORMAL:安装/卸载<br/> REPLACE_EXISTING:更新<br/>isKeepData:卸载时是否保留运行时数据 |
| callback | 只读 | AsyncCallback<InstallStatus> | 是 | 回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFilePaths | Array\<string> | 是 | 安装用包路径 |
| param | InstallParam | 是 | userId:用户ID<br/>installFlag:安装标识。<br/> NORMAL:安装/卸载<br/> REPLACE_EXISTING:更新<br/>isKeepData:卸载时是否保留运行时数据 |
| callback | AsyncCallback<[InstallStatus](#Installstatus)> | 是 | 回调方法 |
* 返回值
void
* InstallStatus类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status | 只读 | InstallErrorCode | 是 | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41 |
| statusMessage | 只读 | string | 是 | 安装结果Message |
* 示例
**示例:**
```
bundle.getBundleInstaller().then((data) => {
......@@ -1169,34 +1069,21 @@ bundle.getBundleInstaller().then((data) => {
})
```
## uninstall
uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback\<InstallStatus>): void
#### uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>)
* 功能说明
卸载hap包。
卸载hap包
* uninstall参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 是 | 卸载用包名 |
| param | 只读 | InstallParam | 是 | userId:用户ID<br/>installFlag:安装标识。<br/> NORMAL:安装/卸载<br/> REPLACE_EXISTING:更新<br/>isKeepData:卸载时是否保留运行时数据 |
| callback | 只读 | AsyncCallback<InstallStatus> | 是 | 回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 卸载用包名 |
| param | InstallParam | 是 | userId:用户ID<br/>installFlag:安装标识。<br/> NORMAL:安装/卸载<br/> REPLACE_EXISTING:更新<br/>isKeepData:卸载时是否保留运行时数据 |
| callback | AsyncCallback<[InstallStatus](#Installstatus)> | 是 | 回调方法 |
* 返回值
void
* InstallStatus类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status | 只读 | InstallErrorCode | 是 | 卸载结果code<br/>SUCCESS = 0<br/>STATUS_UNINSTALL_FAILURE = 7<br/>STATUS_UNINSTALL_FAILURE_BLOCKED = 8<br/>STATUS_UNINSTALL_FAILURE_ABORTED = 9,<br/>STATUS_UNINSTALL_FAILURE_CONFLICT = 10<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41 |
| statusMessage | 只读 | string | 是 | 卸载结果Message |
* 示例
**示例:**
```
bundle.getBundleInstaller().then((data) => {
......@@ -1215,25 +1102,24 @@ bundle.getBundleInstaller().then((data) => {
})
```
## bundle.getAllShortcutInfo
getAllShortcutInfo(bundleName: string): Promise\<ShortcutInfo>
#### getAllShortcutInfo(bundleName: string)
* 功能说明
获取指定bundle名的shortcut信息
获取指定bundle名的shortcut信息,通过Promise获取返回值。
* getAllShortcutInfo参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | -------- |
| bundleName | 只读 | string | 是 | bundle名 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是 | bundle名 |
* 返回值
**返回值:**
| 类型 | 说明 |
| ---------------------- | -------------------- |
| Promise\<ShortcutInfo> | 返回值为bundle信息。 |
Promise<ShortcutInfo>:返回值为bundle信息。
* 示例
**示例:**
```
bundle.getAllShortcutInfo('com.example.third1').then((data) => {
......@@ -1243,24 +1129,20 @@ bundle.getAllShortcutInfo('com.example.third1').then((data) => {
#### getAllShortcutInfo(bundleName: string, callback: AsyncCallback<Array<ShortcutInfo>>)
* 功能说明
获取指定bundle名的shortcut信息
## bundle.getAllShortcutInfo
* getAllShortcutInfo参数描述
getAllShortcutInfo(bundleName: string, callback: AsyncCallback<Array\<ShortcutInfo>>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------- | ---- | -------- |
| bundleName | 只读 | string | 是 | bundle名 |
| callback | 只读 | AsyncCallback<ShortcutInfo> | 是 | 回调方法 |
获取指定bundle名的shortcut信息,通过回调函数获取返回值。
* 返回值
**参数:**
void
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------- | ---- | -------- |
| bundleName | string | 是 | bundle名 |
| callback | AsyncCallback<ShortcutInfo> | 是 | 回调方法 |
* 示例
**示例:**
```
bundle.getAllShortcutInfo('com.example.third1', OnReceiveEvent);
......@@ -1270,26 +1152,25 @@ function OnReceiveEvent(err, data) {
}
```
## bundle.checkPermission
checkPermission(bundleName: string, permission: string): Promise\<GrantStatus>
#### checkPermission(bundleName: string, permission: string)
* 功能说明
校验应用是否具有指定权限
校验应用是否具有指定权限,通过Promise获取返回值。
* checkPermission参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | -------- |
| bundleName | 只读 | string | 是 | bundle名 |
| permission | 只读 | string | 是 | 权限名 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是 | bundle名 |
| permission | string | 是 | 权限名 |
* 返回值
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------- |
| Promise\<GrantStatus> | 返回值为bundle信息。 |
Promise<GrantStatus>:返回值为bundle信息。
* 示例
**示例:**
```
bundle.getModuleUsageRecords('com.example.actsbmscheckpermissiontest', 'com.permission.CAMERA').then((data) => {
......@@ -1297,27 +1178,21 @@ bundle.getModuleUsageRecords('com.example.actsbmscheckpermissiontest', 'com.perm
});
```
## bundle.checkPermission
checkPermission(bundleName: string, permission: string, callback: AsyncCallback\<GrantStatus>): void
#### checkPermission(bundleName: string, permission: string, callback: AsyncCallback<GrantStatus>)
* 功能说明
校验应用是否具有指定权限
校验应用是否具有指定权限,通过回调函数获取返回值。
* checkPermission参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------------- | ---- | -------- |
| bundleName | 只读 | string | 是 | bundle名 |
| permission | 只读 | string | 是 | 权限名 |
| callback | 只读 | AsyncCallback<GrantStatus> | 是 | 回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------- | ---- | -------- |
| bundleName | string | 是 | bundle名 |
| permission | string | 是 | 权限名 |
| callback | AsyncCallback\<GrantStatus> | 是 | 回调方法 |
* 返回值
void
* 示例
**示例:**
```
bundle.checkPermission('com.example.actsbmscheckpermissiontest', 'com.permission.CAMERA', OnReceiveEvent);
......@@ -1326,3 +1201,30 @@ function OnReceiveEvent(err, data) {
...
}
```
## Want
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| elementName | 只读 | [ElementName](#elementname) | 是 | 表示运行指定Ability的ElementName。 |
| uri | 只读 | string | 否 | 表示Uri描述。 |
| flags | 只读 | int | 否 | Ability的flag,表示处理Want的方式。 |
| type | 只读 | string | 否 | Want中的type属性是指由Want的URI所指示的资源的MIME类型。 |
| action | 只读 | string | 否 | 表示动作,通常使用系统预置Action,应用也可以自定义Action。 |
| want_param | 只读 | {[key: string]: any} | 否 | want_param是一种支持自定义的数据结构,开发者可以通过want_param传递某些请求所需的额外信息。 |
| entities | 只读 | Array\<string> | 否 | 表示类别,通常使用系统预置Entity,应用也可以自定义Entity。 |
## ElementName
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
## InstallStatus
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status | 只读 | InstallErrorCode | 是 | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41 |
| statusMessage | 只读 | string | 是 | 安装结果Message |
# Context模块
## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getOrCreateLocalDir() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, options?: PermissionOptions) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getApplicationInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getBundleName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getBundleName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getElementName(callback: AsyncCallback\<ElementName>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getElementName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getCallingBundle(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getCallingBundle() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
## 导入模块
```js
......@@ -38,24 +15,24 @@ var context = featureAbility.getContext();
context.getOrCreateLocalDir()
```
## Context.getOrCreateLocalDir(callback: AsyncCallback<string>)
## Context
- 接口说明
### getOrCreateLocalDir
获取应用程序的本地根目录。如果是第一次调用,将创建目录(callback形式)
getOrCreateLocalDir(callback: AsyncCallback\<string>): void
- getOrCreateLocalDir参数描述
获取应用程序的本地根目录(callback形式)。
如果是第一次调用,将创建目录。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------------ |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录 |
**参数:**
- 返回值
void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -67,19 +44,21 @@ context.getOrCreateLocalDir((err, data)=>{
## Context.getOrCreateLocalDir()
### getOrCreateLocalDir
getOrCreateLocalDir(): Promise\<string>
- 接口说明
获取应用程序的本地根目录(Promise形式)。
获取应用程序的本地根目录。如果是第一次调用,将创建目录(Promise形式)
如果是第一次调用,将创建目录。
- 返回值
**返回值:**
| 类型 | 说明 |
| --------------- | -------------------- |
| Promise<string> | 应用程序的本地根目录 |
| 类型 | 说明 |
| ---------------- | ---------------------- |
| Promise\<string> | 应用程序的本地根目录。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -89,33 +68,24 @@ context.getOrCreateLocalDir().then((void) => {
});
```
## PermissionOptions类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------ |
| pid | 只读 | number | 否 | 进程id |
| uid | 只读 | number | 否 | 用户id |
## Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback<number>)
- 接口说明
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)
### verifyPermission
- 参数描述
verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>): void
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ----------------------------------------------- | ---- | ----------------------------------- |
| permission | 只读 | string | 是 | 指定权限的名称 |
| options | 只读 | [PermissionOptions](#PermissionOptions类型说明) | 是 | 权限选项 |
| callback | 只读 | AsyncCallback\<number> | 是 | 返回权限验证结果,0有权限,-1无权限 |
**参数:**
- 返回值
void
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ------------------------------------- |
| permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 是 | 权限选项。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果,0有权限,-1无权限。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -128,25 +98,21 @@ context.verifyPermission("com.example.permission",datainfo.uid)
## Context.verifyPermission(permission: string, callback: AsyncCallback<number>)
- 接口说明
### verifyPermission
验证系统中运行的当前pid和uid是否具有指定的权限(callback形式)
verifyPermission(permission: string, callback: AsyncCallback\<number>): void
- 参数描述
验证系统中运行的当前pid和uid是否具有指定的权限(callback形式)。
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | ----------------------------------- |
| permission | 只读 | string | 是 | 指定权限的名称 |
| callback | 只读 | AsyncCallback\<number> | 是 | 返回权限验证结果,0有权限,-1无权限 |
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | ------------------------------------- |
| permission | string | 是 | 指定权限的名称。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果,0有权限,-1无权限。 |
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -154,28 +120,27 @@ var context = featureAbility.getContext();
context.verifyPermission("com.example.permission")
```
### verifyPermission
verifyPermission(permission: string, options?: PermissionOptions): Promise\<number>
## Context.verifyPermission(permission: string, options?: PermissionOptions)
- 接口说明
验证系统中运行的特定pid和uid是否具有指定的权限(Promise形式)。
验证系统中运行的特定pid和uid是否具有指定的权限(Promise形式)
- 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ----------------------------------------------- | ---- | -------------- |
| permission | 只读 | string | 是 | 指定权限的名称 |
| options | 只读 | [PermissionOptions](#PermissionOptions类型说明) | 否 | 权限选项 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ---------------- |
| permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 |
- 返回值
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------------------------------------------ |
| Promise<number> | 如果pid和uid具有权限,则使用**0**进行异步回调;否则使用**-1**回调。 |
| 类型 | 说明 |
| ---------------- | ----------------------------------------------------------- |
| Promise\<number> | 如果pid和uid具有权限,则使用0进行异步回调;否则使用-1回调。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -186,35 +151,23 @@ context.getOrCreateLocalDir('com.context.permission',Permission).then((void) =>
});
```
## PermissionRequestResult类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码 |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限 |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果 |
## Context.requestPermissionsFromUser(permissions: Array<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#PermissionRequestResult类型说明)>)
### requestPermissionsFromUser
- 接口说明
requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#permissionrequestresult)>)
从系统请求某些权限(callback形式)
从系统请求某些权限(callback形式)。
- requestPermissionsFromUser参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| permissions | 只读 | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null |
| requestCode | 只读 | number | 是 | 指示要传递给PermissionRequestResult的请求代码 |
| resultCallback | 只读 | AsyncCallback\<[PermissionRequestResult](#PermissionRequestResult类型说明)> | 是 | 返回授权结果信息 |
- 返回值
void
- 示例
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 |
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -231,23 +184,19 @@ context.getOrCreateLocalDir(
## Context.getApplicationInfo(callback: AsyncCallback<ApplicationInfo>)
- 接口说明
### getApplicationInfo
获取有关当前应用程序的信息(callback形式)
getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>)
- 参数描述
获取有关当前应用程序的信息(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息 |
**参数:**
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息。 |
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -257,23 +206,19 @@ context.getApplicationInfo()
## Context.getApplicationInfo
- 接口说明
### getApplicationInfo
获取有关当前应用程序的信息(Promise形式)
getApplicationInfo(): Promise\<ApplicationInfo>
- 参数描述
获取有关当前应用程序的信息(Promise形式)。
**返回值:**
- 返回值
| 类型 | 说明 |
| ------------------------- | ------------------ |
| Promise\<ApplicationInfo> | 当前应用程序的信息 |
| 类型 | 说明 |
| ------------------------ | ------------------ |
| Promise<ApplicationInfo> | 当前应用程序的信息 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -285,23 +230,19 @@ context.getApplicationInfo().then((void) => {
## Context.getBundleName(callback: AsyncCallback<string>)
- 接口说明
### getBundleName
获取当前ability的捆绑包名称(callback形式)
getBundleName(callback: AsyncCallback\<string>): void
- 参数描述
获取当前ability的捆绑包名称(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | --------------------------- |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称 |
**参数:**
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 |
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -311,23 +252,19 @@ context.getBundleName()
## Context.getBundleName
- 接口说明
获取当前ability的捆绑包名称(Promise形式)
### getBundleName
- 参数描述
getBundleName(): Promise\<string>
获取当前ability的捆绑包名称(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| Promise<string> | 当前ability的捆绑包名称 |
| 类型 | 说明 |
| ---------------- | ------------------------- |
| Promise\<string> | 当前ability的捆绑包名称。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -339,23 +276,19 @@ context.getBundleName().then((void) => {
## Context.getProcessInfo(callback: AsyncCallback<ProcessInfo>)
### getProcessInfo
- 接口说明
getProcessInfo(callback: AsyncCallback\<ProcessInfo>)
获取有关当前进程的信息,包括进程ID和名称(callback形式)
获取有关当前进程的信息,包括进程ID和名称(callback形式)。
- 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------- | ---- | ------------------ |
| callback | 只读 | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | -------------------- |
| callback | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息。 |
- 返回值
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -365,23 +298,19 @@ context.getProcessInfo()
## Context.getProcessInfo
- 接口说明
获取有关当前进程的信息,包括进程id和名称(Promise形式)
### getProcessInfo
- 参数描述
getProcessInfo(): Promise\<ProcessInfo>
获取有关当前进程的信息,包括进程id和名称(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| -------------------- | -------------- |
| Promise<ProcessInfo> | 当前进程的信息 |
| 类型 | 说明 |
| --------------------- | -------------- |
| Promise\<ProcessInfo> | 当前进程的信息 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -393,23 +322,21 @@ context.getProcessInfo().then((void) => {
## Context.getElementName(callback: AsyncCallback<ElementName>)
### getElementName
- 接口说明
getElementName(callback: AsyncCallback\<ElementName>): void
获取当前ability的ohos.bundle.ElementName对象。此方法仅适用于页面功能(callback形式)
获取当前ability的ohos.bundle.ElementName对象(callback形式)。
- 参数描述
此方法仅适用于页面功能。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------- | ---- | -------------------------------------------- |
| callback | 只读 | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象 |
**参数:**
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 |
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -419,23 +346,21 @@ context.getElementName()
## Context.getElementName
- 接口说明
### getElementName
获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(Promise形式)
getElementName(): Promise\<ElementName>
- 参数描述
获取当前能力的ohos.bundle.ElementName对象(Promise形式)。
此方法仅适用于页面功能。
- 返回值
**返回值:**
| 类型 | 说明 |
| -------------------- | ---------------------------------------- |
| Promise<ElementName> | 当前ability的ohos.bundle.ElementName对象 |
| 类型 | 说明 |
| --------------------- | ------------------------------------------ |
| Promise\<ElementName> | 当前ability的ohos.bundle.ElementName对象。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -445,23 +370,17 @@ context.getElementName().then((void) => {
});
```
## **Context.getProcessName(callback: AsyncCallback<string>)**
- 接口说明
### getProcessName
获取当前进程的名称(callback形式)
getProcessName(callback: AsyncCallback\<string>): void
- 参数描述
获取当前进程的名称(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------ |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回当前进程的名称 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 |
- 返回值
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -471,23 +390,19 @@ context.getProcessName()
## Context.getProcessName
- 接口说明
获取当前进程的名称(Promise形式)
### getProcessName
- 参数描述
getProcessName(): Promise\<string>
获取当前进程的名称(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| --------------- | -------------- |
| Promise<string> | 当前进程的名称 |
| 类型 | 说明 |
| ---------------- | -------------------- |
| Promise\<string> | 返回当前进程的名称。 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -499,23 +414,19 @@ context.getProcessName().then((void) => {
## Context.getCallingBundle(callback: AsyncCallback<string>)
### getCallingBundle
- 接口说明
getCallingBundle(callback: AsyncCallback\<string>): void
获取调用ability的包名称(callback形式)
获取调用ability的包名称(callback形式)。
- 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------------- |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回调用ability的包名称 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 |
- 返回值
void
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -525,25 +436,19 @@ context.getCallingBundle()
## Context.getCallingBundle
- 接口说明
### getCallingBundle
获取调用ability的包名称(Promise形式)
getCallingBundle(): Promise\<string>
- 参数描述
获取调用ability的包名称(Promise形式)。
**返回值:**
- 返回值
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise\<string> | 调用ability的包名称 |
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise<string> | 调用ability的包名称 |
- 示例
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility'
......@@ -553,3 +458,17 @@ context.getCallingBundle().then((void) => {
});
```
## PermissionOptions
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------ |
| pid | 只读 | number | 否 | 进程id |
| uid | 只读 | number | 否 | 用户id |
## PermissionRequestResult
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码 |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限 |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果 |
......@@ -6,24 +6,25 @@
import dataUriUtils from '@ohos.ability.dataUriUtils';
```
## DataUriUtils.getId
## dataUriUtils.getId
- 接口说明
getId(uri: string): number
获取附加到给定uri的路径组件末尾的ID
获取附加到给定uri的路径组件末尾的ID。
- 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
- 返回值
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到路径组件末尾的ID。 |
附加到路径组件末尾的ID
- 示例
**示例:**
```js
import dataUriUtils from '@ohos.ability.datauriutils'
......@@ -32,25 +33,26 @@ dataUriUtils.getIdSync("com.example.dataUriUtils/1221")
## DataUriUtils.attachId
- 接口说明
## dataUriUtils.attachId
将给定ID附加到给定uri的路径组件的末尾
attachId(uri: string, id: number): string
- 参数描述
将给定ID附加到给定uri的路径组件的末尾。
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 |
| id | 只读 | number | 是 | 指示要附加的ID |
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| id | number | 是 | 指示要附加的ID。 |
附加给定ID的uri对象
**返回值:**
| 类型 | 说明 |
| ------ | --------------------- |
| string | 附加给定ID的uri对象。 |
- 示例
**示例:**
```js
import dataUriUtils from '@ohos.ability.datauriutils'
......@@ -63,23 +65,24 @@ dataUriUtils.attachId(
## DataUriUtils.deleteId
## dataUriUtils.deleteId
- 接口说明
deleteId(uri: string): string
从给定uri的路径组件的末尾删除ID
从给定uri的路径组件的末尾删除ID。
- 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中删除ID的uri对象 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
- 返回值
**返回值:**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
ID已删除的uri对象
- 示例
**示例:**
```js
import dataUriUtils from '@ohos.ability.datauriutils'
......@@ -88,24 +91,25 @@ dataUriUtils.deleteId("com.example.dataUriUtils/1221")
## DataUriUtils.updateId
- 接口说明
## dataUriUtils.updateId
更新指定uri中的ID
updateId(uri: string, id: number): string
- updateId参数描述
更新指定uri中的ID。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------- |
| uri | 只读 | string | 是 | 指示要更新的uri对象 |
| id | 只读 | number | 是 | 指示新ID |
**参数:**
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象 |
| id | number | 是 | 指示新ID |
更新的uri对象
**返回值:**
| 类型 | 说明 |
| ------ | --------------- |
| string | 更新的uri对象。 |
- 示例
**示例:**
```js
import dataUriUtils from '@ohos.ability.datauriutils'
......
# AbilityContext
- [属性](#属性)
- [startAbility](#startAbility)
- [startAbility](#startAbility)
- [startAbilityForResult](#startAbilityForResult)
- [startAbilityForResult](#startAbilityForResult)
- [terminateSelf](#terminateSelf)
- [terminateSelf](#terminateSelf)
- [terminateSelfWithResult](#terminateSelfWithResult)
- [terminateSelfWithResult](#terminateSelfWithResult)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......@@ -88,10 +79,10 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
启动Ability并在结束的时候返回执行结果。
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | Callback&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | 是 | 执行结果回调函数。 |
| want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | Callback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 |
- 示例:
......@@ -118,9 +109,9 @@ startAbilityForResult(want: Want): Promise&lt;AbilityResult&gt;;
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | Promise形式返回执行结果。 |
| Promise&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | Promise形式返回执行结果。 |
- 示例:
```
......@@ -179,10 +170,10 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi
停止Ability,并返回给调用startAbilityForResult 接口调用方的相关信息。
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | Callback&lt;void&gt; | 否 | callback形式返回停止结果 |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | Callback&lt;void&gt; | 否 | callback形式返回停止结果 |
- 示例:
```
......@@ -204,9 +195,9 @@ terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability,并返回给调用startAbilityForResult 接口相关信息。
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
- 返回值:
| 类型 | 说明 |
......
......@@ -862,7 +862,7 @@ off(type: 'change', callback?: Callback&lt;void&gt;): void;
console.debug("receive change data:" + JSON.stringify(data));
appAccountManager.off('change', function(){
console.debug("off finish");
}
})
}
try{
appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
......
# 应用配置
- [导入模块](#导入模块)
- [权限列表](#权限列表)
- [configuration.getLocale](#configurationgetLocale)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 从API Version 7 开始,该接口不再维护,推荐使用新接口['@ohos.i18n'](js-apis-i18n.md)和['@ohos.intl'](js-apis-intl.md)。
>
>
>
## 导入模块
......
# 公共事件模块
**说明:**
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- |
| CommonEvent.publish(event: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
> **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 权限列表
| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| ------------ | ------------------ | ---------------------- |
| COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 |
| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 |
......@@ -114,11 +103,11 @@
| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 |
| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 |
| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 |
| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGE ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGE ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 |
## 导入模块
......@@ -129,20 +118,20 @@ import CommonEvent from '@ohos.commonevent';
## CommonEvent.publish(event: string, callback: AsyncCallback\<void>): void
## CommonEvent.publish
- 接口说明
publish(event: string, callback: AsyncCallback\<void>): void
发布公共事件(callback形式)
发布公共事件(callback形式)。
* publish参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | -------------------- |
| event | 只读 | string | 是 | 表示要发送的公共事件 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ---------------------- |
| event | 只读 | string | 是 | 表示要发送的公共事件。 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
* 示例
**示例:**
```js
//发布公共事件回调
......@@ -156,21 +145,21 @@ CommonEvent.publish("publish_event", PublishCallBack);
## CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
## CommonEvent.publish
- 接口说明
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
发布公共事件指定发布信息(callback形式)
发布公共事件指定发布信息(callback形式)。
- publish参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event | 只读 | string | 是 | 表示要发布的公共事件 |
| options | 只读 | [CommonEventPublishData](#publishData) | 是 | 表示发布公共事件的属性 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event | 只读 | string | 是 | 表示要发布的公共事件。 |
| options | 只读 | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
- 示例
**示例:**
```js
......@@ -190,20 +179,20 @@ CommonEvent.publish("publish_event", options, PublishCallBack);
## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
## CommonEvent.createSubscriber
- 接口说明
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
创建订阅者(callback形式)
创建订阅者(callback形式)。
- createSubscriber参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------------------------------------------- | ---- | ------------------------ |
| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#SubscribeInfo) | 是 | 表示订阅信息 |
| callback | 只读 | AsyncCallback\<[CommonEventSubscriber](#Subscriber)> | 是 | 表示创建订阅者的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ------------------------------------------------------------ | ---- | -------------------------- |
| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 |
| callback | 只读 | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是 | 表示创建订阅者的回调方法。 |
- 示例
**示例:**
```js
......@@ -223,25 +212,24 @@ CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
## CommonEvent.createSubscriber
- 接口说明
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
创建订阅者(Promise形式)
创建订阅者(Promise形式)。
- createSubscriber参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ------------------------------------------ | ---- | ------------ |
| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#SubscribeInfo) | 是 | 表示订阅信息 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ----------------------------------------------------- | ---- | -------------- |
| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 |
- 返回值
**返回值:**
| 类型 | 说明 |
| --------------------------------------------------------- | ---------------- |
| Promise\<[CommonEventSubscriber](#commoneventsubscriber)> | 返回订阅者对象。 |
Promise\<[CommonEventSubscriber](#Subscriber)>
订阅者对象
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
......@@ -258,23 +246,22 @@ CommonEvent.createSubscriber(subscribeInfo).then((data) => {
## CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
## CommonEvent.subscribe
- 接口说明
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
订阅公共事件(callback形式)
订阅公共事件(callback形式)。
- subscribe参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------------------------------- | ---- | ------------------------------ |
| subscriber | 只读 | [CommonEventSubscriber](#Subscriber) | 是 | 表示订阅者对象 |
| callback | 只读 | AsyncCallback\<[CommonEventData](#CommonEventData)> | 是 | 表示接收公共事件数据的回调函数 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------------------------------- | ---- | -------------------------------- |
| subscriber | 只读 | [CommonEventSubscriber](#commoneventsubscriber) | 是 | 表示订阅者对象。 |
| callback | 只读 | AsyncCallback\<[CommonEventData](#commoneventdata)> | 是 | 表示接收公共事件数据的回调函数。 |
- 示例
**示例:**
无序事件:
无序事件:
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
......@@ -297,7 +284,7 @@ function CreateSubscriberCallBack(err, data) {
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
有序事件:
有序事件:
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
......@@ -341,22 +328,22 @@ function CreateSubscriberCallBack(err, data) {
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
## CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
## CommonEvent.unsubscribe
- 接口说明
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
取消订阅公共事件(callback形式)
取消订阅公共事件(callback形式)。
- unsubscribe参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ---------------------- |
| subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示取消订阅的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------ |
| subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象。 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示取消订阅的回调方法。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
......@@ -385,7 +372,7 @@ CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
```
## <span id = "publishData">CommonEventPublishData</span>
## CommonEventPublishData
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
......@@ -396,7 +383,7 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## <span id = "SubscribeInfo">CommonEventSubscribeInfo</span>
## CommonEventSubscribeInfo
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
......@@ -406,7 +393,7 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 |
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
## <span id = "CommonEventData">CommonEventData</span>
## CommonEventData
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------ |
......@@ -416,456 +403,460 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据,用于传递string类型的数据 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## <span id = "Subscriber">CommonEventSubscriber</span>
## CommonEventSubscriber
### getCode(callback形式)
### getCode
- 方法说明
getCode(callback: AsyncCallback\<number>): void
获取公共事件的结果代码(callback形式)
获取公共事件的结果代码(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是 | 公共事件的结果代码 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是 | 公共事件的结果代码 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getCodeCallback(err, data) {
console.info("==========================>getCodeCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>code:=======================>", data);
}
subscriber.getCode(getCodeCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getCodeCallback(err, data) {
console.info("==========================>getCodeCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>code:=======================>", data);
}
subscriber.getCode(getCodeCallback);
```
### getCode(Promise形式)
### getCode
- 方法说明
getCode(): Promise\<number>
获取公共事件的结果代码(Promise形式)
获取公共事件的结果代码(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------ |
| Promise\<number> | 公共事件的结果代码 |
| 类型 | 说明 |
| ---------------- | -------------------- |
| Promise\<number> | 公共事件的结果代码。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getCode().then((data) => {
console.info("==========================>getCodePromise=======================>");
console.info("==========================>code:=======================>", data);
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getCode().then((data) => {
console.info("==========================>getCodePromise=======================>");
console.info("==========================>code:=======================>", data);
});
```
### setCode(callback形式)
### setCode
- 方法说明
setCode(code: number, callback: AsyncCallback\<void>): void
设置公共事件的结果代码(callback形式)
设置公共事件的结果代码(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| code | number | 是 | 公共事件的结果代码 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------------- |
| code | number | 是 | 公共事件的结果代码。 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeCallback(err) {
console.info("==========================>setCodeCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCode(1, setCodeCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeCallback(err) {
console.info("==========================>setCodeCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCode(1, setCodeCallback);
```
### setCode(Promise形式)
### setCode
- 方法说明
setCode(code: number): Promise\<void>
设置公共事件的结果代码(Promise形式)
设置公共事件的结果代码(Promise形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCode(1).then(() => {
console.info("==========================>setCodePromise=======================>");
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCode(1).then(() => {
console.info("==========================>setCodePromise=======================>");
});
```
### getData(callback形式)
### getData
- 方法说明
getData(callback: AsyncCallback\<string>): void
获取公共事件的结果数据(callback形式)
获取公共事件的结果数据(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 公共事件的结果数据 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | 是 | 公共事件的结果数据。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getDataCallback(err, data) {
console.info("==========================>getDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>data:=======================>", data);
}
subscriber.getData(getDataCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getDataCallback(err, data) {
console.info("==========================>getDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>data:=======================>", data);
}
subscriber.getData(getDataCallback);
```
### getData(Promise形式)
### getData
- 方法说明
getData(): Promise\<string>
获取公共事件的结果数据(Promise形式)
获取公共事件的结果数据(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据 |
| 类型 | 说明 |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getData().then((data) => {
console.info("==========================>getDataPromise=======================>");
console.info("==========================>data:=======================>", data);
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getData().then((data) => {
console.info("==========================>getDataPromise=======================>");
console.info("==========================>data:=======================>", data);
});
```
### setData(callback形式)
### setData
- 方法说明
setData(data: string, callback: AsyncCallback\<void>): void
设置公共事件的结果数据(callback形式)
设置公共事件的结果数据(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
console.info("==========================>setDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setData("publish_data_changed", setDataCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
console.info("==========================>setDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setData("publish_data_changed", setDataCallback);
```
### setData(Promise形式)
### setData
- 方法说明
setData(data: string): Promise\<void>
设置公共事件的结果数据(Promise形式)
设置公共事件的结果数据(Promise形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| data | string | 是 | 公共事件的结果数据 |
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | -------------------- |
| data | string | 是 | 公共事件的结果数据。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setData("publish_data_changed").then(() => {
console.info("==========================>setDataPromise=======================>");
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setData("publish_data_changed").then(() => {
console.info("==========================>setDataPromise=======================>");
});
```
### setCodeAndData(callback形式)
### setCodeAndData
- 方法说明
setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
设置公共事件的结果代码和结果数据(callback形式)
设置公共事件的结果代码和结果数据(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| code | number | 是 | 公共事件的结果代码 |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------------- |
| code | number | 是 | 公共事件的结果代码。 |
| data | string | 是 | 公共事件的结果数据。 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeDataCallback(err) {
console.info("==========================>setCodeDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeDataCallback(err) {
console.info("==========================>setCodeDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
```
### setCodeAndData(Promise形式)
### setCodeAndData
- 方法说明
setCodeAndData(code: number, data: string): Promise\<void>
设置公共事件的结果代码和结果数据(Promise形式)
设置公共事件的结果代码和结果数据(Promise形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
| data | string | 是 | 公共事件的结果数据 |
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | -------------------- |
| code | number | 是 | 公共事件的结果代码。 |
| data | string | 是 | 公共事件的结果数据。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("==========================>setCodeAndData=======================>");
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("==========================>setCodeAndData=======================>");
});
```
### isOrderedCommonEvent(callback形式)
### isOrderedCommonEvent
- 方法说明
isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(callback形式)
查询当前公共事件的是否为有序公共事件(callback形式)。
- 参数
返回true代表是有序公共事件,false代表不是有序公共事件。
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为有序公共事件 |
**参数:**
- 示例
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为有序公共事件。 |
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function isOrderedCallback(err, data) {
console.info("==========================>isOrderedCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>isOrdered:=======================>", data);
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
```
**示例:**
### isOrderedCommonEvent(Promise形式)
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function isOrderedCallback(err, data) {
console.info("==========================>isOrderedCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>isOrdered:=======================>", data);
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
```
- 方法说明
### isOrderedCommonEvent
查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(Promise形式)
isOrderedCommonEvent(): Promise\<boolean>
- 返回值
查询当前公共事件的是否为有序公共事件(Promise形式)。
| 类型 | 说明 |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为有序公共事件 |
返回true代表是有序公共事件,false代表不是有序公共事件。
- 示例
**返回值:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.isOrderedCommonEvent().then((data) => {
console.info("==========================>isOrdered:=======================>", data);
});
```
| 类型 | 说明 |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为有序公共事件 |
### abortCommonEvent(callback形式)
**示例:**
- 方法说明
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.isOrderedCommonEvent().then((data) => {
console.info("==========================>isOrdered:=======================>", data);
});
```
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)
### abortCommonEvent
- 参数
abortCommonEvent(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------ |
| callback | AsyncCallback\<boolean> | 是 | 取消当前的公共事件 |
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)。
- 示例
**参数:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function abortCallback(err) {
console.info("==========================>abortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.abortCommonEvent(abortCallback);
```
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 取消当前的公共事件。 |
### abortCommonEvent(Promise形式)
**示例:**
- 方法说明
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function abortCallback(err) {
console.info("==========================>abortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.abortCommonEvent(abortCallback);
```
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)
### abortCommonEvent
- 示例
abortCommonEvent(): Promise\<void>
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.abortCommonEvent().then(() => {
console.info("==========================>abortCommonEvent:=======================>");
});
```
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)。
### clearAbortCommonEvent(callback形式)
**示例:**
- 方法说明
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.abortCommonEvent().then(() => {
console.info("==========================>abortCommonEvent:=======================>");
});
```
清除当前公共事件的取消状态,仅对有序公共事件有效(callback形式)
### clearAbortCommonEvent
- 参数
clearAbortCommonEvent(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
清除当前公共事件的取消状态,仅对有序公共事件有效(callback形式)。
- 示例
**参数:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function clearAbortCallback(err) {
console.info("==========================>clearAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
```
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
### clearAbortCommonEvent(Promise形式)
**示例:**
- 方法说明
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function clearAbortCallback(err) {
console.info("==========================>clearAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
```
### clearAbortCommonEvent
clearAbortCommonEvent(): Promise\<void>
清除当前公共事件的取消状态,仅对有序公共事件有效(Promise形式)
清除当前公共事件的取消状态,仅对有序公共事件有效(Promise形式)。
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.clearAbortCommonEvent().then(() => {
console.info("==========================>clearAbortCommonEvent:=======================>");
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.clearAbortCommonEvent().then(() => {
console.info("==========================>clearAbortCommonEvent:=======================>");
});
```
### getAbortCommonEvent(callback形式)
### getAbortCommonEvent
- 方法说明
getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
获取当前有序公共事件是否取消的状态(callback形式)
获取当前有序公共事件是否取消的状态(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getAbortCallback(err, data) {
console.info("==========================>getAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>abort:=======================>", data);
}
subscriber.getAbortCommonEvent(getAbortCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getAbortCallback(err, data) {
console.info("==========================>getAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>abort:=======================>", data);
}
subscriber.getAbortCommonEvent(getAbortCallback);
```
### getAbortCommonEvent(Promise形式)
### getAbortCommonEvent
- 方法说明
getAbortCommonEvent(): Promise\<void>
获取当前有序公共事件是否取消的状态(Promise形式)
获取当前有序公共事件是否取消的状态(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |
| 类型 | 说明 |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getAbortCommonEvent().then((data) => {
console.info("==========================>getAbortCommonEvent:=======================>");
console.info("==========================>abort:=======================>", data);
});
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getAbortCommonEvent().then((data) => {
console.info("==========================>getAbortCommonEvent:=======================>");
console.info("==========================>abort:=======================>", data);
});
```
### getSubscribeInfo(callback形式)
### getSubscribeInfo
- 方法说明
getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
获取订阅者的订阅信息(callback形式)
获取订阅者的订阅信息(callback形式)。
- 参数
**参数:**
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | -------------------- |
| callback | AsyncCallback\<CommonEventSubscribeInfo> | 是 | 表示订阅者的订阅信息 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ------------------------------------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是 | 表示订阅者的订阅信息。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getSubscribeInfoCallback(err, data) {
console.info("==========================>getSubscribeInfoCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>priority:=======================>", data.priority);
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
```
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getSubscribeInfoCallback(err, data) {
console.info("==========================>getSubscribeInfoCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>priority:=======================>", data.priority);
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
```
### getSubscribeInfo(Promise形式)
### getSubscribeInfo
- 方法说明
getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>
获取订阅者的订阅信息(Promise形式)
获取订阅者的订阅信息(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | -------------------- |
| Promise\<CommonEventSubscribeInfo> | 表示订阅者的订阅信息 |
| 类型 | 说明 |
| ------------------------------------------------------------ | ---------------------- |
| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 |
- 示例
**示例:**
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getSubscribeInfo().then((data) => {
console.info("==========================>getSubscribeInfo:=======================>");
console.info("==========================>priority:=======================>", data.priority);
});
```
\ No newline at end of file
```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getSubscribeInfo().then((data) => {
console.info("==========================>getSubscribeInfo:=======================>");
console.info("==========================>priority:=======================>", data.priority);
});
```
\ No newline at end of file
# xml转换JavaScript
> ![icon-note.gif](D:\gitee\docs\zh-cn\application-dev\reference\apis\public_sys-resources\icon-note.gif) **说明:**
> **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
import convertXml from '@ohos.convertxml'
import convertxml from '@ohos.convertxml'
```
......@@ -41,7 +41,6 @@ convert(xml: string, options?: ConvertOptions) : Object
- 示例:
```
import convertXml from '@ohos.convertxml'
var xml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -49,8 +48,8 @@ convert(xml: string, options?: ConvertOptions) : Object
' <todo>Work</todo>' +
' <todo>Play</todo>' +
'</note>';
var convertxml = new convertXml.ConvertXML();
var result1 = convertxml.convert(xml, {compact: false, spaces: 0});
var conv= new convertxml.ConvertXML();
var result1 = conv.convert(xml, {trim: false, ignoreDeclaration: false});
console.log(result1)
```
......
......@@ -35,9 +35,6 @@ import display from '@ohos.display';
描述display对象的属性。
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| id | number | 是 | 否 | 显示设备的id号。 |
......
......@@ -124,8 +124,6 @@ emitter.emit(innerEvent, eventData);
进程内的事件。
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------- | ---- | ---- | ---------------------------------- |
| eventId | number | 是 | 是 | 事件的ID,由开发者定义用来辨别事件 |
......@@ -135,8 +133,6 @@ emitter.emit(innerEvent, eventData);
发送事件时传递的数据。
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | ------------------ | ---- | ---- | -------------- |
| data | [key: string]: any | 是 | 是 | 事件携带的数据 |
......@@ -56,7 +56,7 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
});
```
## getUserDataDir
## environment.getUserDataDir
getUserDataDir():Promise&lt;string&gt;
......@@ -78,7 +78,7 @@ getUserDataDir():Promise&lt;string&gt;
});
```
## getUserDataDir
## environment.getUserDataDir
getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
......
# ExtensionContext
- [属性](#属性)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
......@@ -12,7 +12,7 @@ import faultLogger from '@ohos.faultLogger'
## faultLogger.FaultType
## FaultType
故障类型枚举
......@@ -23,7 +23,7 @@ import faultLogger from '@ohos.faultLogger'
| JS_CRASH | 3 | JS程序故障类型 |
| APP_FREEZE | 4 | 应用程序卡死故障类型 |
## faultLogger.FaultLogInfo
## FaultLogInfo
故障信息数据结构,获取到的故障信息的数据结构
......
# FeatureAbility模块(JS端SDK接口)
#### 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.hasWindowFocus(): Promise\<boolean> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getWant(callback: AsyncCallback\<Want>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getWant(): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getContext(): Context | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelf(): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.disconnectAbility(connection: number): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 使用限制
## 使用限制
FeatureAbility模块的接口只能在Page类型的Ability调用
#### 导入模块
## 导入模块
```
import featureAbility from '@ohos.ability.featureAbility'
```
#### FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
## featureAbility.startAbility
* 接口说明
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
启动新的ability(callback形式)
启动新的ability(callback形式)。
* startAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ------------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| --------- | --------------------- | ---- | ------------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 |
- 返回值
- 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -71,21 +47,19 @@ featureAbility.startAbility(
#### FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number>
* 接口说明
## featureAbility.startAbility
启动新的ability(Promise形式)
startAbility(parameter: StartAbilityParameter): Promise\<number>
* startAbility参数描述
启动新的ability(Promise形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
**参数:**
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | --------------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
- 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -108,27 +82,25 @@ featureAbility.startAbility(
});
```
## featureAbility.acquireDataAbilityHelper
acquireDataAbilityHelper(uri: string): DataAbilityHelper
#### FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper
* 接口说明
获取dataAbilityHelper。
获取dataAbilityHelper
**参数:**
* 参数描述
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ---------------------- |
| uri | 只读 | string | 是 | 指示要打开的文件的路径 |
**返回值:**
* 返回值
| 类型 | 说明 |
| ----------------- | -------------------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
| 类型 | 说明 |
| ----------------- | ------------------------------------------ |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -137,26 +109,20 @@ featureAbility.acquireDataAbilityHelper(
)
```
## featureAbility.startAbilityForResult
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
* 接口说明
启动一个ability,并在该ability被销毁时返回执行结果(callback形式)。
启动一个ability,并在该ability被销毁时返回执行结果(callback形式)
**参数:**
* startAbility参数描述
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | --------------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ---------------------- | ---- | ------------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<[AbilityResult](#AbilityResult类型说明)> | 是 | 被指定的回调方法 |
* 返回值
[AbilityResult](#AbilityResult类型说明)
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -177,25 +143,24 @@ featureAbility.startAbilityForResult(
)
```
## featureAbility.startAbilityForResult
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
* 接口说明
启动一个ability,并在该ability被销毁时返回执行结果(Promise形式)。
启动一个ability,并在该ability被销毁时返回执行结果(Promise形式)
**参数:**
* startAbility参数描述
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | ------------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------- | -------------- |
| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 |
* 返回值
[AbilityResult](#AbilityResult类型说明)
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -230,25 +195,20 @@ featureAbility.startAbilityForResult(
});
```
## featureAbility.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
* 接口说明
设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(callback形式)
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability(callback形式)。
**参数:**
* startAbility参数描述
| 名称 | 类型 | 必填 | 描述 |
| --------- | ------------- | ---- | ------------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------- | ---- | ------------------- |
| parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -280,23 +240,24 @@ featureAbility.terminateSelfWithResult(
);
```
## featureAbility.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
* 接口说明
设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(Promise形式)
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability(Promise形式)。
* startAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------------------------- | ---- | ------------------- |
| parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
| 名称 | 类型 | 必填 | 描述 |
| --------- | ------------------------------- | ---- | ------------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability |
* 返回值
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise\<void> | 以Promise形式返回结果。 |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -332,23 +293,19 @@ featureAbility.terminateSelfWithResult(
#### FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void
## featureAbility.hasWindowFocus
* 接口说明
hasWindowFocus(callback: AsyncCallback\<boolean>): void
检查ability的主窗口是否具有窗口焦点(callback形式)
检查Ability的主窗口是否具有窗口焦点(callback形式)。
* 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------- | ---- | ---------------- |
| callback | 只读 | AsyncCallback\<boolean> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点,则返回true;否则返回false。 |
* 返回值
如果此异能当前具有视窗焦点,则返回{@code true};否则返回{@code false}
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -357,21 +314,19 @@ featureAbility.hasWindowFocus()
#### FeatureAbility.hasWindowFocus(): Promise\<boolean>
* 接口说明
检查ability的主窗口是否具有窗口焦点(Promise形式)
## featureAbility.hasWindowFocus
* 参数描述
hasWindowFocus(): Promise\<boolean>
检查Ability的主窗口是否具有窗口焦点(Promise形式)。
* 返回值
**返回值:**
如果此异能当前具有视窗焦点,则返回{@code true};否则返回{@code false}
| 类型 | 说明 |
| ----------------- | ---------------------------------------------------------- |
| Promise\<boolean> | 如果此Ability当前具有视窗焦点,则返回true;否则返回false。 |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -382,21 +337,19 @@ featureAbility.hasWindowFocus().then((void) => {
#### FeatureAbility.getWant(callback: AsyncCallback\<Want>)
## featureAbility.getWant
* 接口说明
getWant(callback: AsyncCallback\<Want>): void
获取从ability发送的want(callback形式)
获取从Ability发送的Want(callback形式)。
* 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ---------------- |
| callback | 只读 | AsyncCallback\<Want> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------------- | ---- | ------------------ |
| callback | AsyncCallback\<[Want](#want)> | 是 | 被指定的回调方法。 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -405,19 +358,18 @@ featureAbility.getWant()
#### FeatureAbility.getWant(): void
* 接口说明
## featureAbility.getWant
获取从ability发送的want(Promise形式)
getWant(): Promise\<Want>
* 参数描述
获取从Ability发送的Want(Promise形式)。
**返回值:**
| 类型 | 说明 |
| ----------------------- | ------------------------- |
| Promise\<[Want](#want)> | 以Promise的形式返回结果。 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -426,19 +378,18 @@ featureAbility.getWant().then((void) => {
});
```
## featureAbility.getContext
getContext(): Context
#### FeatureAbility.getContext(): Context
* 接口说明
获取应用上下文。
获取应用程序上下文
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| Context | 返回应用程序上下文。 |
* 返回值
返回应用程序上下文
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -448,21 +399,19 @@ context.getBundleName()
#### FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void
## featureAbility.terminateSelf
* 接口说明
terminateSelf(callback: AsyncCallback\<void>): void
设置page ability返回给被调用方的结果代码和数据,并销毁此page ability(callback形式)
设置Page Ability返回给被调用方的结果代码和数据,并销毁此Page Ability(callback形式)。
* 参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ---------------- |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------- |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -471,19 +420,18 @@ featureAbility.terminateSelf()
#### FeatureAbility.terminateSelf(): Promise\<void>
* 接口说明
## featureAbility.terminateSelf
设置page ability返回给被调用方的结果代码和数据,并销毁此page ability(Promise形式)
terminateSelf(): Promise\<void>
* 参数描述
设置Page Ability返回给被调用方的结果代码和数据,并销毁此Page Ability(Promise形式)。
Null
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 以Promise的形式返回结果。 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureability';
......@@ -491,20 +439,20 @@ featureAbility.terminateSelf().then((void) => { console.info("=============
});
```
#### FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number
## featureAbility.connectAbility
* 接口说明
connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility(callback形式)
将当前ability连接到指定ServiceAbility(callback形式)。
* connectAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------- | -------- | -------------- | ---- | -------------------------- |
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility |
| options | 只读 | ConnectOptions | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ------- | -------------- | ---- | ---------------------------- |
| request | Want | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
* Want参数描述
**Want类型说明:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
......@@ -512,7 +460,7 @@ featureAbility.terminateSelf().then((void) => { console.info("=============
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名 |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名 |
- ConnectOptions类型说明
**ConnectOptions类型说明:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
......@@ -520,11 +468,12 @@ featureAbility.terminateSelf().then((void) => { console.info("=============
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 |
* 返回值
连接的ServiceAbilityID。
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 连接的ServiceAbilityID。 |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -551,22 +500,20 @@ var connId = featureAbility.connectAbility(
);
```
#### FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
## featureAbility.disconnectAbility
* 接口说明
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
断开与指定ServiceAbility的连接(callback形式)
断开与指定ServiceAbility的连接(callback形式)。
* disconnectAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------- | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------- | ---- | ------------------------------ |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -597,21 +544,24 @@ var result = featureAbility.disconnectAbility(connId,
);
```
#### FeatureAbility.disconnectAbility(connection: number): Promise\<void>
## featureAbility.disconnectAbility
* 接口说明
disconnectAbility(connection: number): Promise\<void>
断开与指定ServiceAbility的连接(promise形式)
断开与指定ServiceAbility的连接(Promise形式)。
* disconnectAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | ------------------------------ |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
* 返回值
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise\<void> | 以Promise形式返回结果。 |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -638,28 +588,27 @@ var connId = featureAbility.connectAbility(
var result = await featureAbility.disconnectAbility(connId);
```
## featureAbility.continueAbility
#### FeatureAbility.continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback\<void>): void;
* 接口说明
continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback\<void>): void
迁移一个ability到目标设备,并返回执行结果(callback形式)
迁移一个ability到目标设备,并返回执行结果(callback形式)。
* startAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------- |
| options | 只读 | ContinueAbilityOptions | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------- |
| options | ContinueAbilityOptions | 是 | 表示被启动的Ability |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
- ContinueAbilityOptions类型说明
**ContinueAbilityOptions类型说明:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------- | ---- | ----------------------------------------------------------- |
| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息 |
| reversible | 只读 | boolean | 是 | 是否支持回迁的标志,目前不支持该功能,为保留字段,可填false |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息 |
| reversible | 只读 | boolean | 是 | 是否支持回迁的标志,目前不支持该功能,为保留字段,可填false |
* 示例
**示例:**
```javascript
import featureAbility from '@ohos.ability.featureAbility'
......@@ -679,21 +628,21 @@ async StartContinueAbility(deviceId) {
this.StartContinueAbility(remoteDeviceId); //remoteDeviceId is acquired from DeviceManager
```
#### AbilityResult类型说明
## AbilityResult
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持) |
| want | 只读 | [Want](#Want类型说明) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
#### StartAbilityParameter类型说明
## StartAbilityParameter
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
#### Want类型说明
## Want
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
......
......@@ -226,7 +226,6 @@ filemanager.createFile(dev, name, media_path, (err, uri) => {
## FileInfo
文件信息类型,通过getRoot, listFile等接口返回的类型。
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- |
......@@ -239,7 +238,7 @@ filemanager.createFile(dev, name, media_path, (err, uri) => {
## DevInfo
设备类型,配置接口访问的设备类型。
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- |
| name | string | 是 | 是 | 设备名称 |
\ No newline at end of file
# Notification模块
## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- |
| Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.publish(request: NotificationRequest) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id:number, label?:string) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll() | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots() | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(callback: AsyncCallback\<void\>): void | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled() | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle?: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelGroup(groupName: string) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeGroupByBundle(bundle: BundleOption, groupName: string) | 支持 | 支持 | 支持 | 支持 |
| Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.setDoNotDisturbDate(date: DoNotDisturbDate) | 支持 | 支持 | 支持 | 支持 |
| Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getDoNotDisturbDate() | 支持 | 支持 | 支持 | 支持 |
| Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.supportDoNotDisturbMode() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent): Promise\<string\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent): Promise\<number\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent): Promise\<Want\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | 支持 | 支持 | 支持 | 支持 |
## 权限列表
## 通知接口
## 导入模块
```js
......
# particleAbility模块
## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| particleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.terminateSelf(callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.terminateSelf(): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.connectAbility(request: Want, options:ConnectOptions): number | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.disconnectAbility(connection: number): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
## 使用限制
particleAbility模块用来对Data和Service类型的Ability进行操作
particleAbility模块用来对Data和Service类型的Ability进行操作
## 导入模块
......@@ -23,25 +10,21 @@ particleAbility模块用来对Data和Service类型的Ability进行操作
import particleAbility from '@ohos.ability.particleAbility'
```
## particleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void
- 接口说明
使用此方法启动指定的particleAbility(callback形式)
## particleAbility.startAbility
- startAbility参数描述
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void
使用此方法启动指定的particleAbility(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------------------------------------------------- | ---- | ----------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 指示启动的ability |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
**参数:**
- 返回值
void
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 指示启动的ability |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
- 示例
**示例:**
```js
import particleAbility from '@ohos.ability.particleAbility'
......@@ -67,22 +50,23 @@ particleAbility.startAbility(
## particleAbility.startAbility(parameter: StartAbilityParameter): Promise\<number>
## particleAbility.startAbility
- 接口说明
使用此方法启动指定的particleAbility(Promise形式)
startAbility(parameter: StartAbilityParameter): Promise\<number>
使用此方法启动指定的particleAbility(Promise形式)。
- startAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------------------------------------------------- | ---- | ----------------- |
| parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 指示启动的ability |
- 返回值
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 指示启动的ability |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
Promise\<void>
- 示例
**示例:**
```js
import particleAbility from '@ohos.ability.particleAbility'
......@@ -107,23 +91,19 @@ particleAbility.startAbility(
## particleAbility.terminateSelf(callback: AsyncCallback\<void>): void
- 接口说明
终止particleAbility(callback形式)
## particleAbility.terminateSelf
- terminateSelf参数描述
terminateSelf(callback: AsyncCallback\<void>): void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
终止particleAbility(callback形式)。
- 返回值
**参数:**
void
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
**示例:**
```js
import particleAbility from '@ohos.ability.particleAbility'
......@@ -136,17 +116,18 @@ particleAbility.terminateSelf(
## particleAbility.terminateSelf(): Promise\<void>
## particleAbility.terminateSelf
- 接口说明
terminateSelf(): Promise\<void>
终止particleAbility(Promise形式)
终止particleAbility(Promise形式)。
- 返回值
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
Promise\<void>
- 示例
**示例:**
```js
import particleAbility from '@ohos.ability.particleAbility'
......@@ -157,25 +138,25 @@ particleAbility.terminateSelf().then((void) => {
## particleAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper
## particleAbility.acquireDataAbilityHelper
- 接口说明
acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper
获取dataAbilityHelper。
- acquireDataAbilityHelper参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| :--- | -------- | ------ | ---- | ---------------------- |
| uri | 只读 | string | 是 | 指示要打开的文件的路径 |
| 名称 | 类型 | 必填 | 描述 |
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
- 返回值
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------------------------------------ |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
| 类型 | 说明 |
| ----------------- | -------------------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
- 示例
**示例:**
```js
import particleAbility from '@ohos.ability.particleAbility'
......@@ -183,20 +164,20 @@ var uri = "";
particleAbility.acquireDataAbilityHelper(uri)
```
## particleAbility.connectAbility(request: Want, options:ConnectOptions): number
## particleAbility.connectAbility
* 接口说明
connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility(callback形式)
将当前ability连接到指定ServiceAbility(callback形式)。
* connectAbility参数描述
**参数:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------- | -------- | -------------- | ---- | -------------------------- |
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility |
| options | 只读 | ConnectOptions | 是 | 被指定的回调方法 |
| 名称 | 类型 | 必填 | 描述 |
| ------- | -------------- | ---- | -------------------------- |
| request | Want | 是 | 表示被连接的ServiceAbility |
| options | ConnectOptions | 是 | 被指定的回调方法 |
- ConnectOptions类型说明
**ConnectOptions类型说明:**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
......@@ -204,11 +185,12 @@ particleAbility.acquireDataAbilityHelper(uri)
| onDisconnect | 只读 | function | 是 | 断开连接时的回调函数 |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 |
* 返回值
标识一次连接。
**返回值:**
| 类型 | 说明 |
| ------ | -------------------------- |
| number | 标识客户端与服务端的连接。 |
* 示例
**示例:**
```javascript
import particleAbility from '@ohos.ability.particleAbility'
......@@ -234,24 +216,20 @@ var connId = particleAbility.connectAbility(
);
```
## particleAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
* 接口说明
## particleAbility.disconnectAbility
断开与指定ServiceAbility的连接(callback形式)
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
* disconnectAbility参数描述
断开与指定ServiceAbility的连接(callback形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------- | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------- | ---- | ------------------------------ |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
void
* 示例
**示例:**
```javascript
import particleAbility from '@ohos.ability.particleAbility'
......@@ -282,23 +260,24 @@ var result = particleAbility.disconnectAbility(connId,
);
```
## particleAbility.disconnectAbility(connection: number): Promise\<void>
* 接口说明
## particleAbility.disconnectAbility
断开与指定ServiceAbility的连接(promise形式)
disconnectAbility(connection: number): Promise\<void>
* disconnectAbility参数描述
断开与指定ServiceAbility的连接(Promise形式)。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
**参数:**
* 返回值
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | ------------------------------ |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
Promise\<void>
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
* 示例
**示例:**
```javascript
import particleAbility from '@ohos.ability.particleAbility'
......@@ -327,14 +306,14 @@ var result = particleAbility.disconnectAbility(connId).then((void) => {
});
```
## StartAbilityParameter类型说明
## StartAbilityParameter
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
## Want类型说明
## Want
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
......@@ -369,7 +348,7 @@ var result = particleAbility.disconnectAbility(connId).then((void) => {
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部,则将重用该实例。否则,将创建一个新的能力实例。 |
## AbilityStartSetting类型说明
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象,key对应设定类型为:AbilityStartSetting枚举类型,value对应设定类型为:AbilityWindowConfiguration枚举类型。
......@@ -381,7 +360,7 @@ abilityStartSetting属性是一个定义为[key: string]: any的对象,key对
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 |
| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 |
## AbilityWindowConfiguration类型说明
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取,示例:featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
......
......@@ -58,7 +58,6 @@ wait(): Promise&lt;number&gt;
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('ls');
var result = child.wait();
result.then(val=>{
......@@ -80,7 +79,6 @@ getOutput(): Promise&lt;Uint8Array&gt;
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('ls');
var result = child.wait();
child.getOutput.then(val=>{
......@@ -102,7 +100,6 @@ getErrorOutput函数用来获取子进程的标准错误输出。
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('madir test.text');
var result = child.wait();
child.getErrorOutput.then(val=>{
......@@ -119,7 +116,6 @@ close(): void
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('sleep 5; ls');
child.close();
```
......@@ -138,7 +134,6 @@ kill函数用来发送信号给子进程,结束指定进程。
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('sleep 5; ls');
child.kill(9);
```
......@@ -157,7 +152,6 @@ isIsolatedProcess(): boolean
- 示例:
```
import process from '@ohos.process';
var result = process.isIsolatedProcess();
```
......@@ -180,7 +174,6 @@ isAppUid(v:number): boolean
- 示例:
```
import process from '@ohos.process';
var result = process.isAppUid(688);
```
......@@ -198,7 +191,6 @@ is64Bit(): boolean
- 示例:
```
import process from '@ohos.process';
var ressult = process.is64Bit();
```
......@@ -221,7 +213,6 @@ getUidForName(v:string): number
- 示例:
```
import process from '@ohos.process'
var pres = process.getUidForName("tool")
```
......@@ -244,7 +235,6 @@ getThreadPriority(v:number): number
- 示例:
```
import process from '@ohos.process'
var tid = process.getTid();
var pres = process.getThreadPriority(tid);
```
......@@ -263,7 +253,6 @@ getStartRealtime() :number
- 示例:
```
import process from '@ohos.process';
var realtime = process.getStartRealtime();
```
......@@ -281,7 +270,6 @@ getAvailableCores() :number[]
- 示例:
```
import process from '@ohos.process';
var result = getAvailableCores();
```
......@@ -299,7 +287,6 @@ getPastCputime() :number
- 示例:
```
import process from '@ohos.process';
var result = process.getPastCputime() ;
```
......@@ -322,7 +309,6 @@ getSystemConfig(name:number): number
- 示例:
```
import process from '@ohos.process'
var _SC_ARG_MAX = 0
var pres = process.getSystemConfig(_SC_ARG_MAX)
```
......@@ -346,7 +332,6 @@ getEnvironmentVar(name:string): string
- 示例:
```
import process from '@ohos.process'
var pres = process.getEnvironmentVar("PATH")
```
......@@ -378,7 +363,6 @@ runCmd(command: string, options?: { timeout : number, killSignal :number | str
- 示例:
```
import process from '@ohos.process';
var child = process.runCmd('ls', { maxBuffer : 2 });
var result = child.wait();
child.getOutput.then(val=>{
......@@ -395,7 +379,6 @@ abort(): void
- 示例:
```
import process from '@ohos.process';
process.abort();
```
......@@ -420,7 +403,6 @@ on(type: string, listener: EventListener): void
- 示例:
```
import process from '@ohos.process';
process.on("data", (e)=>{
console.log("data callback");
})
......@@ -445,7 +427,6 @@ off(type: string): boolean
- 示例:
```
import process from '@ohos.process';
process.on("data", (e)=>{
console.log("data callback");
})
......@@ -466,7 +447,6 @@ exit(code: number): void
- 示例:
```
import process from '@ohos.process';
process.exit(0);
```
......@@ -479,7 +459,6 @@ cwd(): string
- 示例:
```
import process from '@ohos.process';
var path = process.cwd();
```
......@@ -497,7 +476,6 @@ chdir(dir: string): void
- 示例:
```
import process from '@ohos.process';
process.chdir('/system');
```
......@@ -515,7 +493,6 @@ uptime(): number
- 示例:
```
import process from '@ohos.process';
var time = process.uptime();
```
......@@ -539,7 +516,6 @@ kill(pid: number,signal: number ): boolean
- 示例:
```
import process from '@ohos.process'
var pres = process.pid
var result = that.kill(pres, 28)
```
# ServiceExtensionContext
- [startAbility](#startAbility)
- [startAbility](#startAbility)
- [terminateSelf](#terminateSelf)
- [terminateSelf](#terminateSelf)
- [connectAbility](#connectAbility)
- [disconnectAbility](#disconnectAbility)
- [disconnectAbility](#disconnectAbility)
- [ConnectOptions](#ConnectOptions)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# ServiceExtension
- [导入模块](#导入模块)
- [权限](#权限)
- [属性](#属性)
- [onCreate](#onCreate)
- [onDestroy](#onDestroy)
- [onRequest](#onRequest)
- [onConnect](#onConnect)
- [onDisconnect](#onDisconnect)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
......@@ -27,8 +27,9 @@ createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallba
- 示例
```
let specification = '3gpp';
let pdu = [0x08, 0x91, ...];
const specification = '3gpp';
// 以数组的形式显示协议数据单元(PDU),类型为number,例如[0x08, 0x91, ...]
const pdu = [0x08, 0x91];
sms.createMessage(pdu, specification, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
......@@ -57,8 +58,9 @@ createMessage\(pdu: Array<number\>, specification: string\): Promise<ShortMessag
- 示例
```
let specification = '3gpp';
let pdu = [0x08, 0x91, ...];
const specification = '3gpp';
// 以数组的形式显示协议数据单元(PDU),类型为number,例如[0x08, 0x91, ...]
const pdu = [0x08, 0x91];
let promise = sms.createMessage(pdu, specification);
promise.then(data => {
console.log(`createMessage success, promise: data->${JSON.stringify(data)}`);
......
......@@ -4,13 +4,6 @@
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 支持设备
| 手机 | 平板 | 智慧屏 | 智能穿戴 |
| -------- | -------- | -------- | -------- |
| 支持 | 支持 | 支持 | 支持 |
## 导入模块
```
......
......@@ -57,8 +57,7 @@ worker构造函数。
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js", {name:"first worker"});
const workerInstance = new worker.Worker("workers/worker.js", {name:"first worker"});
```
......@@ -76,13 +75,13 @@ postMessage(message: Object, options?: PostMessageOptions): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js");
worker.postMessage("hello world");
const worker = new worker.Worker("workers/worker.js");
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.postMessage("hello world");
```
```
const workerInstance= new worker.Worker("workers/worker.js");
var buffer = new ArrayBuffer(8);
worker.postMessage(buffer, [buffer]);
workerInstance.postMessage(buffer, [buffer]);
```
......@@ -100,9 +99,8 @@ on(type: string, listener: EventListener): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.on("alert", (e)=>{
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.on("alert", (e)=>{
console.log("alert listener callback");
})
```
......@@ -122,9 +120,8 @@ once(type: string, listener: EventListener): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js");
worker.once("alert", (e)=>{
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.once("alert", (e)=>{
console.log("alert listener callback");
})
```
......@@ -144,9 +141,8 @@ off(type: string, listener?: EventListener): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js");
worker.off("alert");
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.off("alert");
```
......@@ -158,9 +154,8 @@ terminate(): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.terminate()
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.terminate()
```
......@@ -177,9 +172,8 @@ Worker对象的onexit属性表示worker退出时被调用的事件处理程序
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.onexit = function(e) {
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onexit = function(e) {
console.log("onexit")
}
```
......@@ -198,9 +192,8 @@ Worker对象的onerror属性表示worker在执行过程中发生异常被调用
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.onerror = function(e) {
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onerror = function(e) {
console.log("onerror")
}
```
......@@ -219,9 +212,8 @@ Worker对象的onmessage属性表示宿主线程接收到来自其创建的worke
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.onmessage = function(e) {
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onmessage = function(e) {
console.log("onerror")
}
```
......@@ -240,9 +232,8 @@ Worker对象的onmessageerror属性表示当 Worker 对象接收到一条无法
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.onmessageerror= function(e) {
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onmessageerror= function(e) {
console.log("onmessageerror")
}
```
......@@ -265,9 +256,8 @@ addEventListener(type: string, listener: EventListener): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.addEventListener("alert", (e)=>{
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.addEventListener("alert", (e)=>{
console.log("alert listener callback");
})
```
......@@ -287,9 +277,8 @@ removeEventListener(type: string, callback?: EventListener): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.removeEventListener("alert")
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.removeEventListener("alert")
```
......@@ -311,9 +300,8 @@ dispatchEvent(event: Event): boolean
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.dispatchEvent({type:"alert"})
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.dispatchEvent({type:"alert"})
```
......@@ -325,9 +313,8 @@ removeAllListener(): void
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.removeAllListener({type:"alert"})
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.removeAllListener({type:"alert"})
```
......@@ -352,12 +339,13 @@ worker向宿主线程发送消息。
```
// main.js
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.postMessage("hello world")
worker.onmessage = function(e) {
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.postMessage("hello world")
workerInstance.onmessage = function(e) {
console.log("receive data from worker.js")
}
```
```
// worker.js
import worker from "@ohos.worker";
const parentPort = worker.parentPort;
......@@ -377,8 +365,9 @@ close(): void
```
// main.js
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js
import worker from "@ohos.worker";
const parentPort = worker.parentPort;
......@@ -403,9 +392,10 @@ DedicatedWorkerGlobalScope的onmessage属性表示worker线程收到来自其宿
```
// main.js
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
worker.postMessage("hello world")
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.postMessage("hello world")
```
```
// worker.js
import worker from "@ohos.worker";
const parentPort = worker.parentPort;
......@@ -430,8 +420,9 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当 Worker 对象接收
```
// main.js
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js
import worker from "@ohos.worker";
const parentPort = worker.parentPort;
......@@ -481,9 +472,8 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当 Worker 对象接收
- 示例:
```
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js");
worker.addEventListener("alert", (e)=>{
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.addEventListener("alert", (e)=>{
console.log("alert listener callback");
})
```
......@@ -539,8 +529,9 @@ WorkerGlobalScope的onerror属性表示worker在执行过程中发生异常被
```
// main.js
import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js")
const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js
import worker from "@ohos.worker";
const parentPort = worker.parentPort
......
......@@ -33,9 +33,6 @@ XmlSerializer的构造函数。
- 示例:
```
import xml form '@ohos.xml'
new XmlSerializer(buffer: ArrayBuffer | DataView, encoding?: string)
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
......@@ -56,9 +53,6 @@ setAttributes(name: string, value: string):void
- 示例:
```
import xml form '@ohos.xml'
setAttributes(name: string, value: string)
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setAttributes("importance", "high");
```
......@@ -77,10 +71,7 @@ addEmptyElement(name: string): void
- 示例:
```
import xml form '@ohos.xml'
addEmptyElement(name: string): void
var thatSer = new xml.XmlSerializer(bufView);
var thatSer = new xml.XmlSerializer(bufView);
thatSer.addEmptyElement("b"); // => <b/>
```
......@@ -93,9 +84,6 @@ setDeclaration(): void
- 示例:
```
import xml form '@ohos.xml'
setDeclaration():void
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setDeclaration() // => <?xml version="1.0" encoding="utf-8"?>;
```
......@@ -114,9 +102,6 @@ XmlSerializer的构造函数。
- 示例:
```
import xml form '@ohos.xml'
startElement(name:string):void
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("notel");
......@@ -132,9 +117,6 @@ endElement(): void
- 示例:
```
import xml form '@ohos.xml'
endElement()
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("table");
......@@ -158,9 +140,6 @@ setNamespace(prefix: string, namespace: string): void
- 示例:
```
import xml form '@ohos.xml'
setNamespace(prefix:string,namespace:string):void
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDeclaration();
......@@ -182,9 +161,6 @@ setCommnet(text: string): void
- 示例:
```
import xml form '@ohos.xml'
setCommnet(text: string):void
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
......@@ -206,9 +182,6 @@ setCData(text: string): void
- 示例:
```
import xml form '@ohos.xml'
setCData(text: string) :void
var arrayBuffer = new ArrayBuffer(1028);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setCData('root SYSTEM') // => '<![CDATA[root SYSTEM]]>';
......@@ -228,9 +201,6 @@ setText(text: string): void
- 示例:
```
import xml form '@ohos.xml'
setText(text: string): void
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
......@@ -253,9 +223,6 @@ setDocType(text: string): void
- 示例:
```
import xml form '@ohos.xml'
setDocType(text: string):void
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDocType('root SYSTEM'); // => '<!DOCTYPE root SYSTEM>';
......@@ -279,9 +246,6 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string)
- 示例:
```
import xml form '@ohos.xml'
new (buffer: ArrayBuffer | DataView, encoding?: string)
var strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -312,9 +276,6 @@ parse(option: ParseOptions): void
- 示例:
```
import xml form '@ohos.xml'
parse(option: ParseOptions): void
var strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......
......@@ -5,29 +5,6 @@
步骤导航器。
## 支持设备<a name="section322851519172"></a>
<table><thead align="left"><tr><th class="cellrowborder" valign="top" width="23.66106080206986%" id="mcps1.1.5.1.1"><p>手机</p>
</th>
<th class="cellrowborder" valign="top" width="26.3130659767141%" id="mcps1.1.5.1.2"><p>平板</p>
</th>
<th class="cellrowborder" valign="top" width="24.63130659767141%" id="mcps1.1.5.1.3"><p>智慧屏</p>
</th>
<th class="cellrowborder" valign="top" width="25.39456662354463%" id="mcps1.1.5.1.4"><p>智能穿戴</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="23.66106080206986%" headers="mcps1.1.5.1.1 "><p>支持</p>
</td>
<td class="cellrowborder" valign="top" width="26.3130659767141%" headers="mcps1.1.5.1.2 "><p>支持</p>
</td>
<td class="cellrowborder" valign="top" width="24.63130659767141%" headers="mcps1.1.5.1.3 "><p>不支持</p>
</td>
<td class="cellrowborder" valign="top" width="25.39456662354463%" headers="mcps1.1.5.1.4 "><p>不支持</p>
</td>
</tr>
</tbody>
</table>
## 权限列表<a name="section988262631714"></a>
......
......@@ -5,29 +5,6 @@
步骤导航器元素。
## 支持设备<a name="section322851519172"></a>
<table><thead align="left"><tr><th class="cellrowborder" valign="top" width="23.66106080206986%" id="mcps1.1.5.1.1"><p>手机</p>
</th>
<th class="cellrowborder" valign="top" width="26.3130659767141%" id="mcps1.1.5.1.2"><p>平板</p>
</th>
<th class="cellrowborder" valign="top" width="24.63130659767141%" id="mcps1.1.5.1.3"><p>智慧屏</p>
</th>
<th class="cellrowborder" valign="top" width="25.39456662354463%" id="mcps1.1.5.1.4"><p>智能穿戴</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="23.66106080206986%" headers="mcps1.1.5.1.1 "><p>支持</p>
</td>
<td class="cellrowborder" valign="top" width="26.3130659767141%" headers="mcps1.1.5.1.2 "><p>支持</p>
</td>
<td class="cellrowborder" valign="top" width="24.63130659767141%" headers="mcps1.1.5.1.3 "><p>不支持</p>
</td>
<td class="cellrowborder" valign="top" width="25.39456662354463%" headers="mcps1.1.5.1.4 "><p>不支持</p>
</td>
</tr>
</tbody>
</table>
## 权限列表<a name="section53281531154915"></a>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册