Most visited

Recently visited

Results for

Added in API level 20

Summary: Ctors | Methods | Inherited Methods | [Expand All]

RemoteInput.Builder

public static final class RemoteInput.Builder
extends Object

java.lang.Object
↳	android.app.RemoteInput.Builder

Builder class for RemoteInput objects.

Summary

Public constructors
`RemoteInput.Builder(String resultKey)` Create a builder object for `RemoteInput` objects.

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 `RemoteInput` object.
`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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

RemoteInput.Builder

Added in API level 20

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

Public methods

addExtras

Added in API level 20

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:

getExtras()

build

Added in API level 20

RemoteInput build ()

Combine all of the options that have been set and return a new RemoteInput object.

Returns
`RemoteInput`

getExtras

Added in API level 20

Bundle getExtras ()

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

Returns
`Bundle`

setAllowFreeFormInput

Added in API level 20

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

setChoices

Added in API level 20

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

setLabel

Added in API level 20

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