程序包 ohos.event.notification

类 NotificationUserInput.Builder

java.lang.Object

ohos.event.notification.NotificationUserInput.Builder

封闭类:

NotificationUserInput

public static final class NotificationUserInput.Builder
extends Object

Builder class for NotificationUserInput object.

从以下版本开始:

3

SystemCapability

SystemCapability.Notification#ANS

构造器概要

构造器

构造器	说明
Builder(String inputKey)	A constructor used to create a Builder instance for creating NotificationUserInput objects.

方法概要

限定符和类型	方法	说明
NotificationUserInput.Builder	addAdditionalData(PacMap pacMap)	Adds additional data to this Builder.
NotificationUserInput	build()	Creates a new NotificationUserInput object by using all of the settings.
NotificationUserInput.Builder	setEditType(NotificationConstant.InputEditType editType)	Sets the edit type of the options provided by this NotificationUserInput object.
NotificationUserInput.Builder	setOptions(List<String> options)	Sets the options provided to users to satisfy user input needs.
NotificationUserInput.Builder	setPermitFreeFormInput(boolean permitFreeFormInput)	Sets whether users can input arbitrary text values.
NotificationUserInput.Builder	setPermitMimeTypes(String mimeType, boolean doPermit)	Sets whether users can input values of the given MIME type.
NotificationUserInput.Builder	setTag(String tag)	Sets the tag to be displayed to the user when collecting this input from the user.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

public Builder(String inputKey)

A constructor used to create a Builder instance for creating NotificationUserInput objects.

参数:

inputKey - Indicates the PacMap key used to identify this input when the input is collected from the user.

抛出:

IllegalArgumentException - Throws this exception if inputKey is null.

从以下版本开始:

3

方法详细资料

setTag

public NotificationUserInput.Builder setTag(String tag)

Sets the tag to be displayed to the user when collecting this input from the user.

参数:

tag - Indicates the tag to be displayed.

返回:

Returns this Builder object.

从以下版本开始:

3

setOptions

public NotificationUserInput.Builder setOptions(List<String> options)

Sets the options provided to users to satisfy user input needs. All options are displayed in a single line. Due to limited space, some or all of the options may be hidden if the options are too long or there are too many options.

参数:

options - Indicates the list of predefined options to be provided for user input.

返回:

Returns this Builder object.

从以下版本开始:

3

setPermitMimeTypes

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

Sets whether users can input values of the given MIME type.

参数:

mimeType - Indicates the MIME type allowed. If this parameter is null, this method returns the original Builder object.

doPermit - Specifies whether to allow the given MIME type. The value true means to allow it, and the value false means not.

返回:

Returns this Builder object.

从以下版本开始:

3

setPermitFreeFormInput

public NotificationUserInput.Builder setPermitFreeFormInput(boolean permitFreeFormInput)

Sets whether users can input arbitrary text values.

参数:

permitFreeFormInput - Specifies whether to allow arbitrary text values. The default value is true, indicating that arbitrary text values are allowed. If this parameter is set to false, you must either call setOptions(java.util.List<java.lang.String>) to set a non-null and non-empty list or call setPermitMimeTypes(java.lang.String, boolean) to allow a MIME type. Otherwise, an IllegalArgumentException will be thrown.

返回:

Returns this Builder object.

从以下版本开始:

3

addAdditionalData

public NotificationUserInput.Builder addAdditionalData(PacMap pacMap)

Adds additional data to this Builder. The value of pacMap will replace the existing extras value in this Builder.

参数:

pacMap - Indicates the PacMap object containing the additional data.

返回:

Returns this Builder object.

从以下版本开始:

3

setEditType

public NotificationUserInput.Builder setEditType(NotificationConstant.InputEditType editType)

Sets the edit type of the options provided by this NotificationUserInput object.

The edit type determines whether an option can be edited when the user taps the option.

参数:

editType - Indicates the edit type to set. For details about available values, see NotificationConstant.InputEditType.

返回:

Returns this Builder object.

从以下版本开始:

4

build

public NotificationUserInput build()

Creates a new NotificationUserInput object by using all of the settings.

返回:

Returns the created NotificationUserInput object.

从以下版本开始:

3