處理模態(tài)彈框的能力

2024-01-23 12:49 更新

dialogRequest模塊用于處理模態(tài)彈框的能力，包括獲取RequestInfo（用于綁定模態(tài)彈框）、獲取RequestCallback（用于設(shè)置結(jié)果）。

模態(tài)彈框是指一個(gè)系統(tǒng)彈出框，其特點(diǎn)在于：該彈出框會(huì)攔截彈框之下的頁面的鼠標(biāo)、鍵盤、觸屏等事件，銷毀該彈框，才能操作下面的頁面。

說明
  • 本模塊首批接口從API version 9開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
  • 本模塊接口在ServiceExtensionAbility下使用，如果ServiceExtensionAbility實(shí)現(xiàn)了模態(tài)彈框，則可以使用本模塊的接口獲取請(qǐng)求方的RequestInfo、RequestCallback并返回請(qǐng)求結(jié)果。
  • 本模塊接口在HarmonyOS 3.1 Beta2暫不支持。

導(dǎo)入模塊

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

dialogRequest.getRequestInfo

getRequestInfo(want: Want): RequestInfo

從Want中獲取請(qǐng)求方的RequestInfo。

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

名稱

類型

必填

描述

want

Want

是

表示發(fā)起方請(qǐng)求彈框時(shí)傳入的want信息。

返回值：

類型

說明

RequestInfo

請(qǐng)求方RequestInfo,用于綁定模態(tài)窗口。

dialogRequest.getRequestCallback

getRequestCallback(want: Want): RequestCallback

從Want中獲取請(qǐng)求方的RequestCallback。

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

名稱

類型

必填

描述

want

Want

是

表示發(fā)起方請(qǐng)求彈框時(shí)傳入的want信息。

返回值：

類型

說明

RequestCallback

請(qǐng)求方RequestCallback,用于設(shè)置返回結(jié)果。

RequestInfo

表示發(fā)起方請(qǐng)求信息，作為窗口綁定模態(tài)彈框的入?yún)ⅰ?/p>

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

ResultCode

模態(tài)彈框請(qǐng)求結(jié)果碼。

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore。

名稱

值

說明

RESULT_OK

0

表示成功。

RESULT_CANCEL

1

表示失敗。

RequestResult

模態(tài)彈框請(qǐng)求結(jié)果，當(dāng)前只包含結(jié)果碼，即RequestResult只當(dāng)前只有ResultCode這一個(gè)成員。

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

屬性

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

名稱

類型

可讀

可寫

說明

result

ResultCode

是

是

表示結(jié)果碼。

RequestCallback

用于設(shè)置模態(tài)彈框請(qǐng)求結(jié)果的callback接口。

RequestCallback.setRequestResult

setRequestResult(result: RequestResult): void;

設(shè)置請(qǐng)求結(jié)果。

該接口能力在HarmonyOS 3.1 Beta2暫不支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

參數(shù)名

類型

必填

說明

result

RequestResult

是

模態(tài)彈框請(qǐng)求結(jié)果信息。

錯(cuò)誤碼：

錯(cuò)誤碼ID

錯(cuò)誤信息

401

If the input parameter is not valid parameter.

以上錯(cuò)誤碼詳細(xì)介紹請(qǐng)參考errcode-ability。

以上內(nèi)容是否對(duì)您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)