The Wayback Machine - https://web.archive.org/web/20160416112214/http://developer.android.com/reference/android/app/RemoteInput.Builder.html

RemoteInput.Builder

Developer Console

fullscreen Use Tree Navigation

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

Added in API level 20

public static final class

RemoteInput.Builder

extends Object

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

Class Overview

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public RemoteInput.Builder (String resultKey)

Added in API level 20

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

public RemoteInput.Builder addExtras (Bundle extras)

Added in API level 20

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()

public RemoteInput build ()

Added in API level 20

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

Returns
`RemoteInput`

public Bundle getExtras ()

Added in API level 20

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

Returns
`Bundle`

public RemoteInput.Builder setAllowFreeFormInput (boolean allowFreeFormInput)

Added in API level 20

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

public RemoteInput.Builder setChoices (CharSequence[] choices)

Added in API level 20

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

public RemoteInput.Builder setLabel (CharSequence label)

Added in API level 20

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

Mar	APR	May
	16
2015	2016	2017

Results

Interfaces

Classes

Exceptions

RemoteInput.Builder

Class Overview

Summary

Public Constructors

public RemoteInput.Builder (String resultKey)

Public Methods

public RemoteInput.Builder addExtras (Bundle extras)

public RemoteInput build ()

public Bundle getExtras ()

public RemoteInput.Builder setAllowFreeFormInput (boolean allowFreeFormInput)

public RemoteInput.Builder setChoices (CharSequence[] choices)

public RemoteInput.Builder setLabel (CharSequence label)