鸿蒙OS NotificationUserInput

NotificationUserInput

java.lang.Object

|—ohos.event.notification.NotificationUserInput

public class NotificationUserInput
extends Object
implements Sequenceable

定义用户输入，它将与发送的 IntentAgent 中的意图一起传递。 您应该始终使用 NotificationUserInput.Builder 创建此类的实例。 您可以调用 NotificationActionButton.Builder#addNotificationUserInput(NotificationUserInput) 将 NotificationUserInput 对象添加到 NotificationActionButton。

Since:

3

嵌套类摘要

字段摘要

方法总结

字段详细信息

PRODUCER

public static final Sequenceable.ProducerNotificationUserInput PRODUCER

从 Parcel 创建 NotificationUserInput 实例。

Since:

4

方法详情

addMimeInputToIntent

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

将指定 MIME 类型的给定 NotificationUserInput 对象添加到 Intent。 该方法与 addInputsToIntent(java.util.List, ohos.aafwk.content.Intent, ohos.utils.PacMap) 类似，只是必须指定 MIME 类型。

参数：

Since:

3

addInputsToIntent

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

将 NotificationUserInput 对象列表添加到 Intent。 此方法仅应在将输入结果发送到 IntentAgent 时由用户输入收集服务调用。

参数：

Since:

3

getMimeInputsFromIntent

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

从指定的 ohos.aafwk.content.Intent 获取特定 MIME 类型的输入结果。 此方法类似于 getInputsFromIntent(ohos.aafwk.content.Intent)，但使用的是 NotificationUserInput 的键。

参数：

返回:

返回包含 MIME 类型及其 URI 结果的映射。

Since:

3

getInputsFromIntent

public static PacMap getInputsFromIntent(Intent intent)

从指定的 ohos.aafwk.content.Intent 获取输入文本结果。

参数：

返回:

返回包含输入文本结果的 PacMap 对象。

Since:

3

setInputsSource

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

设置此 NotificationUserInput 对象的输入源。

参数：

Since:

3

getInputsSource

public static int getInputsSource(Intent intent)

获取此 NotificationUserInput 对象的输入源。

参数：

返回:

返回此 NotificationUserInput 对象的输入源，如 NotificationConstant.InputsSource 中所枚举。

Since:

3

getInputKey

public String getInputKey()

获取此 NotificationUserInput 对象的键。

返回:

返回此 NotificationUserInput 对象的键。

Since:

3

getTag

public String getTag()

当从用户那里收集这个输入时，获取要显示给用户的标签。

返回:

返回要显示给用户的标签。

Since:

3

getOptions

public ListString getOptions()

获取提供给用户的选项以满足用户输入需求。

返回:

返回预定义选项的列表。

Since:

3

getPermitMimeTypes

public SetString getPermitMimeTypes()

获取此 NotificationUserInput 对象允许的 MIME 类型。

返回:

返回允许的 MIME 类型列表。

Since:

3

getAdditionalData

public PacMap getAdditionalData()

获取包含在此 NotificationUserInput 对象中的附加数据。

返回:

返回此 NotificationUserInput 对象中的附加数据。

Since:

3

isPermitFreeFormInput

public boolean isPermitFreeFormInput()

检查用户是否可以为此 NotificationUserInput 对象提供任意值。

返回:

如果此对象允许任意值，则返回 true； 否则返回 false。

Since:

3

isMimeTypeOnly

public boolean isMimeTypeOnly()

检查此 NotificationUserInput 对象是否仅允许特定 MIME 类型的值。

返回:

如果此对象仅允许特定 MIME 类型的值，则返回 true； 否则返回 false。

Since:

3

getEditType

public int getEditType()

获取此 NotificationUserInput 对象提供的选项的编辑类型。

返回:

返回选项的编辑类型。

Since:

4

marshalling

public boolean marshalling(Parcel out)

将 NotificationUserInput 对象编组到 Parcel 中。

进程可以调用 unmarshalling(ohos.utils.Parcel) 方法从 Parcel 中解组 NotificationUserInput 对象以实现进程间通信 (IPC)。

指定者：

接口 Sequenceable 中的编组

参数：

返回:

如果编组成功，则返回 true； 否则返回 false。

Since:

3

unmarshalling

public boolean unmarshalling(Parcel in)

从 Parcel 中解组 NotificationUserInput 对象。

指定者：

在接口 Sequenceable 中解组

参数：

返回:

如果解组成功，则返回 true； 否则返回 false。

Since:

3

toString

public String toString()

从类复制的描述：对象

返回对象的字符串表示形式。 通常，toString 方法返回一个“以文本方式表示”该对象的字符串。 结果应该是一个简洁但信息丰富的表示，易于人们阅读。 建议所有子类重写此方法。

Object 类的 toString 方法返回一个字符串，该字符串由对象作为其实例的类的名称、at 符号字符“@”和对象哈希码的无符号十六进制表示形式组成。 换句话说，此方法返回一个等于以下值的字符串：

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

覆盖：

类 Object 中的 toString

返回:

对象的字符串表示形式。

Since:

4