NotificationUserInput

java.lang.Object
- ohos.event.notification.NotificationUserInput

所有已实现的接口:

Sequenceable
```
public class NotificationUserInput
extends Object
implements Sequenceable
```
Defines the user input, which will be passed together with an intent in a sent IntentAgent. You should always use NotificationUserInput.Builder to create instances of this class. You can call NotificationActionButton.Builder#addNotificationUserInput(NotificationUserInput) to add a NotificationUserInput object to a NotificationActionButton.

从以下版本开始:

3

SystemCapability

SystemCapability.Notification#ANS

嵌套类概要

嵌套类
限定符和类型类说明

static class NotificationUserInput.Builder
Builder class for NotificationUserInput object.
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

嵌套类
限定符和类型	类	说明
`static class`	`NotificationUserInput.Builder`	Builder class for `NotificationUserInput` object.

字段概要

字段
限定符和类型字段说明

static Sequenceable.Producer<NotificationUserInput> PRODUCER
Creates a NotificationUserInput instance from a Parcel.

字段
限定符和类型	字段	说明
`static Sequenceable.Producer<NotificationUserInput>`	`PRODUCER`	Creates a `NotificationUserInput` instance from a `Parcel`.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static void`	`addInputsToIntent(List<NotificationUserInput> userInputs, Intent intent, PacMap pacMap)`	Adds a list of `NotificationUserInput` objects to an `Intent`.
`static void`	`addMimeInputToIntent(NotificationUserInput userInput, Intent intent, Map<String,Uri> results)`	Adds the given `NotificationUserInput` object of a specified MIME type to an `Intent`.
`PacMap`	`getAdditionalData()`	Obtains the additional data included in this `NotificationUserInput` object.
`int`	`getEditType()`	Obtains the edit type of the options provided by this `NotificationUserInput` object.
`String`	`getInputKey()`	Obtains the key of this `NotificationUserInput` object.
`static PacMap`	`getInputsFromIntent(Intent intent)`	Obtains the input text results from a specified `ohos.aafwk.content.Intent`.
`static int`	`getInputsSource(Intent intent)`	Obtains the input source of this `NotificationUserInput` object.
`static Map<String,Uri>`	`getMimeInputsFromIntent(Intent intent, String inputKey)`	Obtains the input results of a particular MIME type from a specified `ohos.aafwk.content.Intent`.
`List<String>`	`getOptions()`	Obtains the options provided to the user to satisfy user input needs.
`Set<String>`	`getPermitMimeTypes()`	Obtains the MIME types allowed by this `NotificationUserInput` object.
`String`	`getTag()`	Obtains the tag to be displayed to the user when collecting this input from the user.
`boolean`	`isMimeTypeOnly()`	Checks whether this `NotificationUserInput` object allows only values of particular MIME types.
`boolean`	`isPermitFreeFormInput()`	Checks whether users can provide arbitrary values for this `NotificationUserInput` object.
`boolean`	`marshalling(Parcel out)`	Marshals a `NotificationUserInput` object into a `Parcel`.
`static void`	`setInputsSource(Intent intent, NotificationConstant.InputsSource source)`	Sets the input source of this `NotificationUserInput` object.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals a `NotificationUserInput` object from a `Parcel`.

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

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - PRODUCER
```
public static final Sequenceable.Producer<NotificationUserInput> PRODUCER
```
    Creates a NotificationUserInput instance from a Parcel.
    
    从以下版本开始:
    
    4
- 方法详细资料
  - addMimeInputToIntent
```
public static void addMimeInputToIntent(NotificationUserInput userInput,
                                        Intent intent,
                                        Map<String,Uri> results)
```
    Adds the given NotificationUserInput object of a specified MIME type to an Intent. This method is similar to addInputsToIntent(java.util.List<ohos.event.notification.NotificationUserInput>, ohos.aafwk.content.Intent, ohos.utils.PacMap) except that the MIME type must be specified.
    
    参数:
    
    userInput - Indicates the NotificationUserInput object for which the input results are provided.
    
    intent - Indicates the Intent to which the input results are to be added.
    
    results - Indicates a map containing the MIME type and its URI result.
    
    从以下版本开始:
    
    3
  - addInputsToIntent
```
public static void addInputsToIntent(List<NotificationUserInput> userInputs,
                                     Intent intent,
                                     PacMap pacMap)
```
    Adds a list of NotificationUserInput objects to an Intent. This method should only be called by user input collection services when sending input results to an IntentAgent.
    
    参数:
    
    userInputs - Indicates the list of NotificationUserInput objects for which the input results are provided.
    
    intent - Indicates the Intent to which the input results are to be added.
    
    pacMap - Indicates the PacMap object holding the input results. The PacMap key must match the keys contained in the objects specified in userInputs.
    
    从以下版本开始:
    
    3
  - getMimeInputsFromIntent
```
public static Map<String,Uri> getMimeInputsFromIntent(Intent intent,
                                                      String inputKey)
```
    Obtains the input results of a particular MIME type from a specified ohos.aafwk.content.Intent. This method is similar to getInputsFromIntent(ohos.aafwk.content.Intent) but uses the key of the NotificationUserInput.
    
    参数:
    
    intent - Indicates the Intent containing the user input results.
    
    inputKey - Indicates the key of the NotificationUserInput results to obtain.
    
    返回:
    
    Returns a map containing the MIME type and its URI result.
    
    从以下版本开始:
    
    3
  - getInputsFromIntent
```
public static PacMap getInputsFromIntent(Intent intent)
```
    Obtains the input text results from a specified ohos.aafwk.content.Intent.
    
    参数:
    
    intent - Indicates the Intent object containing one or more user input results.
    
    返回:
    
    Returns the PacMap object containing the input text results.
    
    从以下版本开始:
    
    3
  - setInputsSource
```
public static void setInputsSource(Intent intent,
                                   NotificationConstant.InputsSource source)
```
    Sets the input source of this NotificationUserInput object.
    
    参数:
    
    intent - Indicates the Intent to which the input result is to be added.
    
    source - Indicates the input source. For available values, see NotificationConstant.InputsSource.
    
    从以下版本开始:
    
    3
  - getInputsSource
```
public static int getInputsSource(Intent intent)
```
    Obtains the input source of this NotificationUserInput object.
    
    参数:
    
    intent - Indicates the Intent containing the input result.
    
    返回:
    
    Returns the input source of this NotificationUserInput object, as enumerated in NotificationConstant.InputsSource.
    
    从以下版本开始:
    
    3
  - getInputKey
```
public String getInputKey()
```
    Obtains the key of this NotificationUserInput object.
    
    返回:
    
    Returns the key of this NotificationUserInput object.
    
    从以下版本开始:
    
    3
  - getTag
```
public String getTag()
```
    Obtains the tag to be displayed to the user when collecting this input from the user.
    
    返回:
    
    Returns the tag to be displayed to the user.
    
    从以下版本开始:
    
    3
  - getOptions
```
public List<String> getOptions()
```
    Obtains the options provided to the user to satisfy user input needs.
    
    返回:
    
    Returns the list of predefined options.
    
    从以下版本开始:
    
    3
  - getPermitMimeTypes
```
public Set<String> getPermitMimeTypes()
```
    Obtains the MIME types allowed by this NotificationUserInput object.
    
    返回:
    
    Returns the list of allowed MIME types.
    
    从以下版本开始:
    
    3
  - getAdditionalData
```
public PacMap getAdditionalData()
```
    Obtains the additional data included in this NotificationUserInput object.
    
    返回:
    
    Returns the additional data in this NotificationUserInput object.
    
    从以下版本开始:
    
    3
  - isPermitFreeFormInput
```
public boolean isPermitFreeFormInput()
```
    Checks whether users can provide arbitrary values for this NotificationUserInput object.
    
    返回:
    
    Returns true if this object allows arbitrary values; returns false otherwise.
    
    从以下版本开始:
    
    3
  - isMimeTypeOnly
```
public boolean isMimeTypeOnly()
```
    Checks whether this NotificationUserInput object allows only values of particular MIME types.
    
    返回:
    
    Returns true if this object allows only values of particular MIME types; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getEditType
```
public int getEditType()
```
    Obtains the edit type of the options provided by this NotificationUserInput object.
    
    返回:
    
    Returns the edit type of options.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    NotificationConstant.InputEditType
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals a NotificationUserInput object into a Parcel.
    A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a NotificationUserInput object from a Parcel to implement inter-process communication (IPC).
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals a NotificationUserInput object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
    
    从以下版本开始:
    
    4

类 NotificationUserInput

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

方法概要

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

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

PRODUCER

方法详细资料

addMimeInputToIntent

addInputsToIntent

getMimeInputsFromIntent

getInputsFromIntent

setInputsSource

getInputsSource

getInputKey

getTag

getOptions

getPermitMimeTypes

getAdditionalData

isPermitFreeFormInput

isMimeTypeOnly

getEditType

marshalling

unmarshalling

toString