未验证 提交 bcf8c182 编写于 作者: O openharmony_ci 提交者: Gitee

!6038 Updata master by cherry-pick of ability

Merge pull request !6038 from yuyaozhi/master
...@@ -278,7 +278,7 @@ terminateSelf(): Promise<void>; ...@@ -278,7 +278,7 @@ terminateSelf(): Promise<void>;
**示例:** **示例:**
```js ```js
this.context.terminateSelf(want).then((data) => { this.context.terminateSelf().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
......
# AbilityManager
AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口均为系统接口,三方应用不支持调用。
# 导入模块
```js
import AbilityManager from '@ohos.application.abilityManager'
```
## AbilityState
Ability的状态信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。|
| FOREGROUND | 9 | 表示ability为foreground状态。 |
| BACKGROUND | 10 | 表示ability为background状态。 |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 |
## updateConfiguration
updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
通过修改配置来更新配置(callback形式)。
**需要权限**: ohos.permission.UPDATE_CONFIGURATION
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | Configuration | 是 | 新的配置项。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
var config = {
language: 'chinese'
}
abilitymanager.updateConfiguration(config, () => {
console.log('------------ updateConfiguration -----------');
})
```
## updateConfiguration
updateConfiguration(config: Configuration): Promise\<void>
通过修改配置来更新配置(Promise形式)。
**需要权限**: ohos.permission.UPDATE_CONFIGURATION
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | Configuration | 是 | 新的配置项。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<void> | 返回执行结果。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
var config = {
language: 'chinese'
}
abilitymanager.updateConfiguration(config).then(() => {
console.log('updateConfiguration success');
}).catch((err) => {
console.log('updateConfiguration fail');
})
```
## getAbilityRunningInfos
getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
获取Ability运行相关信息(callback形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## getAbilityRunningInfos
getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
获取Ability运行相关信息(Promise形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos().then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data))
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err)
});
```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void
获取关于运行扩展能力的信息(callback形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
获取关于运行扩展能力的信息(Promise形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err);
})
```
## getTopAbility<sup>9+</sup>
getTopAbility(callback: AsyncCallback\<ElementName>): void;
新增获取窗口焦点的ability接口(callback形式)。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility((err,data) => {
console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data));
});
```
## getTopAbility<sup>9+</sup>
getTopAbility(): Promise\<ElementName>;
新增获取窗口焦点的ability接口(Promise形式)。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<ElementName>| 返回执行结果。 |
**示例**
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility().then((data) => {
console.log("getTopAbility data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getTopAbility err: " + err);
})
```
\ No newline at end of file
...@@ -27,6 +27,8 @@ abilitymanager.getAbilityRunningInfos((err,data) => { ...@@ -27,6 +27,8 @@ abilitymanager.getAbilityRunningInfos((err,data) => {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**:该接口为系统接口,三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 否 | Ability匹配信息 | | ability | ElementName | 是 | 否 | Ability匹配信息 |
...@@ -43,6 +45,8 @@ Ability的状态信息。 ...@@ -43,6 +45,8 @@ Ability的状态信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**:该接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。| | INITIAL | 0 | 表示ability为initial状态。|
......
...@@ -15,7 +15,7 @@ import StartOptions from '@ohos.application.StartOptions'; ...@@ -15,7 +15,7 @@ import StartOptions from '@ohos.application.StartOptions';
## 属性 ## 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 | | 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- | -------- |
......
...@@ -42,6 +42,53 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** ...@@ -42,6 +42,53 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
| ------ | ------------------------------ | | ------ | ------------------------------ |
| number | 返回的此次注册监听生命周期的id(每次注册该id会自增+1,当超过监听上限数量2^63-1时,返回-1)| | number | 返回的此次注册监听生命周期的id(每次注册该id会自增+1,当超过监听上限数量2^63-1时,返回-1)|
**示例:**
```js
import AbilityStage from "@ohos.application.AbilityStage";
var lifecycleid;
export default class MyAbilityStage extends AbilityStage {
onCreate() {
console.log("MyAbilityStage onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
onAbilityWindowStageCreate(ability){
console.log("AbilityLifecycleCallback onAbilityWindowStageCreate ability:" + JSON.stringify(ability));
},
onAbilityWindowStageDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityWindowStageDestroy ability:" + JSON.stringify(ability));
},
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid));
}
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
```
## ApplicationContext.unregisterAbilityLifecycleCallback ## ApplicationContext.unregisterAbilityLifecycleCallback
...@@ -61,47 +108,10 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb ...@@ -61,47 +108,10 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb
**示例:** **示例:**
```js ```js
import AbilityStage from "@ohos.application.AbilityStage"; let applicationContext = this.context.getApplicationContext();
let lifecycleid=1
var lifecycleid; console.log("stage applicationContext: " + JSON.stringify(applicationContext));
applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => {
export default class MyAbilityStage extends AbilityStage { console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
onCreate() { });
console.log("MyAbilityStage onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
onAbilityWindowStageCreate(ability){
console.log("AbilityLifecycleCallback onAbilityWindowStageCreate ability:" + JSON.stringify(ability));
},
onAbilityWindowStageDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityWindowStageDestroy ability:" + JSON.stringify(ability));
},
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid));
}
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
}
}
``` ```
...@@ -18,7 +18,9 @@ onReceiveEvent(event: CommonEventData): void; ...@@ -18,7 +18,9 @@ onReceiveEvent(event: CommonEventData): void;
静态订阅者通用事件回调。 静态订阅者通用事件回调。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**:该接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
......
...@@ -163,6 +163,8 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>; ...@@ -163,6 +163,8 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。 获取有关运行进程的信息。
**需要权限**:ohos.permission.GET_RUNNING_INFO
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**返回值:** **返回值:**
...@@ -187,6 +189,8 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo ...@@ -187,6 +189,8 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
获取有关运行进程的信息。 获取有关运行进程的信息。
**需要权限**:ohos.permission.GET_RUNNING_INFO
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**参数:** **参数:**
...@@ -210,7 +214,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo ...@@ -210,7 +214,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid<sup>8+</sup> | 只读 | number | 否 | 进程ID。 | | pid<sup>9+</sup> | 只读 | number | 否 | 进程ID。 |
| uid<sup>8+</sup> | 只读 | number | 否 | 用户ID。 | | uid<sup>9+</sup> | 只读 | number | 否 | 用户ID。 |
| processName<sup>8+</sup> | 只读 | string | 否 | 进程的名称。 | | processName<sup>9+</sup> | 只读 | string | 否 | 进程的名称。 |
| bundleNames<sup>8+</sup> | 只读 | Array\<string> | 否 | 进程中运行的bundleName数组。 | | bundleNames<sup>9+</sup> | 只读 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
...@@ -12,7 +12,7 @@ ExtensionContext模块提供扩展的上下文的能力,包括允许访问特 ...@@ -12,7 +12,7 @@ ExtensionContext模块提供扩展的上下文的能力,包括允许访问特
## 导入模块 ## 导入模块
```js ```js
import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility'; import FormExtension from '@ohos.application.FormExtension';
``` ```
## 属性 ## 属性
......
...@@ -38,24 +38,4 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { ...@@ -38,24 +38,4 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
| processName | string | 是 | 否 | 进程名称。 | | processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Extension启动时间。 | | startTime | number | 是 | 否 | Extension启动时间。 |
| clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 | | clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 |
| type | [bundle.ExtensionAbilityType](#bundleextensionabilitytype) | 是 | 否 | Extension类型。 | | type | [bundle.ExtensionAbilityType](js-apis-Bundle.md#extensionabilitytype9) | 是 | 否 | Extension类型。 |
\ No newline at end of file
## bundle.ExtensionAbilityType
Extension类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| FORM | 0 | 表示带有form类型的扩展信息。< |
| WORK_SCHEDULER | 1 | 表示带有work&nbsp;scheduler类型的扩展信息。< |
| INPUT_METHOD | 2 | 表示用输入法类型的扩展信息。< |
| SERVICE | 3 | 表示带有service类型的扩展信息。< |
| ACCESSIBILITY | 4 | 表示具有可访问性类型的扩展信息。< |
| DATA_SHARE | 5 | 表示带有datashare类型的扩展信息。< |
| FILE_SHARE | 6 | 表示带有fileshare类型的扩展信息。< |
| STATIC_SUBSCRIBER | 7 | 表示带有静态订阅者类型的扩展信息。< |
| WALLPAPER | 8 | 表示带有wallpaper类型的扩展信息。< |
| UNSPECIFIED | 9 | 表示未指定类型信息。< |
...@@ -656,8 +656,10 @@ var connId = featureAbility.connectAbility( ...@@ -656,8 +656,10 @@ var connId = featureAbility.connectAbility(
}, },
); );
featureAbility.disconnectAbility(connId).then((error,data) => { featureAbility.disconnectAbility(connId).then((data) => {
console.log('featureAbilityTest result errCode : ' + error.code + " data: " + data); console.log('data : ' + data);
}).catch((error)=>{
console.log('featureAbilityTest result errCode : ' + error.code);
}); });
``` ```
...@@ -916,7 +918,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -916,7 +918,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
## StartAbilityParameter ## StartAbilityParameter
**系统能力**:以下各项对应的系统能力均为SystemCapability.AbilityRuntime.FAModel **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | ---- | -------------------- | ---- | -------------------------------------- | | ------------------- | ---- | -------------------- | ---- | -------------------------------------- |
......
...@@ -20,98 +20,98 @@ import formInfo from '@ohos.application.formInfo'; ...@@ -20,98 +20,98 @@ import formInfo from '@ohos.application.formInfo';
卡片信息 卡片信息
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 | | 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 表示卡片所属包的包名 | | bundleName | 只读 | string | 表示卡片所属包的包名 |
| moduleName | 只读 | string | 表示卡片所属模块的模块名 | | moduleName | 只读 | string | 表示卡片所属模块的模块名 |
| abilityName | 只读 | string | 表示卡片所属的Ability名称 | | abilityName | 只读 | string | 表示卡片所属的Ability名称 |
| name | 只读 | string | 表示卡片名称 | | name | 只读 | string | 表示卡片名称 |
| description | 只读 | string | 表示卡片描述 | | description | 只读 | string | 表示卡片描述 |
| type | 只读 | [FormType](#formtype) | 表示卡片类型,当前支持JS卡片 | | type | 只读 | [FormType](#formtype) | 表示卡片类型,当前支持JS卡片 |
| jsComponentName | 只读 | string | 表示js卡片的组件名 | | jsComponentName | 只读 | string | 表示js卡片的组件名 |
| colorMode | 只读 | [ColorMode](#colormode) | 表示卡片颜色模式 | | colorMode | 只读 | [ColorMode](#colormode) | 表示卡片颜色模式 |
| isDefault | 只读 | boolean | 表示是否是默认卡片 | | isDefault | 只读 | boolean | 表示是否是默认卡片 |
| updateEnabled | 只读 | boolean | 表示卡片是否使能更新 | | updateEnabled | 只读 | boolean | 表示卡片是否使能更新 |
| formVisibleNotify | 只读 | string | 表示卡片是否使能可见通知 | | formVisibleNotify | 只读 | string | 表示卡片是否使能可见通知 |
| relatedBundleName | 只读 | string | 表示卡片所属的相关联包名 | | relatedBundleName | 只读 | string | 表示卡片所属的相关联包名 |
| scheduledUpdateTime | 只读 | string | 表示卡片更新时间 | | scheduledUpdateTime | 只读 | string | 表示卡片更新时间 |
| formConfigAbility | 只读 | string | 表示卡片配置ability | | formConfigAbility | 只读 | string | 表示卡片配置ability |
| updateDuration | 只读 | string | 表示卡片更新周期 | | updateDuration | 只读 | string | 表示卡片更新周期 |
| defaultDimension | 只读 | number | 表示卡片规格 | | defaultDimension | 只读 | number | 表示卡片规格 |
| supportDimensions | 只读 | Array&lt;number&gt; | 表示卡片支持的规格 | | supportDimensions | 只读 | Array&lt;number&gt; | 表示卡片支持的规格 |
| customizeData | 只读 | {[key: string]: [value: string]} | 表示卡片用户数据 | | customizeData | 只读 | {[key: string]: [value: string]} | 表示卡片用户数据 |
## FormType ## FormType
枚举,支持的卡片类型。 枚举,支持的卡片类型。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| JS | 1 | 卡片类型为JS | | JS | 1 | 卡片类型为JS |
## ColorMode ## ColorMode
枚举,卡片支持的颜色模式。 枚举,卡片支持的颜色模式。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| MODE_AUTO | -1 | 自动模式 | | MODE_AUTO | -1 | 自动模式 |
| MODE_DARK | 0 | 暗色 | | MODE_DARK | 0 | 暗色 |
| MODE_LIGHT | 1 | 亮色 | | MODE_LIGHT | 1 | 亮色 |
## FormStateInfo ## FormStateInfo
卡片状态信息。 卡片状态信息。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 | | 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 只读 | [FormState](#formstate) | 表示卡片状态 | | formState | 只读 | [FormState](#formstate) | 表示卡片状态 |
| want | 只读 | Want | Want文本内容 | | want | 只读 | Want | Want文本内容 |
## FormState ## FormState
枚举,卡片状态。 枚举,卡片状态。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| UNKNOWN | -1 | 未知状态 | | UNKNOWN | -1 | 未知状态 |
| DEFAULT | 0 | 默认状态 | | DEFAULT | 0 | 默认状态 |
| READY | 1 | 就绪状态 | | READY | 1 | 就绪状态 |
## FormParam ## FormParam
枚举,卡片参数。 枚举,卡片参数。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form SystemCapability.Ability.Form
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------- | ---- | ------------ | | ----------- | ---- | ------------ |
| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识 | | IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
| DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式 | | DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式。 |
| NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称 | | NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称。 |
| MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称 | | MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 |
| WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度 | | WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 |
| HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度 | | HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 |
| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片 | | TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 |
\ No newline at end of file \ No newline at end of file
...@@ -242,11 +242,11 @@ onAcquireFormState?(want: Want): formInfo.FormState; ...@@ -242,11 +242,11 @@ onAcquireFormState?(want: Want): formInfo.FormState;
**示例:** **示例:**
```js ```js
import fromInfo from '@ohos.application.fromInfo' import formInfo from '@ohos.application.formInfo'
class MyFormExtension extends FormExtension { class MyFormExtension extends FormExtension {
onAcquireFormState(want) { onAcquireFormState(want) {
console.log('FormExtension onAcquireFormState, want:' + want); console.log('FormExtension onAcquireFormState, want:' + want);
return fromInfo.FormState.UNKNOWN; return formInfo.FormState.UNKNOWN;
} }
} }
``` ```
\ No newline at end of file
...@@ -24,9 +24,11 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -24,9 +24,11 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void;
删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。 删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -52,9 +54,11 @@ deleteForm(formId: string): Promise&lt;void&gt;; ...@@ -52,9 +54,11 @@ deleteForm(formId: string): Promise&lt;void&gt;;
删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。 删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -85,9 +89,11 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -85,9 +89,11 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。 释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -113,9 +119,11 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt; ...@@ -113,9 +119,11 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。 释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -142,9 +150,11 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;; ...@@ -142,9 +150,11 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。 释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -176,9 +186,11 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -176,9 +186,11 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void;
请求卡片更新。 请求卡片更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -204,9 +216,11 @@ requestForm(formId: string): Promise&lt;void&gt;; ...@@ -204,9 +216,11 @@ requestForm(formId: string): Promise&lt;void&gt;;
请求卡片更新。 请求卡片更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -237,9 +251,11 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -237,9 +251,11 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void;
将指定的临时卡片转换为普通卡片。 将指定的临时卡片转换为普通卡片。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -265,9 +281,11 @@ castTempForm(formId: string): Promise&lt;void&gt;; ...@@ -265,9 +281,11 @@ castTempForm(formId: string): Promise&lt;void&gt;;
将指定的临时卡片转换为普通卡片。 将指定的临时卡片转换为普通卡片。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -298,9 +316,11 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -298,9 +316,11 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。 向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -326,9 +346,11 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;; ...@@ -326,9 +346,11 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;;
向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。 向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -359,9 +381,11 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo ...@@ -359,9 +381,11 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。 向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -387,9 +411,11 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;; ...@@ -387,9 +411,11 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;;
向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。 向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -420,9 +446,11 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void& ...@@ -420,9 +446,11 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。 向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -448,9 +476,11 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;; ...@@ -448,9 +476,11 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;;
向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。 向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -481,9 +511,11 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -481,9 +511,11 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。 向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -509,9 +541,11 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;; ...@@ -509,9 +541,11 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;;
向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。 向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -542,9 +576,9 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void; ...@@ -542,9 +576,9 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void;
检查系统是否准备好。 检查系统是否准备好。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -569,9 +603,9 @@ isSystemReady(): Promise&lt;void&gt;; ...@@ -569,9 +603,9 @@ isSystemReady(): Promise&lt;void&gt;;
检查系统是否准备好。 检查系统是否准备好。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:** **返回值:**
...@@ -596,9 +630,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): ...@@ -596,9 +630,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
获取设备上所有应用提供的卡片信息。 获取设备上所有应用提供的卡片信息。
**系统能力:** **需要权限**:ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -625,9 +661,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;; ...@@ -625,9 +661,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;;
获取设备上所有应用提供的卡片信息。 获取设备上所有应用提供的卡片信息。
**系统能力:** **需要权限**:ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:** **返回值:**
...@@ -652,9 +690,11 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -652,9 +690,11 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
**系统能力:** **需要权限**:ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -682,9 +722,11 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -682,9 +722,11 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
**系统能力:** **需要权限**:ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -713,9 +755,11 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -713,9 +755,11 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
**系统能力:** **需要权限**:ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -746,9 +790,11 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb ...@@ -746,9 +790,11 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
根据列表删除应用程序的无效卡片。 根据列表删除应用程序的无效卡片。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -776,9 +822,11 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;; ...@@ -776,9 +822,11 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;;
根据列表删除应用程序的无效卡片。 根据列表删除应用程序的无效卡片。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -809,9 +857,11 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -809,9 +857,11 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
获取卡片状态 获取卡片状态
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM和ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -848,6 +898,12 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;; ...@@ -848,6 +898,12 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;;
获取卡片状态。 获取卡片状态。
**需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -860,10 +916,6 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;; ...@@ -860,10 +916,6 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;;
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | Promise实例,用于返回卡片状态 | | Promise&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | Promise实例,用于返回卡片状态 |
**系统能力:**
SystemCapability.Ability.Form
**示例:** **示例:**
```js ```js
...@@ -890,9 +942,9 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void; ...@@ -890,9 +942,9 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void;
订阅卡片卸载事件。 订阅卡片卸载事件。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -916,9 +968,9 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void; ...@@ -916,9 +968,9 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void;
取消订阅卡片卸载事件。 取消订阅卡片卸载事件。
**系统能力:** **系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -942,9 +994,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A ...@@ -942,9 +994,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
通知卡片是否可见。 通知卡片是否可见。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -971,9 +1025,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt ...@@ -971,9 +1025,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
通知卡片是否可见。 通知卡片是否可见。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -1005,9 +1061,11 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c ...@@ -1005,9 +1061,11 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
通知卡片是否启用更新状态。 通知卡片是否启用更新状态。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
...@@ -1034,9 +1092,11 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean): ...@@ -1034,9 +1092,11 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
通知卡片是否启用更新状态。 通知卡片是否启用更新状态。
**系统能力:** **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
SystemCapability.Ability.Form **系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
......
...@@ -22,8 +22,12 @@ registerMissionListener(listener: MissionListener): number; ...@@ -22,8 +22,12 @@ registerMissionListener(listener: MissionListener): number;
注册系统任务状态监听。 注册系统任务状态监听。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -58,8 +62,12 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt ...@@ -58,8 +62,12 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt
取消任务状态监听。 取消任务状态监听。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -92,8 +100,12 @@ unregisterMissionListener(listenerId: number): Promise&lt;void&gt;; ...@@ -92,8 +100,12 @@ unregisterMissionListener(listenerId: number): Promise&lt;void&gt;;
取消任务状态监听,以promise方式返回执行结果。 取消任务状态监听,以promise方式返回执行结果。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -131,8 +143,12 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M ...@@ -131,8 +143,12 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M
获取任务信息,以异步回调的方式返回任务信息。 获取任务信息,以异步回调的方式返回任务信息。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -165,8 +181,12 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;; ...@@ -165,8 +181,12 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;;
获取任务信息,以promise方式返回任务信息。 获取任务信息,以promise方式返回任务信息。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -197,8 +217,12 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr ...@@ -197,8 +217,12 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr
获取所有任务信息,以回调函数的方式返回任务信息数组。 获取所有任务信息,以回调函数的方式返回任务信息数组。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -226,8 +250,12 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn ...@@ -226,8 +250,12 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn
获取所有任务信息,以promise的方式返回任务信息数组。 获取所有任务信息,以promise的方式返回任务信息数组。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -258,8 +286,12 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback& ...@@ -258,8 +286,12 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback&
获取任务快照,以回调函数的方式返回快照内容。 获取任务快照,以回调函数的方式返回快照内容。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -293,8 +325,12 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps ...@@ -293,8 +325,12 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps
获取任务快照,以promise的方式返回快照内容。 获取任务快照,以promise的方式返回快照内容。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -333,8 +369,12 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -333,8 +369,12 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
锁定指定任务id的任务,以回调函数的方式返回。 锁定指定任务id的任务,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -366,8 +406,12 @@ lockMission(missionId: number): Promise&lt;void&gt;; ...@@ -366,8 +406,12 @@ lockMission(missionId: number): Promise&lt;void&gt;;
锁定指定任务id的任务,以promise方式返回。 锁定指定任务id的任务,以promise方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -404,8 +448,12 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -404,8 +448,12 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
解锁指定任务id的任务,以回调函数的方式返回。 解锁指定任务id的任务,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -437,8 +485,12 @@ unlockMission(missionId: number): Promise&lt;void&gt;; ...@@ -437,8 +485,12 @@ unlockMission(missionId: number): Promise&lt;void&gt;;
解锁指定任务id的任务,以promise的方式返回。 解锁指定任务id的任务,以promise的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -479,8 +531,12 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -479,8 +531,12 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
清理指定任务id的任务,无论该任务是否被锁定,以回调函数的方式返回。 清理指定任务id的任务,无论该任务是否被锁定,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -512,8 +568,12 @@ clearMission(missionId: number): Promise&lt;void&gt;; ...@@ -512,8 +568,12 @@ clearMission(missionId: number): Promise&lt;void&gt;;
清理指定任务id的任务,无论该任务是否被锁定,以promise的方式返回。 清理指定任务id的任务,无论该任务是否被锁定,以promise的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -551,8 +611,12 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void; ...@@ -551,8 +611,12 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
清理所有未锁定的任务,以回调函数的方式返回。 清理所有未锁定的任务,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**示例:** **示例:**
```js ```js
...@@ -570,8 +634,12 @@ clearAllMissions(): Promise&lt;void&gt;; ...@@ -570,8 +634,12 @@ clearAllMissions(): Promise&lt;void&gt;;
清理所有未锁定的任务,以promise的方式返回。 清理所有未锁定的任务,以promise的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -594,8 +662,12 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -594,8 +662,12 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void
把指定任务id的任务切到前台,以回调函数的方式返回。 把指定任务id的任务切到前台,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -627,8 +699,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall ...@@ -627,8 +699,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall
把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以回调函数的方式返回。 把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以回调函数的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -661,8 +737,12 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -661,8 +737,12 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以promise的方式返回。 把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以promise的方式返回。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -698,7 +778,9 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -698,7 +778,9 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
表示Ability对应任务信息的枚举。 表示Ability对应任务信息的枚举。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口,三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
......
...@@ -4,7 +4,7 @@ PermissionRequestResult模块提供了权限请求结果的能力。 ...@@ -4,7 +4,7 @@ PermissionRequestResult模块提供了权限请求结果的能力。
> **说明:** > **说明:**
> >
> 本模块首批接口从API 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
......
...@@ -21,6 +21,8 @@ import ServiceExtension from '@ohos.application.ServiceExtensionAbility'; ...@@ -21,6 +21,8 @@ import ServiceExtension from '@ohos.application.ServiceExtensionAbility';
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 | | context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
...@@ -34,6 +36,8 @@ Extension生命周期回调,在创建时回调,执行初始化业务逻辑 ...@@ -34,6 +36,8 @@ Extension生命周期回调,在创建时回调,执行初始化业务逻辑
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -59,6 +63,8 @@ Extension生命周期回调,在销毁时回调,执行资源清理等操作 ...@@ -59,6 +63,8 @@ Extension生命周期回调,在销毁时回调,执行资源清理等操作
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**示例:** **示例:**
```js ```js
...@@ -78,6 +84,8 @@ Extension生命周期回调,如果是startAbility拉起的服务,会在onCre ...@@ -78,6 +84,8 @@ Extension生命周期回调,如果是startAbility拉起的服务,会在onCre
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -104,6 +112,8 @@ Extension生命周期回调,如果是connectAbility拉起的服务,会在onC ...@@ -104,6 +112,8 @@ Extension生命周期回调,如果是connectAbility拉起的服务,会在onC
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -144,6 +154,8 @@ Extension的生命周期,断开服务连接时回调。 ...@@ -144,6 +154,8 @@ Extension的生命周期,断开服务连接时回调。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -159,3 +171,77 @@ Extension的生命周期,断开服务连接时回调。 ...@@ -159,3 +171,77 @@ Extension的生命周期,断开服务连接时回调。
} }
} }
``` ```
## ServiceExtensionAbility.onReconnect
onReconnect(want: Want): void;
当新客户端在所有以前的客户端连接之后尝试连接到服务扩展时调用
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
```js
class ServiceExt extends ServiceExtension {
onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName);
}
}
```
## ServiceExtensionAbility.onReconnect
onConfigurationUpdated(config: Configuration): void;
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例:**
```js
class myAbility extends Ability {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
## ServiceExtensionAbility.dump
dump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array\<string> | 是 | 表示命令形式的参数。|
**示例:**
```js
class myAbility extends Ability {
dump(params) {
console.log('dump, params:' + JSON.stringify(params));
return ["params"]
}
}
```
...@@ -23,6 +23,8 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; ...@@ -23,6 +23,8 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -56,6 +58,8 @@ startAbility(want: Want): Promise&lt;void&gt;; ...@@ -56,6 +58,8 @@ startAbility(want: Want): Promise&lt;void&gt;;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -98,6 +102,8 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void; ...@@ -98,6 +102,8 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -128,6 +134,8 @@ terminateSelf(): Promise&lt;void&gt;; ...@@ -128,6 +134,8 @@ terminateSelf(): Promise&lt;void&gt;;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -159,6 +167,8 @@ connectAbility(want: Want, options: ConnectOptions): number; ...@@ -159,6 +167,8 @@ connectAbility(want: Want, options: ConnectOptions): number;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -196,6 +206,8 @@ disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void; ...@@ -196,6 +206,8 @@ disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -229,6 +241,8 @@ disconnectAbility(connection: number): Promise&lt;void&gt;; ...@@ -229,6 +241,8 @@ disconnectAbility(connection: number): Promise&lt;void&gt;;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
...@@ -27,10 +27,11 @@ onPrepare(): void ...@@ -27,10 +27,11 @@ onPrepare(): void
**示例:** **示例:**
```js ```js
export default class UserTestRunner extends TestRunner { export default class UserTestRunner implements TestRunner {
onPrepare() { onPrepare() {
console.log("Trigger onPrepare") console.log("Trigger onPrepare")
} }
onRun(){}
}; };
``` ```
...@@ -47,9 +48,10 @@ onRun(): void ...@@ -47,9 +48,10 @@ onRun(): void
**示例:** **示例:**
```js ```js
export default class UserTestRunner extends TestRunner { export default class UserTestRunner implements TestRunner {
onRun() { onPrepare() {
console.log("Trigger onRun") console.log("Trigger onRun")
} }
onRun(){}
}; };
``` ```
...@@ -76,7 +76,7 @@ SystemCapability.Ability.AbilityRuntime.Core ...@@ -76,7 +76,7 @@ SystemCapability.Ability.AbilityRuntime.Core
import WantConstant from '@ohos.ability.wantConstant'; import WantConstant from '@ohos.ability.wantConstant';
let accessTokenId =1 let accessTokenId =1
let uri = "fileshare:///com.samples.filesharetest.FileShare/person/10" let uri = "fileshare:///com.samples.filesharetest.FileShare/person/10"
UriPermissionManager.verifyUriPermission(uri, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, accessTokenId) UriPermissionManager.verifyUriPermission(uri, WantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, accessTokenId)
.then((data) => { .then((data) => {
console.log('Verification succeeded.' + data) console.log('Verification succeeded.' + data)
}).catch((error) => { }).catch((error) => {
......
...@@ -420,6 +420,8 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void ...@@ -420,6 +420,8 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
...@@ -492,6 +494,8 @@ getWant(agent: WantAgent): Promise\<Want\> ...@@ -492,6 +494,8 @@ getWant(agent: WantAgent): Promise\<Want\>
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core **系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**参数:** **参数:**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册