public interface

InputCallbackDelegate

 androidx.car.app.model.InputCallbackDelegate

Subclasses:

InputCallbackDelegateImpl

Gradle dependencies

compile group: 'androidx.car.app', name: 'app', version: '1.2.0-rc01'

  • groupId: androidx.car.app
  • artifactId: app
  • version: 1.2.0-rc01

Artifact androidx.car.app:app:1.2.0-rc01 it located at Google repository (https://maven.google.com/)

Overview

A host-side delegate for sending InputCallback events to the car app.

Summary

Methods
public voidsendInputSubmitted(java.lang.String value, OnDoneCallback callback)

Notifies that the user has submitted the text.

public voidsendInputTextChanged(java.lang.String value, OnDoneCallback callback)

Notifies that user input text has changed.

Methods

public void sendInputSubmitted(java.lang.String value, OnDoneCallback callback)

Notifies that the user has submitted the text.

Parameters:

value: the text entered
callback: the OnDoneCallback to trigger when the client finishes handling the event

public void sendInputTextChanged(java.lang.String value, OnDoneCallback callback)

Notifies that user input text has changed.

Parameters:

value: the text entered
callback: the OnDoneCallback to trigger when the client finishes handling the event

Source

/*
 * Copyright 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.car.app.model;

import android.annotation.SuppressLint;

import androidx.annotation.NonNull;
import androidx.car.app.OnDoneCallback;
import androidx.car.app.annotations.RequiresCarApi;

/**
 * A host-side delegate for sending {@link InputCallback} events to the car app.
 */
@RequiresCarApi(2)
public interface InputCallbackDelegate {
    /**
     * Notifies that the user has submitted the text.
     *
     * @param value    the text entered
     * @param callback the {@link OnDoneCallback} to trigger when the client finishes handling
     *                 the event
     */
    // This mirrors the AIDL class and is not supposed to support an executor as an input.
    @SuppressLint("ExecutorRegistration")
    void sendInputSubmitted(@NonNull String value, @NonNull OnDoneCallback callback);

    /**
     * Notifies that user input text has changed.
     *
     * @param value    the text entered
     * @param callback the {@link OnDoneCallback} to trigger when the client finishes handling
     *                 the event
     */
    // This mirrors the AIDL class and is not supposed to support an executor as an input.
    @SuppressLint("ExecutorRegistration")
    void sendInputTextChanged(@NonNull String value, @NonNull OnDoneCallback callback);
}