# FeatureAbility模块 ## 支持设备 | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ | | FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.hasWindowFocus(callback: AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.hasWindowFocus(): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getWant(callback: AsyncCallback\) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getWant(): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getContext(): Context | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelf(callback: AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelf(): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.disconnectAbility(connection: number): Promise\ | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | ## 使用限制 FeatureAbility模块的接口只能在Page类型的Ability调用 ## 导入模块 ``` import featureAbility from '@ohos.ability.featureAbility' ``` ## FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void * 接口说明 启动新的ability(callback形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | --------------------- | ---- | ------------------- | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | - 返回值 - 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' featureAbility.startAbility( { want: { action: "", entities: [""], type: "", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: "", bundleName: "com.example.startability", abilityName: "com.example.startability.MainAbility", uri: "" }, }, ); ) ``` ## FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\ * 接口说明 启动新的ability(Promise形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability | - 返回值 - 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' featureAbility.startAbility( { want: { entities: ["entity.system.home"], type: "MIMETYPE", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: deviceId, bundleName: "com.example.startability", abilityName: "com.example.startability.MainAbility", uri: "" }, } ).then((void) => { console.info("==========================>startAbility=======================>"); }); ``` ## FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper * 接口说明 获取dataAbilityHelper * 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---- | -------- | ------ | ---- | ---------------------- | | uri | 只读 | string | 是 | 指示要打开的文件的路径 | * 返回值 | 类型 | 说明 | | ----------------- | ------------------------------------------ | | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 | * 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' featureAbility.acquireDataAbilityHelper( "dataability:///com.exmaple.DataAbility" ) ``` ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void * 接口说明 启动一个ability,并在该ability被销毁时返回执行结果(callback形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | ---------------------- | ---- | ------------------- | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability | | callback | 只读 | AsyncCallback\<[AbilityResult](#AbilityResult类型说明)> | 是 | 被指定的回调方法 | * 返回值 [AbilityResult](#AbilityResult类型说明) * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.startAbilityForResult( { want: { action: "action.system.home", entities: ["entity.system.home"], type: "MIMETYPE", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: "", bundleName: "com.example.featureabilitytest", abilityName: "com.example.featureabilitytest.MainAbility", uri:"" }, }, ) ``` ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\ * 接口说明 启动一个ability,并在该ability被销毁时返回执行结果(Promise形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability | * 返回值 [AbilityResult](#AbilityResult类型说明) * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.startAbilityForResult( { want: { action: "action.system.home", entities: ["entity.system.home"], type: "MIMETYPE", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: "", bundleName: "com.example.featureabilitytest", abilityName: "com.example.featureabilitytest.MainAbility", uri:"", parameters: { mykey0: 1111, mykey1: [1, 2, 3], mykey2: "[1, 2, 3]", mykey3: "xxxxxxxxxxxxxxxxxxxxxx", mykey4: [1, 15], mykey5: [false, true, false], mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], mykey7: true, }, }, requestCode: 2, }, ).then((void) => { console.info("==========================>startAbilityForResult=======================>"); }); ``` ## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void * 接口说明 设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(callback形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | ------------- | ---- | ------------------- | | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' featureAbility.terminateSelfWithResult( { resultCode: 1, want: { action: "action.system.home", entities: ["entity.system.home"], type: "MIMETYPE", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: "", bundleName: "com.example.featureabilitytest", abilityName: "com.example.featureabilitytest.MainAbility", uri:"", parameters: { mykey0: 2222, mykey1: [1, 2, 3], mykey2: "[1, 2, 3]", mykey3: "ssssssssssssssssssssssssss", mykey4: [1, 15], mykey5: [false, true, false], mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey7: true, } }, }, ); ``` ## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\ * 接口说明 设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(Promise形式) * startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | --------------------------------------- | ---- | ------------------- | | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.terminateSelfWithResult( { resultCode: 1, want: { action: "action.system.home", entities: ["entity.system.home"], type: "MIMETYPE", flags: FLAG_AUTH_READ_URI_PERMISSION, deviceId: "", bundleName: "com.example.featureabilitytest", abilityName: "com.example.featureabilitytest.MainAbility", uri:"", parameters: { mykey0: 2222, mykey1: [1, 2, 3], mykey2: "[1, 2, 3]", mykey3: "ssssssssssssssssssssssssss", mykey4: [1, 15], mykey5: [false, true, false], mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey7: true, } }, } ).then((void) => { console.info("==========================>terminateSelfWithResult=======================>"); }); ``` ## FeatureAbility.hasWindowFocus(callback: AsyncCallback\): void * 接口说明 检查ability的主窗口是否具有窗口焦点(callback形式) * 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | -------- | -------- | ----------------------- | ---- | ---------------- | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | * 返回值 如果此异能当前具有视窗焦点,则返回{@code true};否则返回{@code false} * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.hasWindowFocus() ``` ## FeatureAbility.hasWindowFocus(): Promise\ * 接口说明 检查ability的主窗口是否具有窗口焦点(Promise形式) * 参数描述 无 * 返回值 如果此异能当前具有视窗焦点,则返回{@code true};否则返回{@code false} * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.hasWindowFocus().then((void) => { console.info("==========================>hasWindowFocus=======================>"); }); ``` ## FeatureAbility.getWant(callback: AsyncCallback\) * 接口说明 获取从ability发送的want(callback形式) * 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | -------- | -------- | -------------------- | ---- | ---------------- | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.getWant() ``` ## FeatureAbility.getWant(): void * 接口说明 获取从ability发送的want(Promise形式) * 参数描述 无 * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.getWant().then((void) => { console.info("==========================>getWantCallBack=======================>"); }); ``` ## FeatureAbility.getContext(): Context * 接口说明 获取应用程序上下文 * 返回值 返回应用程序上下文 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; var context = featureAbility.getContext() context.getBundleName() ``` ## FeatureAbility.terminateSelf(callback: AsyncCallback\): void * 接口说明 设置page ability返回给被调用方的结果代码和数据,并销毁此page ability(callback形式) * 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | -------- | -------- | -------------------- | ---- | ---------------- | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.terminateSelf() ``` ## FeatureAbility.terminateSelf(): Promise\ * 接口说明 设置page ability返回给被调用方的结果代码和数据,并销毁此page ability(Promise形式) * 参数描述 Null * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureability'; featureAbility.terminateSelf().then((void) => { console.info("==========================>terminateSelfCallBack=======================>"); }); ``` ## FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number * 接口说明 将当前ability连接到指定ServiceAbility(callback形式) * connectAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------- | -------- | -------------- | ---- | -------------------------- | | request | 只读 | Want | 是 | 表示被连接的ServiceAbility | | options | 只读 | ConnectOptions | 是 | 被指定的回调方法 | - ConnectOptions类型说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------ | -------- | -------- | ---- | ---------------------------------- | | onConnect | 只读 | function | 是 | 连接成功时的回调函数 | | onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 | | onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 | * 返回值 连接的ServiceAbilityID。 * 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' function onConnectCallback(element, remote){ console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); } function onDisconnectCallback(element){ console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) } function onFailedCallback(code){ console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) } var connId = featureAbility.connectAbility( { bundleName: "com.ix.ServiceAbility", abilityName: "ServiceAbilityA", }, { onConnect: onConnectCallback, onDisconnect: onDisconnectCallback, onFailed: onFailedCallback, }, ); ``` ## FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\): void * 接口说明 断开与指定ServiceAbility的连接(callback形式) * disconnectAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | ------------- | ---- | ------------------------------ | | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID | | callback | 只读 | AsyncCallback\ | 是 | 被指定的回调方法 | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' function onConnectCallback(element, remote){ console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); } function onDisconnectCallback(element){ console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) } function onFailedCallback(code){ console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) } var connId = featureAbility.connectAbility( { bundleName: "com.ix.ServiceAbility", abilityName: "ServiceAbilityA", }, { onConnect: onConnectCallback, onDisconnect: onDisconnectCallback, onFailed: onFailedCallback, }, ); var result = featureAbility.disconnectAbility(connId, (error,data) => { console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data) }, ); ``` ## FeatureAbility.disconnectAbility(connection: number): Promise\ * 接口说明 断开与指定ServiceAbility的连接(promise形式) * disconnectAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | ------ | ---- | ------------------------------ | | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID | * 返回值 * 示例 ```javascript import featureAbility from '@ohos.ability.featureAbility' function onConnectCallback(element, remote){ console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); } function onDisconnectCallback(element){ console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) } function onFailedCallback(code){ console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) } var connId = featureAbility.connectAbility( { bundleName: "com.ix.ServiceAbility", abilityName: "ServiceAbilityA", }, { onConnect: onConnectCallback, onDisconnect: onDisconnectCallback, onFailed: onFailedCallback, }, ); var result = await featureAbility.disconnectAbility(connId); ``` ## AbilityResult类型说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | | resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持) | | want | 只读 | [Want](#Want类型说明) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | ## StartAbilityParameter类型说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | | want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 | | abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 | ## Want类型说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | | bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 | | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 | | uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri,则Want将匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。 | | type | 只读 | string | 否 | 表示MIME type类型描述,比如:"text/plain" 、 "image/*"等。 | | flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字,具体参考:[flags说明](#flags说明)。 | | action | 只读 | string | 否 | 表示action选项描述。 | | parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | | entities | 只读 | Array\ | 否 | 表示entities相关描述。 | ## flags说明 | 名称 | 参数 | 描述 | | ------------------------------------ | ---------- | ------------------------------------------------------------ | | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 | | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源能力 | | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS | | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | | FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | | FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力 | | FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | | FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动,都将启动使用服务模板的功能 | | FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能,请安装该功能 | | FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装,使用后台模式安装该功能。 | | FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志,并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | | FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | | FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部,则将重用该实例。否则,将创建一个新的能力实例。 | ## AbilityStartSetting类型说明 abilityStartSetting属性是一个定义为[key: string]: any的对象,key对应设定类型为:AbilityStartSetting枚举类型,value对应设定类型为:AbilityWindowConfiguration枚举类型。 使用时通过featureAbility.AbilityStartSetting获取,示例:featureAbility.AbilityStartSetting.BOUNDS_KEY。 | 名称 | 参数 | 描述 | | --------------- | --------------- | -------------------------- | | BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 | | WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 | | DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 | ## AbilityWindowConfiguration类型说明 使用时通过featureAbility.AbilityWindowConfiguration获取,示例:featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。 | 名称 | 参数 | 描述 | | --------------------------- | ---- | ---------- | | WINDOW_MODE_UNDEFINED | 0 | 未定义。 | | WINDOW_MODE_FULLSCREEN | 1 | 全屏。 | | WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 | | WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 | | WINDOW_MODE_FLOATING | 102 | 悬浮窗。 |