6a871652创建于 2025年12月13日历史提交

@ohos.app.ability.insightIntentProvider (意图提供方管理能力)

本模块为意图提供方提供管理能力，如主动发送指定意图的执行结果。

说明：

本模块首批接口从API version 23开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

导入模块

import { insightIntentProvider } from '@kit.AbilityKit';

insightIntentProvider.sendExecuteResult

sendExecuteResult(instanceId: number, result: insightIntent.ExecuteResult): Promise<void>

如果意图提供方需要在业务处理的特定流程中主动发送意图执行结果，可以先通过setReturnModeForUIAbilityForeground接口或setReturnModeForUIExtensionAbility接口将意图执行结果返回形式设置为FUNCTION，然后调用该接口发送意图执行结果，适用于配置类意图。使用Promise异步回调。
意图执行结果返回形式设置为FUNCTION后，应用将无需再通过onExecuteInUIAbilityForegroundMode接口或onExecuteInUIExtensionAbility接口的返回值返回意图执行结果。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
instanceId	number	是	意图实例唯一ID。
result	insightIntent.ExecuteResult	是	返回意图执行结果，表示本次意图执行返回给系统入口的数据。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码详细介绍请参考元能力子系统错误码。

错误码ID	错误信息
16000003	The specified ID does not exist.
16000050	Internal error. Possible causes: 1. Connect to system service failed; 2.Send restart message to system service failed; 3.System service failed to communicate with dependency module.

示例：

设置意图执行结果延迟返回示例：

import { InsightIntentExecutor, insightIntent } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

export default class InsightIntentExecutorUI extends InsightIntentExecutor {
  onExecuteInUIAbilityForegroundMode(name: string, param: Record<string, Object>,
    pageLoader: window.WindowStage): insightIntent.ExecuteResult {
    hilog.info(0x0000, 'testTag', 'onExecuteInUIAbilityForegroundMode %{public}s', name);
    let result: insightIntent.ExecuteResult;
    result = {
      code: 0,
      result: {
        message: 'Unsupported insight intent.',
      },
    };
    try {
      //设置意图执行结果的返回形式为延迟返回
      this.context.setReturnModeForUIAbilityForeground(insightIntent.ReturnMode.FUNCTION);
    } catch (error) {
      let code = (error as BusinessError).code;
      let msg = (error as BusinessError).message;
      console.error(`testTag setReturnModeForUIExtensionAbility fail, error code: ${code}, error msg: ${msg}.`);
    }
    //将意图实例的id通过localStorage传入目标页面中
    let localStorageData: Record<string, number> = {
      'insightId': this.context.instanceId,
    };
    let storage: LocalStorage = new LocalStorage(localStorageData);
    //通过pageLoader加载页面
    pageLoader.loadContent('pages/UiabilityIndex', storage, (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err));
      } else {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Succeeded in loading the content');
      }
    });
    return result;
  }
}

主动发送意图执行结果示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { insightIntent, insightIntentProvider } from '@kit.AbilityKit';

@Entry
@Component
struct Index {
  storage: LocalStorage | undefined = this.getUIContext().getSharedLocalStorage();
  insightId: number | undefined = this.storage?.get<number>('insightId');

  build() {
    Column() {
      //通过sendExecuteResult接口主动返回意图执行结果
      Button('insightIntentProvider sendExecuteResult')
        .onClick(() => {
          try {
            let result: insightIntent.ExecuteResult;
            result = {
              code: 0,
              result: {
                message: 'Unsupported insight intent.',
              },
            };
            insightIntentProvider.sendExecuteResult(this.insightId, result)
              .then(() => {
                console.info('testTag setExecuteResult success');
              })
              .catch((error: BusinessError) => {
                console.error(`testTag setExecuteResult fail1, error code: ${error.code}, error msg: ${error.message}.`);
              });
          } catch (e) {
            let code = (e as BusinessError).code;
            let msg = (e as BusinessError).message;
            console.error(`testTag setExecuteResult fail2, error code: ${code}, error msg: ${msg}`);
          }
        })
    }
    .height('100%')
    .width('100%')
  }
}

insightIntentProvider.sendIntentResult

sendIntentResult(instanceId: number, result: insightIntent.IntentResult<T>): Promise<void>

如果意图提供方需要在业务处理的特定流程中主动发送意图执行结果，可以先通过setReturnModeForUIAbilityForeground接口或setReturnModeForUIExtensionAbility接口将意图执行结果返回形式设置为FUNCTION，然后调用该接口发送意图执行结果。适用于@InsightIntentEntry修饰的装饰器类意图。使用Promise异步回调。
意图执行结果返回形式设置为FUNCTION后，应用将无需再通过onExecute接口的返回值返回意图执行结果。