LockScreenConfig (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.managers.lockscreen.LockScreenConfig

```
public class LockScreenConfig
extends Object
```
LockScreenConfig

This is set during SdlManager instantiation.
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.
backgroundColor - if using the default lockscreen, you can set this to a color of your choosing
appIcon - if using the default lockscreen, you can set your own app icon
customView - If you would like to provide your own view, you can pass it in here.
deviceLogo - On by default. If available, will show the device or OEMs logo on the lockscreen
displayMode - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.
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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LockScreenConfig.DisplayMode
DISPLAY_MODE_NEVER - The lock screen should never be shown.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LockScreenConfig.DisplayMode` DISPLAY_MODE_NEVER - The lock screen should never be shown.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISPLAY_MODE_ALWAYS`
`static int`	`DISPLAY_MODE_NEVER`
`static int`	`DISPLAY_MODE_OPTIONAL_OR_REQUIRED`
`static int`	`DISPLAY_MODE_REQUIRED_ONLY`

Constructor Summary

Constructors
Constructor and Description

LockScreenConfig()

Constructors
Constructor and Description
`LockScreenConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`enableDismissGesture()` If true, then the lock screen can be dismissed with a downward swipe on compatible head units.
`void`	`enableDismissGesture(boolean enableDismissGesture)` If true, then the lock screen can be dismissed with a downward swipe on compatible head units.
`int`	`getAppIcon()` Gets the resource reference of the icon to be displayed on the lock screen
`int`	`getBackgroundColor()` Gets the int reference to the custom lock screen background color
`int`	`getCustomView()` Gets the reference to the custom lockscreen layout to be used
`int`	`getDisplayMode()` Get the displayMode to be used
`boolean`	`isDeviceLogoEnabled()` Get whether or not the device's Logo is shown on the default lock screen The logo will come from the connected hardware, if set by the manufacturer
`void`	`setAppIcon(int appIconInt)` int of the drawable icon.
`void`	`setBackgroundColor(int resourceColor)` Set the resource int of the background color.
`void`	`setCustomView(int customViewInt)` Sets the reference to the custom layout to be used for the lock screen If set, the color and icon setters will be ignored
`void`	`setDisplayMode(int displayMode)` Set the displayMode to be used
`void`	`showDeviceLogo(boolean deviceLogo)` Whether or not to show the device's logo on the default lock screen The logo will come from the connected hardware, if set by the manufacturer If using a Custom View, this will be ignored.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DISPLAY_MODE_NEVER
```
public static final int DISPLAY_MODE_NEVER
```
    See Also:
    
    Constant Field Values
  - DISPLAY_MODE_REQUIRED_ONLY
```
public static final int DISPLAY_MODE_REQUIRED_ONLY
```
    See Also:
    
    Constant Field Values
  - DISPLAY_MODE_OPTIONAL_OR_REQUIRED
```
public static final int DISPLAY_MODE_OPTIONAL_OR_REQUIRED
```
    See Also:
    
    Constant Field Values
  - DISPLAY_MODE_ALWAYS
```
public static final int DISPLAY_MODE_ALWAYS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LockScreenConfig
```
public LockScreenConfig()
```
- Method Detail
  - setBackgroundColor
```
public void setBackgroundColor(int resourceColor)
```
    Set the resource int of the background color. Colors should define colors in your Colors.xml file
    
    Parameters:
    
    resourceColor - resource int of the color
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Gets the int reference to the custom lock screen background color
    
    Returns:
    
    the color reference
  - setAppIcon
```
public void setAppIcon(int appIconInt)
```
    int of the drawable icon.
    
    Parameters:
    
    appIconInt - the drawable of the icon to be displayed on the lock screen
  - getAppIcon
```
public int getAppIcon()
```
    Gets the resource reference of the icon to be displayed on the lock screen
    
    Returns:
    
    the icon reference
  - setCustomView
```
public void setCustomView(int customViewInt)
```
    Sets the reference to the custom layout to be used for the lock screen
    If set, the color and icon setters will be ignored
    
    Parameters:
    
    customViewInt - the layout
  - getCustomView
```
public int getCustomView()
```
    Gets the reference to the custom lockscreen layout to be used
    
    Returns:
    
    the layout reference
  - showDeviceLogo
```
public void showDeviceLogo(boolean deviceLogo)
```
    Whether or not to show the device's logo on the default lock screen
    The logo will come from the connected hardware, if set by the manufacturer
    If using a Custom View, this will be ignored.
    
    Parameters:
    
    deviceLogo - - boolean
  - isDeviceLogoEnabled
```
public boolean isDeviceLogoEnabled()
```
    Get whether or not the device's Logo is shown on the default lock screen
    The logo will come from the connected hardware, if set by the manufacturer
    
    Returns:
    
    deviceLogo - boolean
  - setDisplayMode
```
public void setDisplayMode(int displayMode)
```
    Set the displayMode to be used
    
    Parameters:
    
    displayMode - - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.
  - getDisplayMode
```
public int getDisplayMode()
```
    Get the displayMode to be used
    
    Returns:
    
    displayMode - Describes when the lock screen will be displayed. Defaults to `DISPLAY_MODE_REQUIRED_ONLY`.
  - enableDismissGesture
```
public void enableDismissGesture(boolean 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.
    
    Parameters:
    
    enableDismissGesture - - enable or disable this feature
  - enableDismissGesture
```
public boolean 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.
    
    Returns:
    
    - whether or not this is enabled or disabled

Class LockScreenConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISPLAY_MODE_NEVER

DISPLAY_MODE_REQUIRED_ONLY

DISPLAY_MODE_OPTIONAL_OR_REQUIRED

DISPLAY_MODE_ALWAYS

Constructor Detail

LockScreenConfig

Method Detail

setBackgroundColor

getBackgroundColor

setAppIcon

getAppIcon

setCustomView

getCustomView

showDeviceLogo

isDeviceLogoEnabled

setDisplayMode

getDisplayMode

enableDismissGesture

enableDismissGesture