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 package com.android.wallpaper.module; 17 18 import com.android.wallpaper.model.WallpaperMetadata; 19 import com.android.wallpaper.module.WallpaperPreferences.PresentationMode; 20 21 import androidx.annotation.Nullable; 22 23 /** 24 * Interface for classes which refresh stored wallpaper metadata against the currently set 25 * wallpaper. 26 */ 27 public interface WallpaperRefresher { 28 29 /** 30 * Refreshes the wallpaper metadata stored in {@link WallpaperPreferences} against the wallpaper 31 * manager and calls the provided listener with refreshed metadata. 32 */ refresh(RefreshListener listener)33 void refresh(RefreshListener listener); 34 35 /** 36 * Interface for receiving refreshed wallpaper metadata. 37 */ 38 interface RefreshListener { 39 40 /** 41 * Provides metadata representing the current home screen and lock screen wallpaper as well as 42 * the current wallpaper presentation mode. 43 */ onRefreshed(WallpaperMetadata homeWallpaperMetadata, @Nullable WallpaperMetadata lockWallpaperMetadata, @PresentationMode int presentationMode)44 void onRefreshed(WallpaperMetadata homeWallpaperMetadata, 45 @Nullable WallpaperMetadata lockWallpaperMetadata, @PresentationMode int presentationMode); 46 } 47 } 48