Files
app_Settings/src/com/android/settings/dashboard/suggestions/SuggestionFeatureProvider.java
Fan Zhang cd7b13bba5 Plumb SuggestionControllerMixin to DismissController.
- The SuggestionControllerMixin is needed to dismiss a suggestion.
- When swipe a suggestion, SuggestionControllerMixin is called, which
  then calls API in SuggestionService to dismiss a suggestion.

Bug: 65065268
Test: robotests
Change-Id: I6a0c5823d60b995ab4a36b1c91777f5cd31a500d
2017-09-26 14:09:22 -07:00

99 lines
3.1 KiB
Java

/*
* Copyright (C) 2017 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.settings.dashboard.suggestions;
import android.content.ComponentName;
import android.content.Context;
import android.content.SharedPreferences;
import android.service.settings.suggestions.Suggestion;
import android.support.annotation.NonNull;
import com.android.settingslib.drawer.Tile;
import com.android.settingslib.suggestions.SuggestionParser;
import java.util.List;
/** Interface should be implemented if you have added new suggestions */
public interface SuggestionFeatureProvider {
/**
* Whether or not the whole suggestion feature is enabled.
*
* @deprecated in favor of {@link #isSuggestionV2Enabled(Context)}
*/
@Deprecated
boolean isSuggestionEnabled(Context context);
/**
* Whether or not the suggestion v2 feature is enabled.
*/
boolean isSuggestionV2Enabled(Context context);
/**
* Returns the component name for SuggestionService.
*/
ComponentName getSuggestionServiceComponent();
/**
* Returns true if smart suggestion should be used instead of xml based SuggestionParser.
*/
boolean isSmartSuggestionEnabled(Context context);
/** Return true if the suggestion has already been completed and does not need to be shown */
boolean isSuggestionCompleted(Context context, @NonNull ComponentName suggestion);
/**
* Returns the {@link SharedPreferences} that holds metadata for suggestions.
*/
SharedPreferences getSharedPrefs(Context context);
/**
* Ranks the list of suggestions in place.
*
* @param suggestions List of suggestion Tiles
* @param suggestionIds List of suggestion ids corresponding to the suggestion tiles.
* @deprecated in favor of SettingsIntelligence
*/
@Deprecated
void rankSuggestions(final List<Tile> suggestions, List<String> suggestionIds);
/**
* Only keep top few suggestions from exclusive suggestions.
*/
void filterExclusiveSuggestions(List<Tile> suggestions);
/**
* Dismisses a suggestion.
*
* @deprecated in favor of {@link #dismissSuggestion(Context, SuggestionControllerMixin,
* Suggestion)}
*/
@Deprecated
void dismissSuggestion(Context context, SuggestionParser parser, Tile suggestion);
/**
* Dismisses a suggestion.
*/
void dismissSuggestion(Context context, SuggestionControllerMixin suggestionMixin,
Suggestion suggestion);
/**
* Returns an identifier for the suggestion
*/
String getSuggestionIdentifier(Context context, Tile suggestion);
}