public static class

RemoteInput.Builder

extends Object
java.lang.Object
   ↳ android.preview.support.wearable.notifications.RemoteInput.Builder

Class Overview

Builder class for RemoteInput objects.

Summary

Public Constructors
RemoteInput.Builder(String returnKey)
Create a builder object for RemoteInput objects.
Public Methods
RemoteInput build()
Combine all of the options that have been set and return a new RemoteInput object.
RemoteInput.Builder setAllowFreeFormInput(boolean allowFreeFormInput)
Specifies whether the user can provide arbitrary values.
RemoteInput.Builder setChoices(String[] choices)
Specifies choices available to the user to satisfy this input.
RemoteInput.Builder setLabel(String label)
Set a label to be displayed to the user when collecting this input.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RemoteInput.Builder (String returnKey)

Create a builder object for RemoteInput objects.

Parameters
returnKey the intent extras key that refers to the input collected from the user
Returns
  • this object for method chaining

Public Methods

public RemoteInput build ()

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

public RemoteInput.Builder setAllowFreeFormInput (boolean allowFreeFormInput)

Specifies whether the user can provide arbitrary values.

Parameters
allowFreeFormInput The default is true. If you specify false, you must provide a non-null and non-empty array to setChoices(String[]) or an IllegalArgumentException is thrown.
Returns
  • this object for method chaining

public RemoteInput.Builder setChoices (String[] choices)

Specifies choices available to the user to satisfy this input.

Parameters
choices an array of pre-defined choices for users input. You must provide a non-null and non-empty array if you set allowFreeFormInput to false.
Returns
  • this object for method chaining

public RemoteInput.Builder setLabel (String label)

Set a label to be displayed to the user when collecting this input.

Parameters
label The label to show to users when they input a response.
Returns
  • this object for method chaining