鸿蒙API13开辟【@ohos.app.ability.Want (Want)】通用能力的接口
Want是对象间信息传递的载体，可以用于应用组件间的信息传递。Want的利用场景之一是作为startAbility的参数，其包含了指定的启动目标，以及启动时需携带的相干数据，例如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当UIAbilityA需要启动UIAbilityB并传入一些数据时，可利用Want作为载体将这些数据传递给UIAbilityB。阐明
本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标志接口的起始版本。
导入模块
import { Want } from '@kit.AbilityKit';
属性
元服务API： 从API version 11开始，该接口支持在元服务中利用。
系统能力：SystemCapability.Ability.AbilityBase
名称范例必填阐明deviceIdstring否表示运行指定Ability的装备ID。如果未设置该字段，则表明指定本装备。bundleNamestring否表示待启动Ability所在的应用Bundle名称。moduleNamestring否表示待启动的Ability所属的模块名称。abilityNamestring否表示待启动Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。actionstring否表示要执行的通用操纵（如：检察、分享、应用详情）。在隐式Want中，您可以界说该字段，配合uri或parameters来表示对数据要执行的操纵。entitiesArray否表示目标Ability额外的类别信息（如：浏览器、视频播放器）。在隐式Want中是对action字段的补充。在隐式Want中，您可以界说该字段，来过滤匹配Ability范例。uristring否表示携带的数据，一般配合type利用，指明待处理的数据范例。如果在Want中指定了uri，则Want将匹配指定的Uri信息，包罗scheme、schemeSpecificPart、authority和path信息。typestring否表示MIME type范例描述，打开文件的范例，主要用于文管打开文件。比如：‘text/xml’ 、 'image/*'等parametersRecord<string, Object>否表示WantParams描述。一、以下Key均由系统赋值，开辟者手动修改也不会生效，系统在数据传递时会自动修改为实际值。- ohos.aafwk.param.callerPid：表示拉起方的pid，值为字符串范例。- ohos.aafwk.param.callerBundleName：表示拉起方的BundleName，值为字符串范例。- ohos.aafwk.param.callerAbilityName：表示拉起方的AbilityName，值为字符串范例。- ohos.aafwk.param.callerNativeName：表示native调用时拉起方的进程名，值为字符串范例。- ohos.aafwk.param.callerAppId：表示拉起应用的AppId信息，值为字符串范例。- ohos.aafwk.param.callerAppIdentifier：表示拉起应用的AppIdentifier信息，值为字符串范例。- ohos.aafwk.param.callerToken：表示拉起方的token，值为字符串范例。- ohos.aafwk.param.callerUid：表示中的uid，应用包里应用程序的uid，值为数值范例。- component.startup.newRules：表示是否启用新的管控规则，值为布尔范例。- moduleName：表示拉起方的moduleName，值为字符串范例。- ability.params.backToOtherMissionStack：表示是否支持跨任务链返回，值为布尔范例。- ohos.ability.params.abilityRecoveryRestart：表示当前Ability是否发生了故障恢复重启，值为布尔范例。- ohos.extra.param.key.contentTitle：表示元服务支持分享的标题，值为字符串范例。- ohos.extra.param.key.shareAbstract：表示元服务支持分享的内容，值为字符串范例。- ohos.extra.param.key.shareUrl：表示元服务支持分享的链接，值为字符串范例。- ohos.extra.param.key.supportContinuePageStack：表示在跨端迁移过程中是否迁移页面栈信息，值为布尔范例，默认值为true，自动迁移页面栈信息。- ohos.extra.param.key.supportContinueSourceExit：表示跨端迁移源端应用是否退出，值为布尔范例，默认值为true，源端应用自动退出。- ohos.extra.param.key.showMode：表示拉起元服务的展示模式，值为罗列范例。- ohos.dlp.params.sandbox：表示数据防泄漏（DLP）文件才会涉及。仅系统应用涉及。- ohos.dlp.params.bundleName：表示数据防泄漏（DLP）的BundleName，值为字符串范例。仅系统应用涉及。- ohos.dlp.params.moduleName：表示数据防泄漏（DLP）的moduleName，值为字符串范例。仅系统应用涉及。- ohos.dlp.params.abilityName：表示数据防泄漏（DLP）的AbilityName，值为字符串范例。仅系统应用涉及。- ohos.dlp.params.index：表示数据防泄漏（DLP）的索引，值为数值范例。仅系统应用涉及。- ohos.ability.params.asssertFaultSessionId：表示AssertFault的会话ID，值为字符串范例。仅系统应用涉及。二、以下是由系统界说、开辟者按需赋值的Key。- ability.params.stream：指示携带的文件URI要授权给目标方，值为string范例的文件URI数组。- ohos.extra.param.key.appCloneIndex：指示分身应用索引。三、除了上述两种环境，应用间还可以相互约定传入的键值对。阐明：want的Params操纵的常量的具体信息请参考。需注意，WantParams支持传输的最大数据量为200KB。当数据量凌驾200KB时，请利用或的方式进行数据传输。parameters的Value值仅支持基本数据范例：String、Number、Boolean、Object、undefined和null，不支持传递Object内部的function。number否表示处理Want的方式。默认传数字。例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以装备间迁移方式启动Ability。 示例：
[*]底子用法：在UIAbility对象中调用。
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
deviceId: '', // deviceId为空表示本设备
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
moduleName: 'entry' // moduleName非必选
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
// 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*] 目前支持的数据范例有：字符串、数字、布尔、对象、数组和文件描述符等。
[*] 字符串（String）
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
keyForString: 'str',
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]数字（Number）
import { common, Want } from '@kit.AbilityKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
keyForInt: 100,
keyForDouble: 99.99,
},
};
context.startAbility(want, (err) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]布尔（Boolean）
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
keyForBool: true,
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]对象（Object）
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
keyForObject: {
keyForObjectString: 'str',
keyForObjectInt: -200,
keyForObjectDouble: 35.5,
keyForObjectBool: false,
},
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]数组（Array）
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
keyForArrayString: ['str1', 'str2', 'str3'],
keyForArrayInt: ,
keyForArrayDouble: ,
keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }],
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]文件描述符（FD）
import { fileIo } from '@kit.CoreFileKit';
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let fd: number = 0;
try {
fd = fileIo.openSync('/data/storage/el2/base/haps/pic.png').fd;
} catch(err) {
let code = (err as BusinessError).code;
let message = (err as BusinessError).message;
console.error(`Failed to openSync. Code: ${code}, message: ${message}`);
}
let want: Want = {
deviceId: '', // deviceId为空表示本设备
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
moduleName: 'entry', // moduleName非必选
parameters: {
'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法，用于表示该数据是FD
}
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
[*]parameter参数用法：parameter携带开辟者自界说参数，由UIAbilityA传递给UIAbilityB，并在UIAbilityB中进行获取。
// (1) UIAbilityA通过startability启动UIAbilityB
import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'UIAbilityB',
parameters: {
developerParameters: 'parameters',
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
// (2) 以UIAbilityB实例首次启动为例，会进入到UIAbilityB的onCreate生命周期
import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit';
class UIAbilityB extends UIAbility {
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
console.log(`onCreate, want parameters: ${want.parameters?.developerParameters}`);
}
}
[*]parameter参数中的Key的利用方法。
import { common, Want, wantConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
parameters: {
: 'contentTitle',
},
};
context.startAbility(want, (err: BusinessError) => {
if (err.code) {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
}
});
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]