# RemoteInput.Builder added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1 Summary:[Ctors](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#) # RemoteInput.Builder | This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings). ` public static final class RemoteInput.Builder ` ` extends Object `` ` |---|--------------------------------------------| | java.lang.Object || | ↳ | android.support.v4.app.RemoteInput.Builder |
*** ** * ** *** Builder class for[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput)objects. ## Summary | ### Public constructors || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#RemoteInput.Builder(java.lang.String))`(String resultKey) ` Create a builder object for[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput)objects. | | ### Public methods || |--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | ` `[addExtras](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#addExtras(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` extras) ` Merge additional metadata into this builder. | | ` `[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput) | ` `[build](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#build())`() ` Combine all of the options that have been set and return a new[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput)object. | | ` `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[getExtras](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#getExtras())`() ` Get the metadata Bundle used by this Builder. | | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | ` `[setAllowDataType](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setAllowDataType(java.lang.String, boolean))`(String mimeType, boolean doAllow) ` Specifies whether the user can provide arbitrary values. | | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | ` `[setAllowFreeFormInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setAllowFreeFormInput(boolean))`(boolean allowFreeFormTextInput) ` Specifies whether the user can provide arbitrary text values. | | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | ` `[setChoices](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setChoices(java.lang.CharSequence[]))`(CharSequence[] choices) ` Specifies choices available to the user to satisfy this input. | | ` `[RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | ` `[setLabel](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setLabel(java.lang.CharSequence))`(CharSequence label) ` Set a label to be displayed to the user when collecting this input. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | || ## Public constructors ### RemoteInput.Builder added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` RemoteInput.Builder (String resultKey) ``` Create a builder object for[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput)objects.
| Parameters || |-------------|----------------------------------------------------------------------------------------| | `resultKey` | `String`: the Bundle key that refers to this input when collected from the user
| ## Public methods ### addExtras added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) |
| **See also:** - [getExtras()](https://developer.android.com/reference/android/support/v4/app/RemoteInput#getExtras()) ### build added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` RemoteInput build () ``` Combine all of the options that have been set and return a new[RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput)object.
| Returns || |-------------------------------------------------------------------------------------------|--------| | [RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput) |
| ### getExtras added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Bundle getExtras () ``` Get the metadata Bundle used by this Builder. The returned Bundle is shared with this Builder.
| Returns || |--------------------------------------------------------------------------|--------| | [Bundle](https://developer.android.com/reference/android/os/Bundle.html) |
| ### setAllowDataType added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` RemoteInput.Builder setAllowDataType (String mimeType, boolean doAllow) ``` Specifies whether the user can provide arbitrary values.
| Parameters || |------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mimeType` | `String`: A mime type that results are allowed to come in. Be aware that text results (see[setAllowFreeFormInput(boolean)](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#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](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | this object for method chaining
| ### setAllowFreeFormInput added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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[])](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setChoices(java.lang.CharSequence[])), or enable a data result in`setAllowDataType`. Otherwise an[IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException)is thrown.
| | Returns || |-----------------------------------------------------------------------------------------------------------|----------------------------------------| | [RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | this object for method chaining
| ### setChoices added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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)](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder#setAllowFreeFormInput(boolean)).
| | Returns || |-----------------------------------------------------------------------------------------------------------|----------------------------------------| | [RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | this object for method chaining
| ### setLabel added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) | this object for method chaining
| - ## Annotations - [NotificationCompat.Action.SemanticAction](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Action.SemanticAction) - ## Interfaces - [ActionBarDrawerToggle.Delegate](https://developer.android.com/reference/android/support/v4/app/ActionBarDrawerToggle.Delegate) - [ActionBarDrawerToggle.DelegateProvider](https://developer.android.com/reference/android/support/v4/app/ActionBarDrawerToggle.DelegateProvider) - [ActivityCompat.OnRequestPermissionsResultCallback](https://developer.android.com/reference/android/support/v4/app/ActivityCompat.OnRequestPermissionsResultCallback) - [ActivityCompat.PermissionCompatDelegate](https://developer.android.com/reference/android/support/v4/app/ActivityCompat.PermissionCompatDelegate) - [FragmentManager.BackStackEntry](https://developer.android.com/reference/android/support/v4/app/FragmentManager.BackStackEntry) - [FragmentManager.OnBackStackChangedListener](https://developer.android.com/reference/android/support/v4/app/FragmentManager.OnBackStackChangedListener) - [LoaderManager.LoaderCallbacks](https://developer.android.com/reference/android/support/v4/app/LoaderManager.LoaderCallbacks) - [NotificationCompat.Action.Extender](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Action.Extender) - [NotificationCompat.Extender](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Extender) - [SharedElementCallback.OnSharedElementsReadyListener](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback.OnSharedElementsReadyListener) - [TaskStackBuilder.SupportParentable](https://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.SupportParentable) - ## Classes - [ActionBarDrawerToggle](https://developer.android.com/reference/android/support/v4/app/ActionBarDrawerToggle) - [ActivityCompat](https://developer.android.com/reference/android/support/v4/app/ActivityCompat) - [ActivityManagerCompat](https://developer.android.com/reference/android/support/v4/app/ActivityManagerCompat) - [ActivityOptionsCompat](https://developer.android.com/reference/android/support/v4/app/ActivityOptionsCompat) - [AlarmManagerCompat](https://developer.android.com/reference/android/support/v4/app/AlarmManagerCompat) - [AppLaunchChecker](https://developer.android.com/reference/android/support/v4/app/AppLaunchChecker) - [AppOpsManagerCompat](https://developer.android.com/reference/android/support/v4/app/AppOpsManagerCompat) - [BundleCompat](https://developer.android.com/reference/android/support/v4/app/BundleCompat) - [DialogFragment](https://developer.android.com/reference/android/support/v4/app/DialogFragment) - [Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) - [Fragment.SavedState](https://developer.android.com/reference/android/support/v4/app/Fragment.SavedState) - [FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity) - [FragmentContainer](https://developer.android.com/reference/android/support/v4/app/FragmentContainer) - [FragmentController](https://developer.android.com/reference/android/support/v4/app/FragmentController) - [FragmentHostCallback](https://developer.android.com/reference/android/support/v4/app/FragmentHostCallback) - [FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) - [FragmentManager.FragmentLifecycleCallbacks](https://developer.android.com/reference/android/support/v4/app/FragmentManager.FragmentLifecycleCallbacks) - [FragmentManagerNonConfig](https://developer.android.com/reference/android/support/v4/app/FragmentManagerNonConfig) - [FragmentPagerAdapter](https://developer.android.com/reference/android/support/v4/app/FragmentPagerAdapter) - [FragmentStatePagerAdapter](https://developer.android.com/reference/android/support/v4/app/FragmentStatePagerAdapter) - [FragmentTabHost](https://developer.android.com/reference/android/support/v4/app/FragmentTabHost) - [FragmentTransaction](https://developer.android.com/reference/android/support/v4/app/FragmentTransaction) - [FrameMetricsAggregator](https://developer.android.com/reference/android/support/v4/app/FrameMetricsAggregator) - [JobIntentService](https://developer.android.com/reference/android/support/v4/app/JobIntentService) - [ListFragment](https://developer.android.com/reference/android/support/v4/app/ListFragment) - [LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager) - [NavUtils](https://developer.android.com/reference/android/support/v4/app/NavUtils) - [NotificationCompat](https://developer.android.com/reference/android/support/v4/app/NotificationCompat) - [NotificationCompat.Action](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Action) - [NotificationCompat.Action.Builder](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Action.Builder) - [NotificationCompat.Action.WearableExtender](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Action.WearableExtender) - [NotificationCompat.BigPictureStyle](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.BigPictureStyle) - [NotificationCompat.BigTextStyle](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.BigTextStyle) - [NotificationCompat.Builder](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Builder) - [NotificationCompat.CarExtender](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.CarExtender) - [NotificationCompat.CarExtender.UnreadConversation](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.CarExtender.UnreadConversation) - [NotificationCompat.CarExtender.UnreadConversation.Builder](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.CarExtender.UnreadConversation.Builder) - [NotificationCompat.DecoratedCustomViewStyle](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.DecoratedCustomViewStyle) - [NotificationCompat.InboxStyle](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.InboxStyle) - [NotificationCompat.MessagingStyle](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.MessagingStyle) - [NotificationCompat.MessagingStyle.Message](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.MessagingStyle.Message) - [NotificationCompat.Style](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Style) - [NotificationCompat.WearableExtender](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.WearableExtender) - [NotificationCompatExtras](https://developer.android.com/reference/android/support/v4/app/NotificationCompatExtras) - [NotificationCompatSideChannelService](https://developer.android.com/reference/android/support/v4/app/NotificationCompatSideChannelService) - [NotificationManagerCompat](https://developer.android.com/reference/android/support/v4/app/NotificationManagerCompat) - [RemoteInput](https://developer.android.com/reference/android/support/v4/app/RemoteInput) - [RemoteInput.Builder](https://developer.android.com/reference/android/support/v4/app/RemoteInput.Builder) - [ServiceCompat](https://developer.android.com/reference/android/support/v4/app/ServiceCompat) - [ShareCompat](https://developer.android.com/reference/android/support/v4/app/ShareCompat) - [ShareCompat.IntentBuilder](https://developer.android.com/reference/android/support/v4/app/ShareCompat.IntentBuilder) - [ShareCompat.IntentReader](https://developer.android.com/reference/android/support/v4/app/ShareCompat.IntentReader) - [SharedElementCallback](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback) - [TaskStackBuilder](https://developer.android.com/reference/android/support/v4/app/TaskStackBuilder) - ## Exceptions - [Fragment.InstantiationException](https://developer.android.com/reference/android/support/v4/app/Fragment.InstantiationException)