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.annotation.Nullable; 25 import androidx.fragment.app.Fragment; 26 27 /** Interface should be implemented if you have added new suggestions */ 28 public interface SuggestionFeatureProvider { 29 30 /** 31 * Whether or not the whole suggestion feature is enabled. 32 */ isSuggestionEnabled(Context context)33 boolean isSuggestionEnabled(Context context); 34 35 /** 36 * Returns the component name for SuggestionService. 37 */ getSuggestionServiceComponent()38 ComponentName getSuggestionServiceComponent(); 39 40 /** Return true if the suggestion has already been completed and does not need to be shown */ isSuggestionComplete(Context context, @NonNull ComponentName suggestion)41 boolean isSuggestionComplete(Context context, @NonNull ComponentName suggestion); 42 43 /** 44 * Returns the {@link SharedPreferences} that holds metadata for suggestions. 45 */ getSharedPrefs(Context context)46 SharedPreferences getSharedPrefs(Context context); 47 48 /** 49 * Returns the class of {@link Fragment} that supports contextual suggestion. 50 * 51 * @deprecated - use {@link SuggestionFeatureProvider#getSuggestionFragment()} instead. 52 */ 53 @Deprecated 54 @Nullable getContextualSuggestionFragment()55 default Class<? extends Fragment> getContextualSuggestionFragment() { 56 return null; 57 } 58 59 /** 60 * Returns the class of {@link Fragment} that provides the UI for Suggestions. 61 */ 62 @Nullable getSuggestionFragment()63 default Class<? extends Fragment> getSuggestionFragment() { 64 return getContextualSuggestionFragment(); 65 } 66 } 67