HarmonyOS NEXT应用元服务开辟Intents Kit（意图框架服务）本地搜索接入方
一、方案概述当用户利用应用/元服务时，开辟者可以按照尺度意图Schema向系统共享数据，并支持意图调用（空调用与传参调用），以实现用户点击卡片后，可后台实验功能（例如播放指定歌曲）或跳转至指定内容页面（例如指定的歌曲播放页面）。
https://i-blog.csdnimg.cn/direct/e6a1f9ea147d4f678b9411c44ba27369.png
二、意图注册
以歌曲本地搜索特性为例，首先要注册播放歌曲意图（PlayMusic）。开辟者需要编辑对应的意图配置PROJECT_HOME/entry/src/main/resources/base/profile/insight_intent.json文件，实现意图注册。
{
// 应用支持的意图列表
// 必须声明应用支持插件包含的必选意图，应用上架时会进行校验
"insightIntents": [
{
// 意图名称
// 名称应当遵循意图框架规范，当前仅支持预置垂域意图，不允许自定义
// 应用内意图名称唯一，不允许出现相同的名称定义
"intentName": "PlayMusic",
// 意图所属的垂域
"domain": "MusicDomain",
// 意图版本号
// 插件引用意图时会校验该版本号，只有和插件定义的版本号一致才能正常调用
"intentVersion": "1.0.1",
// 意图调用逻辑入口
"srcEntry": "./ets/entryability/InsightIntentExecutorImpl.ets",
"uiAbility": {
// 意图所在module、ability，以及代码相对路径入口
"ability": "EntryAbility",
// UIAbility支持前后台两种执行模式
"executeMode": [
"background",
"foreground"
]
}
}
]
}
三、端侧意图共享
构建意图对象，而且调用shareIntent()，实现意图共享。可同时构建多个PlayMusic或PlayMusicList的意图对象。
import { insightIntent } from '@kit.IntentsKit';
import { BusinessError } from '@kit.BasicServicesKit';
let playMusicIntent1: insightIntent.InsightIntent;
let playMusicIntent2: insightIntent.InsightIntent;
// 共享数据接口意图数组可以是更多的实体
// 根据实际代码上下文自行传入合适的context
insightIntent.shareIntent(context, ).then(() => {
console.info('shareIntent succeed');
}).catch((err: BusinessError) => {
console.error(`error.code: ${err?.code}, failed because ${err?.message}`);
});
PlayMusic的意图共享字段定义见各垂域意图Schema定义，代码示例如下：
import { insightIntent } from '@kit.IntentsKit';
let playMusicIntent: insightIntent.InsightIntent = {
intentName: "PlayMusic",
intentVersion: "1.0",
identifier: "52dac3b0-6520-4974-81e5-25f0879449b5",
intentActionInfo: {
actionMode: "EXECUTED",
executedTimeSlots: {
executedStartTime: 1637393212000,
executedEndTime: 1637393112000,
},
currentPercentage: 50,
},
intentEntityInfo: {
entityName: "Music",
entityId: "C10194368",
entityGroupId: "C10194321312",
displayName: "测试歌曲1",
description: "NA",
logoURL: "https://www-file.abc.com/-/media/corporate/images/home/logo/abc_logo.png",
keywords: ["华为音乐", "化妆"],
rankingHint: 99,
expirationTime: 1637393212000,
metadataModificationTime: 1637393212000,
activityType: ["1", "2", "3"],
artist: ["测试歌手1", "测试歌手2"],
lyricist: ["测试词作者1", "测试词作者2"],
composer: ["测试曲作者1", "测试曲作者2"],
albumName: "测试专辑",
duration: 244000,
playCount: 100000,
musicalGenre: ["流行", "华语", "金曲", "00后"],
isPublicData: false,
}
}
完整的意图共享示例如下所示，该示例构建了一个PlayMusic意图，并进行了shareIntent调用。
import { insightIntent } from '@kit.IntentsKit';
import { BusinessError } from '@kit.BasicServicesKit';
let playMusicIntent: insightIntent.InsightIntent = {
intentName: "PlayMusic",
intentVersion: "1.0",
identifier: "52dac3b0-6520-4974-81e5-25f0879449b5",
intentActionInfo: {
actionMode: "EXECUTED",
executedTimeSlots: {
executedStartTime: 1637393212000,
executedEndTime: 1637393112000,
},
currentPercentage: 50,
},
intentEntityInfo: {
entityName: "Music",
entityId: "C10194368",
entityGroupId: "C10194321312",
displayName: "测试歌曲1",
description: "NA",
logoURL: "https://www-file.abc.com/-/media/corporate/images/home/logo/abc_logo.png",
keywords: ["华为音乐", "化妆"],
rankingHint: 99,
expirationTime: 1637393212000,
metadataModificationTime: 1637393212000,
activityType: ["1", "2", "3"],
artist: ["测试歌手1", "测试歌手2"],
lyricist: ["测试词作者1", "测试词作者2"],
composer: ["测试曲作者1", "测试曲作者2"],
albumName: "测试专辑",
duration: 244000,
playCount: 100000,
musicalGenre: ["流行", "华语", "金曲", "00后"],
isPublicData: false,
}
}
// 共享数据接口意图数组可以是更多的实体
// 根据实际代码上下文自行传入合适的context
insightIntent.shareIntent(context, ).then(() => {
console.info('shareIntent succeed');
}).catch((err: BusinessError) => {
console.error(`error.code: ${err?.code}, failed because ${err?.message}`);
});
四、端侧意图调用
开辟者需要自己实现InsightIntentExecutor，并在对应回调实现打开落地页（点击保举卡片跳转的界面）或后台实验的能力，PlayMusic的意图调用字段定义见各垂域意图Schema。
步骤如下：
继承InsightIntentExecutor。
重写对应方法，例如目标拉起前台页面，则可重写onExecuteInUIAbilityForegroundMode方法。
通过意图名称，识别播放歌曲意图（PlayMusic），在对应的方法中通报意图参数（param），并拉起对应落地页（如播放歌曲落地页）或后台实验（播放歌曲）。
import { insightIntent, InsightIntentExecutor } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';
/**
* 意图调用样例
*/
export default class InsightIntentExecutorImpl extends InsightIntentExecutor {
private static readonly PLAY_MUSIC = 'PlayMusic';
/**
* override 执行前台UIAbility意图
*
* @param name 意图名称
* @param param 意图参数
* @param pageLoader 窗口
* @returns 意图调用结果
*/
onExecuteInUIAbilityForegroundMode(name: string, param: Record<string, Object>, pageLoader: window.WindowStage):
Promise<insightIntent.ExecuteResult> {
// 根据意图名称分发处理逻辑
switch (name) {
case InsightIntentExecutorImpl.PLAY_MUSIC:
return this.playMusic(param, pageLoader);
default:
break;
}
return Promise.resolve({
code: -1,
result: {
message: 'unknown intent'
}
} as insightIntent.ExecuteResult)
}
/**
* 实现调用播放歌曲功能
*
* @param param 意图参数
* @param pageLoader 窗口
*/
private playMusic(param: Record<string, Object>, pageLoader: window.WindowStage): Promise<insightIntent.ExecuteResult> {
return new Promise((resolve, reject) => {
let para: Record<string, string> = {
'result': JSON.stringify(param)
};
let localStorage: LocalStorage = new LocalStorage(para);
// TODO 实现意图调用，loadContent的入参为歌曲落地页路径，例如：pages/Index
pageLoader.loadContent('pages/Index', localStorage)
.then(() => {
let entityId: string = (param.items as Array<object>)?.?.['entityId'];
// TODO 调用成功的情况，此处可以打印日志
resolve({
code: 0,
result: {
message: 'Intent execute succeed'
}
});
})
.catch((err: BusinessError) => {
// TODO 调用失败的情况
resolve({
code: -1,
result: {
message: 'Intent execute failed'
}
})
});
})
}
}
本文主要参考鸿蒙官方网站材料
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]