@ohos.app.ability.dialogSession (dialogSession)(系统接口)

dialogSession模块用于支持系统应用弹框功能。

说明：

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

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

本模块为系统接口。

导入模块

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

DialogAbilityInfo

提供会话组件信息，包括包名、模块名、组件名等信息。

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

DialogSessionInfo

提供会话信息，包括请求方信息、目标应用列表信息、其他参数。

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

getDialogSessionInfo

getDialogSessionInfo(dialogSessionId: string): DialogSessionInfo

根据dialogSessionId获取会话信息。

系统接口：该接口为系统接口。

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

参数：

返回值：

错误码：

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

示例：

import dialogSession from '@ohos.app.ability.dialogSession';
import Want from '@ohos.app.ability.Want';

// want由系统内部指定，dialogSessionId为内置参数
let dialogSessionId: string = want?.parameters?.dialogSessionId;

// 查询DialogSessionInfo
let dialogSessionInfo: dialogSession.DialogSessionInfo = dialogSession.getDialogSessionInfo(dialogSessionId);

sendDialogResult

sendDialogResult(dialogSessionId: string, targetWant: Want, isAllowed: boolean, callback: AsyncCallback<void>): void

发送用户请求。使用callback异步回调。

系统接口：该接口为系统接口。

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

参数：

错误码：

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

示例：

import dialogSession from '@ohos.app.ability.dialogSession';
import Want from '@ohos.app.ability.Want';

// want由系统内部指定，dialogSessionId为内置参数
let dialogSessionId: string = want?.parameters?.dialogSessionId;

// 查询DialogSessionInfo
let dialogSessionInfo: dialogSession.DialogSessionInfo = dialogSession.getDialogSessionInfo(dialogSessionId);

let isAllow: Boolean = true;

// isAllow为true时，用户请求结果targetWant为dialogSessionInfo.targetAbilityInfos之一
let targetWant: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility'
};

try {
  dialogSession.sendDialogResult(dialogSessionId, targetWant, isAllow, (err, data) => {
    if (data) {
      console.log(`sendDialogResult success, data: ${data}`);
    } else {
      console.error(`sendDialogResult error, errorCode: ${err.code}`);
    }
  });
} catch (err) {
  console.error(`sendDialogResult error, errorCode: ${err.code}`);
}

sendDialogResult

sendDialogResult(dialogSessionId: string, targetWant: Want, isAllowed: boolean): Promise<void>

发送用户请求。使用Promise异步回调。

系统接口：该接口为系统接口。

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

参数：

返回值：

错误码：

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

示例：

import dialogSession from '@ohos.app.ability.dialogSession';
import Want from '@ohos.app.ability.Want';

// want由系统内部指定，dialogSessionId为内置参数
let dialogSessionId: string = want?.parameters?.dialogSessionId;

// 查询DialogSessionInfo
let dialogSessionInfo: dialogSession.DialogSessionInfo = dialogSession.getDialogSessionInfo(dialogSessionId);

let isAllow: Boolean = true;

// isAllow为true时，用户请求结果targetWant为dialogSessionInfo.targetAbilityInfos之一
let targetWant: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility'
};

try {
  dialogSession.sendDialogResult(dialogSessionId, targetWant, isAllow)
    .then((data) => {
      console.log(`startChildProcess success, pid: ${data}`);
    }, (err: BusinessError) => {
      console.error(`startChildProcess error, errorCode: ${err.code}`);
    })
} catch (err) {
  console.error(`sendDialogResult error, errorCode: ${err.code}`);
}