鴻蒙OS NotificationUserInput

NotificationUserInput

java.lang.Object

|---ohos.event.notification.NotificationUserInput

public class NotificationUserInput
extends Object
implements Sequenceable

定義用戶輸入，它將與發(fā)送的 IntentAgent 中的意圖一起傳遞。 您應(yīng)該始終使用 NotificationUserInput.Builder 創(chuàng)建此類的實(shí)例。 您可以調(diào)用 NotificationActionButton.Builder#addNotificationUserInput(NotificationUserInput) 將 NotificationUserInput 對(duì)象添加到 NotificationActionButton。

Since:

3

嵌套類摘要

修飾符和類型	類	描述
static class	NotificationUserInput.Builder	NotificationUserInput 對(duì)象的構(gòu)建器類。

從接口 ohos.utils.Sequenceable 繼承的嵌套類/接口
Sequenceable.ProducerT

字段摘要

修飾符和類型	字段	描述
static Sequenceable.ProducerNotificationUserInput	PRODUCER	從 Parcel 創(chuàng)建 NotificationUserInput 實(shí)例。

方法總結(jié)

修飾符和類型	方法	描述
static void	addInputsToIntent(ListNotificationUserInput userInputs, Intent intent, PacMap pacMap)	將 NotificationUserInput 對(duì)象列表添加到 Intent。
static void	addMimeInputToIntent(NotificationUserInput userInput, Intent intent, MapString,Uri results)	將指定 MIME 類型的給定 NotificationUserInput 對(duì)象添加到 Intent。
PacMap	getAdditionalData()	獲取包含在此 NotificationUserInput 對(duì)象中的附加數(shù)據(jù)。
int	getEditType()	獲取此 NotificationUserInput 對(duì)象提供的選項(xiàng)的編輯類型。
String	getInputKey()	獲取此 NotificationUserInput 對(duì)象的鍵。
static PacMap	getInputsFromIntent(Intent intent)	從指定的 ohos.aafwk.content.Intent 獲取輸入文本結(jié)果。
static int	getInputsSource(Intent intent)	獲取此 NotificationUserInput 對(duì)象的輸入源。
static MapString,Uri	getMimeInputsFromIntent(Intent intent, String inputKey)	從指定的 ohos.aafwk.content.Intent 獲取特定 MIME 類型的輸入結(jié)果。
ListString	getOptions()	獲取提供給用戶的選項(xiàng)以滿足用戶輸入需求。
SetString	getPermitMimeTypes()	獲取此 NotificationUserInput 對(duì)象允許的 MIME 類型。
String	getTag()	當(dāng)從用戶那里收集這個(gè)輸入時(shí)，獲取要顯示給用戶的標(biāo)簽。
boolean	isMimeTypeOnly()	檢查此 NotificationUserInput 對(duì)象是否僅允許特定 MIME 類型的值。
boolean	isPermitFreeFormInput()	檢查用戶是否可以為此 NotificationUserInput 對(duì)象提供任意值。
boolean	marshalling(Parcel out)	將 NotificationUserInput 對(duì)象編組到 Parcel 中。
static void	setInputsSource(Intent intent, NotificationConstant.InputsSource source)	設(shè)置此 NotificationUserInput 對(duì)象的輸入源。
String	toString()	返回對(duì)象的字符串表示形式。
boolean	unmarshalling(Parcel in)	從 Parcel 中解組 NotificationUserInput 對(duì)象。

從類 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

從接口 ohos.utils.Sequenceable 繼承的方法
hasFileDescriptor

字段詳細(xì)信息

PRODUCER

public static final Sequenceable.ProducerNotificationUserInput PRODUCER

從 Parcel 創(chuàng)建 NotificationUserInput 實(shí)例。

Since:

4

方法詳情

addMimeInputToIntent

public static void addMimeInputToIntent(NotificationUserInput userInput, Intent intent, MapString,Uri results)

將指定 MIME 類型的給定 NotificationUserInput 對(duì)象添加到 Intent。 該方法與 addInputsToIntent(java.util.List, ohos.aafwk.content.Intent, ohos.utils.PacMap) 類似，只是必須指定 MIME 類型。

參數(shù)：

參數(shù)名稱	參數(shù)描述
userInput	指示為其提供輸入結(jié)果的 NotificationUserInput 對(duì)象。
intent	指示要添加輸入結(jié)果的 Intent。
results	指示包含 MIME 類型及其 URI 結(jié)果的映射。

Since:

3

addInputsToIntent

public static void addInputsToIntent(ListNotificationUserInput userInputs, Intent intent, PacMap pacMap)

將 NotificationUserInput 對(duì)象列表添加到 Intent。 此方法僅應(yīng)在將輸入結(jié)果發(fā)送到 IntentAgent 時(shí)由用戶輸入收集服務(wù)調(diào)用。

參數(shù)：

參數(shù)名稱	參數(shù)描述
userInputs	指示為其提供輸入結(jié)果的 NotificationUserInput 對(duì)象的列表。
intent	指示要添加輸入結(jié)果的 Intent。
pacMap	指示保存輸入結(jié)果的 PacMap 對(duì)象。 PacMap 鍵必須與 userInputs 中指定的對(duì)象中包含的鍵匹配。

Since:

3

getMimeInputsFromIntent

public static MapString,Uri getMimeInputsFromIntent(Intent intent, String inputKey)

從指定的 ohos.aafwk.content.Intent 獲取特定 MIME 類型的輸入結(jié)果。 此方法類似于 getInputsFromIntent(ohos.aafwk.content.Intent)，但使用的是 NotificationUserInput 的鍵。

參數(shù)：

參數(shù)名稱	參數(shù)描述
intent	表示包含用戶輸入結(jié)果的 Intent。
inputKey	表示要獲取的 NotificationUserInput 結(jié)果的鍵。

返回:

返回包含 MIME 類型及其 URI 結(jié)果的映射。

Since:

3

getInputsFromIntent

public static PacMap getInputsFromIntent(Intent intent)

從指定的 ohos.aafwk.content.Intent 獲取輸入文本結(jié)果。

參數(shù)：

參數(shù)名稱	參數(shù)描述
intent	表示包含一個(gè)或多個(gè)用戶輸入結(jié)果的 Intent 對(duì)象。

返回:

返回包含輸入文本結(jié)果的 PacMap 對(duì)象。

Since:

3

setInputsSource

public static void setInputsSource(Intent intent, NotificationConstant.InputsSource source)

設(shè)置此 NotificationUserInput 對(duì)象的輸入源。

參數(shù)：

參數(shù)名稱	參數(shù)描述
intent	指示要添加輸入結(jié)果的 Intent。
source	表示輸入源。

Since:

3

getInputsSource

public static int getInputsSource(Intent intent)

獲取此 NotificationUserInput 對(duì)象的輸入源。

參數(shù)：

參數(shù)名稱	參數(shù)描述
intent	表示包含輸入結(jié)果的 Intent。

返回:

返回此 NotificationUserInput 對(duì)象的輸入源，如 NotificationConstant.InputsSource 中所枚舉。

Since:

3

getInputKey

public String getInputKey()

獲取此 NotificationUserInput 對(duì)象的鍵。

返回:

返回此 NotificationUserInput 對(duì)象的鍵。

Since:

3

getTag

public String getTag()

當(dāng)從用戶那里收集這個(gè)輸入時(shí)，獲取要顯示給用戶的標(biāo)簽。

返回:

返回要顯示給用戶的標(biāo)簽。

Since:

3

getOptions

public ListString getOptions()

獲取提供給用戶的選項(xiàng)以滿足用戶輸入需求。

返回:

返回預(yù)定義選項(xiàng)的列表。

Since:

3

getPermitMimeTypes

public SetString getPermitMimeTypes()

獲取此 NotificationUserInput 對(duì)象允許的 MIME 類型。

返回:

返回允許的 MIME 類型列表。

Since:

3

getAdditionalData

public PacMap getAdditionalData()

獲取包含在此 NotificationUserInput 對(duì)象中的附加數(shù)據(jù)。

返回:

返回此 NotificationUserInput 對(duì)象中的附加數(shù)據(jù)。

Since:

3

isPermitFreeFormInput

public boolean isPermitFreeFormInput()

檢查用戶是否可以為此 NotificationUserInput 對(duì)象提供任意值。

返回:

如果此對(duì)象允許任意值，則返回 true； 否則返回 false。

Since:

3

isMimeTypeOnly

public boolean isMimeTypeOnly()

檢查此 NotificationUserInput 對(duì)象是否僅允許特定 MIME 類型的值。

返回:

如果此對(duì)象僅允許特定 MIME 類型的值，則返回 true； 否則返回 false。

Since:

3

getEditType

public int getEditType()

獲取此 NotificationUserInput 對(duì)象提供的選項(xiàng)的編輯類型。

返回:

返回選項(xiàng)的編輯類型。

Since:

4

marshalling

public boolean marshalling(Parcel out)

將 NotificationUserInput 對(duì)象編組到 Parcel 中。

進(jìn)程可以調(diào)用 unmarshalling(ohos.utils.Parcel) 方法從 Parcel 中解組 NotificationUserInput 對(duì)象以實(shí)現(xiàn)進(jìn)程間通信 (IPC)。

指定者：

接口 Sequenceable 中的編組

參數(shù)：

參數(shù)名稱	參數(shù)描述
out	指示用于編組的 Parcel 對(duì)象。

返回:

如果編組成功，則返回 true； 否則返回 false。

Since:

3

unmarshalling

public boolean unmarshalling(Parcel in)

從 Parcel 中解組 NotificationUserInput 對(duì)象。

指定者：

在接口 Sequenceable 中解組

參數(shù)：

參數(shù)名稱	參數(shù)描述
in	指示用于解組的 Parcel 對(duì)象。

返回:

如果解組成功，則返回 true； 否則返回 false。

Since:

3

toString

public String toString()

從類復(fù)制的描述：對(duì)象

返回對(duì)象的字符串表示形式。 通常，toString 方法返回一個(gè)“以文本方式表示”該對(duì)象的字符串。 結(jié)果應(yīng)該是一個(gè)簡(jiǎn)潔但信息豐富的表示，易于人們閱讀。 建議所有子類重寫此方法。

Object 類的 toString 方法返回一個(gè)字符串，該字符串由對(duì)象作為其實(shí)例的類的名稱、at 符號(hào)字符“@”和對(duì)象哈希碼的無符號(hào)十六進(jìn)制表示形式組成。 換句話說，此方法返回一個(gè)等于以下值的字符串：

 getClass().getName() + '@' + Integer.toHexString(hashCode()) 

覆蓋：

類 Object 中的 toString

返回:

對(duì)象的字符串表示形式。

Since:

4