Skip to content

Most visited

Recently visited

navigation

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 setAllowDataType(String mimeType, boolean doAllow)

Specifies whether the user can provide arbitrary values.

RemoteInput.Builder setAllowFreeFormInput(boolean allowFreeFormTextInput)

Specifies whether the user can provide arbitrary text 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

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:

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

setAllowDataType

added in API level 26
RemoteInput.Builder setAllowDataType (String mimeType, 
                boolean doAllow)

Specifies whether the user can provide arbitrary values. This allows an input to accept non-textual values. Examples of usage are an input that wants audio or an image.

Parameters
mimeType String: A mime type that results are allowed to come in. Be aware that text results (see setAllowFreeFormInput(boolean) are allowed by default. If you do not want text results you will have to pass false to setAllowFreeFormInput.

doAllow boolean: Whether the mime type should be allowed or not.

Returns
RemoteInput.Builder this object for method chaining

setAllowFreeFormInput

added in API level 20
RemoteInput.Builder setAllowFreeFormInput (boolean allowFreeFormTextInput)

Specifies whether the user can provide arbitrary text values.

Parameters
allowFreeFormTextInput boolean: The default is true. If you specify false, you must either provide a non-null and non-empty array to setChoices(CharSequence[]), or enable a data result in setAllowDataType. Otherwise 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

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.