1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* Copyright (c) 2019 Livio, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Livio Inc. nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.managers.lockscreen;
import androidx.annotation.IntDef;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* <strong>LockScreenConfig</strong> <br>
*
* This is set during SdlManager instantiation. <br>
*
* <li> enable - if false, don't worry about the other parameters. You are responsible for creating and managing a lockscreen.
* If true, also set the backgroundColor and appIcon if you want. If you don't set the backgroundColor or appIcon, it will use the defaults.</li>
*
* <li> backgroundColor - if using the default lockscreen, you can set this to a color of your choosing </li>
*
* <li> appIcon - if using the default lockscreen, you can set your own app icon</li>
*
* <li> customView - If you would like to provide your own view, you can pass it in here.</li>
*
* <li> deviceLogo - On by default. If available, will show the device or OEMs logo on the lockscreen</li>
*
* <li> displayMode - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.</li>
*
* <li> enableDismissGesture - If true, then the lock screen can be dismissed with a downward swipe on compatible head units.
* Requires a connection of SDL 6.0+ and the head unit to enable the feature. Defaults to true.</li>
*/
public class LockScreenConfig {
private boolean enable, deviceLogo, enableDismissGesture;
private int backgroundColor, appIconInt, customViewInt;
private @DisplayMode int displayMode;
/**
* DISPLAY_MODE_NEVER - The lock screen should never be shown. This should almost always mean that you will build your own lock screen.
* DISPLAY_MODE_REQUIRED_ONLY - The lock screen should only be shown when it is required by the head unit.
* DISPLAY_MODE_OPTIONAL_OR_REQUIRED - The lock screen should be shown when required by the head unit or when the head unit says that
* its optional, but *not* in other cases, such as before the user has interacted with your app on the head unit.
* DISPLAY_MODE_ALWAYS - The lock screen should always be shown after connection.
*/
@IntDef({DISPLAY_MODE_NEVER, DISPLAY_MODE_REQUIRED_ONLY, DISPLAY_MODE_OPTIONAL_OR_REQUIRED, DISPLAY_MODE_ALWAYS})
@Retention(RetentionPolicy.SOURCE)
public @interface DisplayMode {}
public static final int DISPLAY_MODE_NEVER = 0;
public static final int DISPLAY_MODE_REQUIRED_ONLY = 1;
public static final int DISPLAY_MODE_OPTIONAL_OR_REQUIRED = 2;
public static final int DISPLAY_MODE_ALWAYS = 3;
public LockScreenConfig(){
// set default values
this.enable = true;
this.deviceLogo = true;
this.displayMode = DISPLAY_MODE_REQUIRED_ONLY;
this.enableDismissGesture = true;
}
/**
* If set to true, SDL will manage the showing and dismissing of the lock screen for you. <br>
*
* If false, you must manage the lock screen
* @param enable boolean
*
* @deprecated to disable the lockscreen, use setDisplayMode with DISPLAY_MODE_NEVER instead
*/
@Deprecated
public void setEnabled(boolean enable){
this.enable = enable;
}
/**
* Gets whether the lock screen is being managed for you
* @return boolean
*
* @deprecated to disable the lockscreen, use setDisplayMode with DISPLAY_MODE_NEVER instead
*/
@Deprecated
public boolean isEnabled() {
return enable;
}
/**
* Set the resource int of the background color. Colors should define colors in your Colors.xml file
* @param resourceColor resource int of the color
*/
public void setBackgroundColor(int resourceColor){
this.backgroundColor = resourceColor;
}
/**
* Gets the int reference to the custom lock screen background color
* @return the color reference
*/
public int getBackgroundColor() {
return backgroundColor;
}
/**
* int of the drawable icon.
* @param appIconInt the drawable of the icon to be displayed on the lock screen
*/
public void setAppIcon(int appIconInt) {
this.appIconInt = appIconInt;
}
/**
* Gets the resource reference of the icon to be displayed on the lock screen
* @return the icon reference
*/
public int getAppIcon() {
return appIconInt;
}
/**
* Sets the reference to the custom layout to be used for the lock screen <br>
* <strong>If set, the color and icon setters will be ignored</strong>
* @param customViewInt the layout
*/
public void setCustomView(int customViewInt) {
this.customViewInt = customViewInt;
}
/**
* Gets the reference to the custom lockscreen layout to be used
* @return the layout reference
*/
public int getCustomView() {
return customViewInt;
}
/**
* Whether or not to show the device's logo on the default lock screen <br>
* The logo will come from the connected hardware, if set by the manufacturer <br>
* If using a Custom View, this will be ignored.
* @param deviceLogo - boolean
*/
public void showDeviceLogo(boolean deviceLogo) {
this.deviceLogo = deviceLogo;
}
/**
* Get whether or not the device's Logo is shown on the default lock screen <br>
* The logo will come from the connected hardware, if set by the manufacturer <br>
* @return deviceLogo - boolean
*/
public boolean isDeviceLogoEnabled() {
return deviceLogo;
}
/**
* Set the displayMode to be used
* @param displayMode - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.
*/
public void setDisplayMode(@DisplayMode int displayMode){
this.displayMode = displayMode;
}
/**
* Get the displayMode to be used
* @return displayMode - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.
*/
public @DisplayMode int getDisplayMode(){
return this.displayMode;
}
/**
* If true, then the lock screen can be dismissed with a downward swipe on compatible head units.
* Requires a connection of SDL 6.0+ and the head unit to enable the feature. Defaults to true.
* @param enableDismissGesture - enable or disable this feature
*/
public void enableDismissGesture(boolean enableDismissGesture) {
this.enableDismissGesture = enableDismissGesture;
}
/**
* If true, then the lock screen can be dismissed with a downward swipe on compatible head units.
* Requires a connection of SDL 6.0+ and the head unit to enable the feature. Defaults to true.
* @return - whether or not this is enabled or disabled
*/
public boolean enableDismissGesture() {
return enableDismissGesture;
}
}
|
