WearableRemoteInputExtender

public final class WearableRemoteInputExtender


Extender for Wear-specific extras for a RemoteInput 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:

import androidx.wear.input.wearableExtender

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

Summary

Public constructors

Public methods

final @NonNull RemoteInput.Builder
get()

Returns the RemoteInput.Builder with set options.

final @NonNull WearableRemoteInputExtender
setEmojisAllowed(boolean emojisAllowed)

Adding extra to a RemoteInput for allowing or disallowing showing emoji-only options (e.g.

final @NonNull WearableRemoteInputExtender
setInputActionType(int imeActionType)

Adding specified input action type to a RemoteInput to modify the action type of the RemoteInput session (e.g.

Public constructors

WearableRemoteInputExtender

public final WearableRemoteInputExtender(@NonNull RemoteInput.Builder remoteInput)

Public methods

get

@NonNull
public final RemoteInput.Builder get()

Returns the RemoteInput.Builder with set options.

setEmojisAllowed

@NonNull
public final WearableRemoteInputExtender setEmojisAllowed(boolean emojisAllowed)

Adding extra to a RemoteInput 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 RemoteInput allows free form input.

Parameters
boolean emojisAllowed

Whether the emoji-only options is shown. If not set, it will be allowed.

setInputActionType

@NonNull
public final WearableRemoteInputExtender setInputActionType(int imeActionType)

Adding specified input action type to a RemoteInput 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: EditorInfo.IME_ACTION_SEND, EditorInfo.IME_ACTION_SEARCH, EditorInfo.IME_ACTION_DONE, EditorInfo.IME_ACTION_GO. If not, send action will be set.