处理模态弹框的能力

2024-01-23 12:49 更新

dialogRequest模块用于处理模态弹框的能力,包括获取RequestInfo(用于绑定模态弹框)、获取RequestCallback(用于设置结果)。

模态弹框是指一个系统弹出框,其特点在于:该弹出框会拦截弹框之下的页面的鼠标、键盘、触屏等事件,销毁该弹框,才能操作下面的页面。

说明
  • 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
  • 本模块接口在ServiceExtensionAbility下使用,如果ServiceExtensionAbility实现了模态弹框,则可以使用本模块的接口获取请求方的RequestInfo、RequestCallback并返回请求结果。
  • 本模块接口在HarmonyOS 3.1 Beta2暂不支持。

导入模块

  1. import dialogRequest from '@ohos.app.ability.dialogRequest';

dialogRequest.getRequestInfo

getRequestInfo(want: Want): RequestInfo

从Want中获取请求方的RequestInfo。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

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

参数:

名称

类型

必填

描述

want

Want

表示发起方请求弹框时传入的want信息。

返回值:

类型

说明

RequestInfo

请求方RequestInfo,用于绑定模态窗口。

dialogRequest.getRequestCallback

getRequestCallback(want: Want): RequestCallback

从Want中获取请求方的RequestCallback。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

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

参数:

名称

类型

必填

描述

want

Want

表示发起方请求弹框时传入的want信息。

返回值:

类型

说明

RequestCallback

请求方RequestCallback,用于设置返回结果。

RequestInfo

表示发起方请求信息,作为窗口绑定模态弹框的入参。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

ResultCode

模态弹框请求结果码。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore。

名称

说明

RESULT_OK

0

表示成功。

RESULT_CANCEL

1

表示失败。

RequestResult

模态弹框请求结果,当前只包含结果码,即RequestResult只当前只有ResultCode这一个成员。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

属性

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

名称

类型

可读

可写

说明

result

ResultCode

表示结果码。

RequestCallback

用于设置模态弹框请求结果的callback接口。

RequestCallback.setRequestResult

setRequestResult(result: RequestResult): void;

设置请求结果。

该接口能力在HarmonyOS 3.1 Beta2暂不支持。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名

类型

必填

说明

result

RequestResult

模态弹框请求结果信息。

错误码:

错误码ID

错误信息

401

If the input parameter is not valid parameter.

以上错误码详细介绍请参考errcode-ability

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号