Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class OnLockScreenStatus

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCNotification

Package
com.smartdevicelink.proxy.rpc

Overview

The lockscreen must perform the following: Limit all application control usability from the mobile device with a full-screen static image overlay or separate view. For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required. The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.

Fields

KEY_DRIVER_DISTRACTION

public static final java.lang.String KEY_DRIVER_DISTRACTION
Constant Value
"driverDistraction"

KEY_SHOW_LOCK_SCREEN

public static final java.lang.String KEY_SHOW_LOCK_SCREEN
Constant Value
"showLockScreen"

KEY_USER_SELECTED

public static final java.lang.String KEY_USER_SELECTED
Constant Value
"userSelected"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

OnLockScreenStatus()

public OnLockScreenStatus()

Methods

getDriverDistractionStatus()

Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)

public java.lang.Boolean getDriverDistractionStatus()

setDriverDistractionStatus( Boolean driverDistractionStatus )

public void setDriverDistractionStatus(Boolean driverDistractionStatus)

Parameters

driverDistractionStatus

getShowLockScreen()

Get the LockScreenStatus enumeration, indicating if the lockscreen should be required, optional or off

public com.smartdevicelink.proxy.rpc.enums.LockScreenStatus getShowLockScreen()

setShowLockScreen( LockScreenStatus showLockScreen )

public void setShowLockScreen(LockScreenStatus showLockScreen)

Parameters

showLockScreen

getUserSelected()

Get user selection status for the application (has the app been selected via hmi or voice command)

public java.lang.Boolean getUserSelected()

setUserSelected( Boolean userSelected )

public void setUserSelected(Boolean userSelected)

Parameters

userSelected

getHMILevel()

Get HMILevel in effect for the application

public com.smartdevicelink.proxy.rpc.enums.HMILevel getHMILevel()

setHMILevel( HMILevel setHMILevel )

public void setHMILevel(HMILevel setHMILevel)

Parameters

setHMILevel

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section