public
static
final
class
RemoteInput.Builder
extends Object
| java.lang.Object | |
| ↳ | android.app.RemoteInput.Builder |
Builder class for RemoteInput objects.
Public constructors | |
|---|---|
RemoteInput.Builder(String resultKey)
Create a builder object for |
|
Public methods | |
|---|---|
RemoteInput.Builder
|
addExtras(Bundle extras)
Merge additional metadata into this builder. |
RemoteInput
|
build()
Combine all of the options that have been set and return a new |
Bundle
|
getExtras()
Get the metadata Bundle used by this Builder. |
RemoteInput.Builder
|
setAllowFreeFormInput(boolean allowFreeFormInput)
Specifies whether the user can provide arbitrary values. |
RemoteInput.Builder
|
setChoices(CharSequence[] choices)
Specifies choices available to the user to satisfy this input. |
RemoteInput.Builder
|
setLabel(CharSequence label)
Set a label to be displayed to the user when collecting this input. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
RemoteInput.Builder (String resultKey)
Create a builder object for RemoteInput objects.
| Parameters | |
|---|---|
resultKey |
String:
the Bundle key that refers to this input when collected from the user
|
RemoteInput.Builder addExtras (Bundle extras)
Merge additional metadata into this builder.
Values within the Bundle will replace existing extras values in this Builder.
| Parameters | |
|---|---|
extras |
Bundle
|
| Returns | |
|---|---|
RemoteInput.Builder |
|
See also:
RemoteInput build ()
Combine all of the options that have been set and return a new RemoteInput
object.
| Returns | |
|---|---|
RemoteInput |
|
Bundle getExtras ()
Get the metadata Bundle used by this Builder.
The returned Bundle is shared with this Builder.
| Returns | |
|---|---|
Bundle |
|
RemoteInput.Builder setAllowFreeFormInput (boolean allowFreeFormInput)
Specifies whether the user can provide arbitrary values.
| Parameters | |
|---|---|
allowFreeFormInput |
boolean:
The default is true.
If you specify false, you must provide a non-null
and non-empty array to setChoices(CharSequence[]) or an
IllegalArgumentException is thrown. |
| Returns | |
|---|---|
RemoteInput.Builder |
this object for method chaining |
RemoteInput.Builder setChoices (CharSequence[] choices)
Specifies choices available to the user to satisfy this input.
| Parameters | |
|---|---|
choices |
CharSequence:
an array of pre-defined choices for users input.
You must provide a non-null and non-empty array if
you disabled free form input using setAllowFreeFormInput(boolean). |
| Returns | |
|---|---|
RemoteInput.Builder |
this object for method chaining |
RemoteInput.Builder setLabel (CharSequence label)
Set a label to be displayed to the user when collecting this input.
| Parameters | |
|---|---|
label |
CharSequence:
The label to show to users when they input a response. |
| Returns | |
|---|---|
RemoteInput.Builder |
this object for method chaining |
Developers