1 /*
2  * Copyright (C) 2020 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.server.timezonedetector;
18 
19 import android.annotation.NonNull;
20 
21 /**
22  * The internal (in-process) system server API for the {@link
23  * com.android.server.timezonedetector.TimeZoneDetectorService}.
24  *
25  * <p>The methods on this class can be called from any thread.
26  * @hide
27  */
28 public interface TimeZoneDetectorInternal extends Dumpable.Container {
29 
30     /** Adds a listener that will be invoked when {@link ConfigurationInternal} may have changed. */
addConfigurationListener(@onNull ConfigurationChangeListener listener)31     void addConfigurationListener(@NonNull ConfigurationChangeListener listener);
32 
33     /**
34      * Removes a listener previously added via {@link
35      * #addConfigurationListener(ConfigurationChangeListener)}.
36      */
removeConfigurationListener(@onNull ConfigurationChangeListener listener)37     void removeConfigurationListener(@NonNull ConfigurationChangeListener listener);
38 
39     /**
40      * Returns a snapshot of the {@link ConfigurationInternal} for the current user. This is only a
41      * snapshot so callers must use {@link #addConfigurationListener(ConfigurationChangeListener)}
42      * to be notified when it changes.
43      */
44     @NonNull
getCurrentUserConfigurationInternal()45     ConfigurationInternal getCurrentUserConfigurationInternal();
46 
47     /**
48      * Suggests the current time zone, determined using geolocation, to the detector. The
49      * detector may ignore the signal based on system settings, whether better information is
50      * available, and so on. This method may be implemented asynchronously.
51      */
suggestGeolocationTimeZone(@onNull GeolocationTimeZoneSuggestion timeZoneSuggestion)52     void suggestGeolocationTimeZone(@NonNull GeolocationTimeZoneSuggestion timeZoneSuggestion);
53 
54     /** Generates a state snapshot for metrics. */
55     @NonNull
generateMetricsState()56     MetricsTimeZoneDetectorState generateMetricsState();
57 }
58