# WearableRemoteInputExtender

Artifact: [androidx.wear:wear-input](https://developer.android.com/jetpack/androidx/releases/wear) [View Source](https://cs.android.com/search?q=file:androidx/wear/input/WearableRemoteInputExtender.kt+class:androidx.wear.input.WearableRemoteInputExtender) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0)

*** ** * ** ***


```
public final class WearableRemoteInputExtender
```

<br />

*** ** * ** ***

Extender for Wear-specific extras for a `https://developer.android.com/reference/android/app/RemoteInput.html` instance.

For example, to create a RemoteInput that will allow free form input (e.g. voice input on Wear), but not show the Draw Emoji option:

```kotlin
import androidx.wear.input.wearableExtender

RemoteInput.Builder("resultKey")
    .setAllowFreeFormInput(true)
    .wearableExtender {
        setEmojisAllowed(false)
        setInputActionType(EditorInfo.IME_ACTION_GO)
    }
    .build()
```

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender#WearableRemoteInputExtender(android.app.RemoteInput.Builder)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/app/RemoteInput.Builder.html remoteInput)` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/app/RemoteInput.Builder.html` | `https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender#get()()` Returns the `https://developer.android.com/reference/android/app/RemoteInput.Builder.html` with set options. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender` | `https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender#setEmojisAllowed(kotlin.Boolean)(boolean emojisAllowed)` Adding extra to a `https://developer.android.com/reference/android/app/RemoteInput.html` for allowing or disallowing showing emoji-only options (e.g. the Draw Emoji option). |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender` | `https://developer.android.com/reference/androidx/wear/input/WearableRemoteInputExtender#setInputActionType(kotlin.Int)(int imeActionType)` Adding specified input action type to a `https://developer.android.com/reference/android/app/RemoteInput.html` to modify the action type of the RemoteInput session (e.g. "send" or "search"). |

## Public constructors

### WearableRemoteInputExtender

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0)

```
public WearableRemoteInputExtender(@NonNull RemoteInput.Builder remoteInput)
```

## Public methods

### get

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0)

```
public final @NonNull RemoteInput.Builder get()
```

Returns the `https://developer.android.com/reference/android/app/RemoteInput.Builder.html` with set options.

### setEmojisAllowed

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0)

```
public final @NonNull WearableRemoteInputExtender setEmojisAllowed(boolean emojisAllowed)
```

Adding extra to a `https://developer.android.com/reference/android/app/RemoteInput.html` for allowing or disallowing showing emoji-only options (e.g. the Draw Emoji option).

If set to false, the Draw Emoji option will not be shown. If set to true or not set, the Draw Emoji option will be shown as long as the `https://developer.android.com/reference/android/app/RemoteInput.html` allows free form input.

| Parameters |
|---|---|
| `boolean emojisAllowed` | Whether the emoji-only options is shown. If not set, it will be allowed. |

### setInputActionType

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0)

```
public final @NonNull WearableRemoteInputExtender setInputActionType(int imeActionType)
```

Adding specified input action type to a `https://developer.android.com/reference/android/app/RemoteInput.html` to modify the action type of the RemoteInput session (e.g. "send" or "search"). The default action type is "send."

| Parameters |
|---|---|
| `int imeActionType` | Action type to be set on RemoteInput session. Should be one of the following values: `https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_SEND`, `https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_SEARCH`, `https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_DONE`, `https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_GO`. If not, send action will be set. |