1 /* 2 * Copyright (C) 2017 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License 15 */ 16 17 package com.android.settings.dashboard.suggestions; 18 19 import android.content.ComponentName; 20 import android.content.Context; 21 import android.content.SharedPreferences; 22 23 import androidx.annotation.NonNull; 24 import androidx.fragment.app.Fragment; 25 26 /** Interface should be implemented if you have added new suggestions */ 27 public interface SuggestionFeatureProvider { 28 29 /** 30 * Whether or not the whole suggestion feature is enabled. 31 */ isSuggestionEnabled(Context context)32 boolean isSuggestionEnabled(Context context); 33 34 /** 35 * Returns the component name for SuggestionService. 36 */ getSuggestionServiceComponent()37 ComponentName getSuggestionServiceComponent(); 38 39 /** Return true if the suggestion has already been completed and does not need to be shown */ isSuggestionComplete(Context context, @NonNull ComponentName suggestion)40 boolean isSuggestionComplete(Context context, @NonNull ComponentName suggestion); 41 42 /** 43 * Returns the {@link SharedPreferences} that holds metadata for suggestions. 44 */ getSharedPrefs(Context context)45 SharedPreferences getSharedPrefs(Context context); 46 47 /** 48 * Returns the class of {@link Fragment} that supports contextual suggestion. 49 */ getContextualSuggestionFragment()50 Class<? extends Fragment> getContextualSuggestionFragment(); 51 } 52