/*
 * Copyright (C) 2019 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 com.android.systemui.plugins;

import android.graphics.Bitmap;
import android.text.Spanned;

import com.android.systemui.plugins.annotations.ProvidesInterface;

import java.util.ArrayList;

/**
 * Implement this interface to get suggest for one search.
 */
@ProvidesInterface(action = OneSearch.ACTION, version = OneSearch.VERSION)
public interface OneSearch extends Plugin {
    String ACTION = "com.android.systemui.action.PLUGIN_ONE_SEARCH";
    int VERSION = 1;

    /**
     * Get the content provider warmed up.
     */
    void warmUp();

    /**
     * Get the suggests for the query.
     * @param query The query to get the search suggests for.
     */
    ArrayList<Spanned> getSuggests(String query);

    /**
     * Get the image bitmap for the suggest.
     * @param suggest The suggest to get the image bitmap for.
     */
    Bitmap getImageBitmap(Spanned suggest);

    /**
     * Get the subtitle for the suggest.
     * @param suggest The suggest to get the subtitle for.
     */
    String getSubtitle(Spanned suggest);
}