@ohos.app.ability.insightIntentDriver (执行意图调用)(系统接口)

本模块提供执行意图调用的能力，系统根据用户交互等信息执行意图调用。

说明：

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

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

本模块为系统接口。

导入模块

import insightIntentDriver from '@ohos.app.ability.insightIntentDriver';

ExecuteParam

执行意图调用的参数。

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

系统接口: 此接口为系统接口，三方应用不支持调用。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

insightIntentDriver.execute

execute(param: ExecuteParam, callback: AsyncCallback<insightIntent.ExecuteResult>): void

执行意图调用的接口。使用callback异步回调。

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

系统接口: 此接口为系统接口，三方应用不支持调用。

需要权限: ohos.permission.EXECUTE_INSIGHT_INTENT

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

参数：

错误码：

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

示例：

  import insightIntentDriver from '@ohos.app.ability.insightIntentDriver';
  import insightIntent from '@ohos.app.ability.insightIntent';
  import hilog from '@ohos.hilog';

  function executeInsightIntentAsync() {
    let param: insightIntentDriver.ExecuteParam = {
      bundleName: 'com.ohos.intentexecutedemo',
      moduleName: 'entry',
      abilityName: 'EntryAbility',
      insightIntentName: 'PlayMusic',
      insightIntentParam: {
        songName: 'City Of Stars',
      },
      executeMode: insightIntent.ExecuteMode.UI_ABILITY_FOREGROUND,
    };

    try {
      insightIntentDriver.execute(param, (error, data: insightIntent.ExecuteResult) => {
        if (error) {
          hilog.error(0x0000, 'testTag', 'execute insight intent failed with %{public}s', JSON.stringify(error));
        } else {
          hilog.info(0x0000, 'testTag', '%{public}s', 'execute insight intent succeed');
        }
        hilog.info(0x0000, 'testTag', 'execute insight intent return %{public}d', data.code);
        hilog.info(0x0000, 'testTag', 'execute insight intent result %{public}s', JSON.stringify(data.result));
      })
    } catch (error) {
      hilog.error(0x0000, 'testTag', 'execute insight intent error caught %{public}s', JSON.stringify(error));
    }
  }

insightIntentDriver.execute

execute(param: ExecuteParam): Promise<insightIntent.ExecuteResult>

执行意图调用的接口。使用Promise异步回调。

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

系统接口: 此接口为系统接口，三方应用不支持调用。

需要权限: ohos.permission.EXECUTE_INSIGHT_INTENT

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

参数：

返回值：

错误码：

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

示例：

  import insightIntentDriver from '@ohos.app.ability.insightIntentDriver';
  import insightIntent from '@ohos.app.ability.insightIntent';
  import hilog from '@ohos.hilog';

  async function executeSearchMusicIntentPromise() {
    let param: insightIntentDriver.ExecuteParam = {
      bundleName: 'com.ohos.intentexecutedemo',
      moduleName: 'entry',
      abilityName: 'EntryAbility',
      insightIntentName: 'PlayMusic',
      insightIntentParam: {
        songName: 'City Of Stars',
      },
      executeMode: insightIntent.ExecuteMode.UI_ABILITY_FOREGROUND,
    };

    try {
      let resultData: insightIntent.ExecuteResult = await insightIntentDriver.execute(param);
      hilog.info(0x0000, 'testTag', 'execute insight intent return %{public}d', resultData.code);
      hilog.info(0x0000, 'testTag', 'execute insight intent result %{public}s', JSON.stringify(resultData.result));
    } catch (error) {
      hilog.error(0x0000, 'testTag', 'execute insight intent error caught %{public}s', JSON.stringify(error));
    }
  }