鸿蒙OS NotificationUserInput.Builder

NotificationUserInput.Builder

java.lang.Object

|---ohos.event.notification.NotificationUserInput.Builder

public static final class NotificationUserInput.Builder
extends Object

NotificationUserInput 对象的构建器类。

Since:

3

构造函数摘要

构造函数	描述
Builder(String inputKey)	用于创建用于创建 NotificationUserInput 对象的 Builder 实例的构造函数。

方法总结

修饰符和类型	方法	描述
NotificationUserInput.Builder	addAdditionalData(PacMap pacMap)	将附加数据添加到此 Builder。
NotificationUserInput	build()	使用所有设置创建一个新的 NotificationUserInput 对象。
NotificationUserInput.Builder	setEditType(NotificationConstant.InputEditType editType)	设置此 NotificationUserInput 对象提供的选项的编辑类型。
NotificationUserInput.Builder	setOptions(ListString options)	设置提供给用户的选项以满足用户输入需求。
NotificationUserInput.Builder	setPermitFreeFormInput(boolean permitFreeFormInput)	设置用户是否可以输入任意文本值。
NotificationUserInput.Builder	setPermitMimeTypes(String mimeType, boolean doPermit)	设置用户是否可以输入给定 MIME 类型的值。
NotificationUserInput.Builder	setTag(String tag)	设置从用户收集此输入时显示给用户的标签。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造函数详细信息

Builder

public Builder(String inputKey)

用于创建用于创建 NotificationUserInput 对象的 Builder 实例的构造函数。

参数：

参数名称	参数描述
inputKey	指示从用户收集输入时用于识别此输入的 PacMap 键。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 inputKey 为 null，则引发此异常。

Since:

3

方法详情

setTag

public NotificationUserInput.Builder setTag(String tag)

设置从用户收集此输入时显示给用户的标签。

参数：

参数名称	参数描述
tag	表示要显示的标签。

返回:

返回此 Builder 对象。

Since:

3

setOptions

public NotificationUserInput.Builder setOptions(ListString options)

设置提供给用户的选项以满足用户输入需求。 所有选项都显示在一行中。 由于篇幅有限，如果选项太长或选项太多，可能会隐藏部分或全部选项。

参数：

参数名称	参数描述
options	指示要为用户输入提供的预定义选项列表。

返回:

返回此 Builder 对象。

Since:

3

setPermitMimeTypes

public NotificationUserInput.Builder setPermitMimeTypes(String mimeType, boolean doPermit)

设置用户是否可以输入给定 MIME 类型的值。

参数：

参数名称	参数描述
mimeType	指示允许的 MIME 类型。 如果此参数为 null，则此方法返回原始 Builder 对象。
doPermit	指定是否允许给定的 MIME 类型。 值 true 表示允许，值 false 表示不允许。

返回:

返回此 Builder 对象。

Since:

3

setPermitFreeFormInput

public NotificationUserInput.Builder setPermitFreeFormInput(boolean permitFreeFormInput)

设置用户是否可以输入任意文本值。

参数：

参数名称	参数描述
permitFreeFormInput	指定是否允许任意文本值。 默认值为 true，表示允许任意文本值。 如果此参数设置为 false，您必须调用 setOptions(java.util.List) 来设置非空和非空列表，或者调用 setPermitMimeTypes(java.lang.String, boolean) 来允许 MIME 类型。 否则，将抛出 IllegalArgumentException。

返回:

返回此 Builder 对象。

Since:

3

addAdditionalData

public NotificationUserInput.Builder addAdditionalData(PacMap pacMap)

将附加数据添加到此 Builder。 pacMap 的值将替换此 Builder 中现有的 extras 值。

参数：

参数名称	参数描述
pacMap	指示包含附加数据的 PacMap 对象。

返回:

返回此 Builder 对象。

Since:

3

setEditType

public NotificationUserInput.Builder setEditType(NotificationConstant.InputEditType editType)

设置此 NotificationUserInput 对象提供的选项的编辑类型。

编辑类型决定了当用户点击选项时是否可以编辑选项。

参数：

参数名称	参数描述
editType	表示要设置的编辑类型。

返回:

返回此 Builder 对象。

Since:

4

build

public NotificationUserInput build()

使用所有设置创建一个新的 NotificationUserInput 对象。

返回:

返回创建的 NotificationUserInput 对象。

Since:

3