com.smartdevicelink.proxy.rpc

Class OnDriverDistraction

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnDriverDistraction

All Implemented Interfaces:

Cloneable

public class OnDriverDistraction
extends RPCNotification

Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).

HMI Status Requirements:

HMILevel:
• Can be sent with FULL, LIMITED or BACKGROUND
AudioStreamingState:
• Any
SystemContext:
• Any

Parameter List:

Name	Type	Description	SmartDeviceLink Ver Available
state	DriverDistractionState	Current driver distraction state (i.e. whether driver distraction rules are in effect, or not).	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_LOCKSCREEN_DISMISSIBLE
static String	KEY_LOCKSCREEN_DISMISSIBLE_MSG
static String	KEY_STATE

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnDriverDistraction() Constructs a newly allocated OnDriverDistraction object
OnDriverDistraction(DriverDistractionState state) Constructs a newly allocated OnDriverDistraction object
OnDriverDistraction(Hashtable<String,Object> hash) Constructs a newly allocated OnDriverDistraction object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Boolean	getLockscreenDismissibility() Called to get the dismissible state of Lockscreen
String	getLockscreenWarningMessage() Called to get the lockscreen warning message
DriverDistractionState	getState() Called to get the current driver distraction state(i.e.
OnDriverDistraction	setLockscreenDismissibility(boolean isDismissible) Called to set dismissible state of Lockscreen
OnDriverDistraction	setLockscreenWarningMessage(String msg) Called to set a warning message for the lockscreen
OnDriverDistraction	setState(DriverDistractionState state) Called to set the driver distraction state(i.e.

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_STATE

public static final String KEY_STATE

See Also:

Constant Field Values

KEY_LOCKSCREEN_DISMISSIBLE

public static final String KEY_LOCKSCREEN_DISMISSIBLE

See Also:

Constant Field Values

KEY_LOCKSCREEN_DISMISSIBLE_MSG

public static final String KEY_LOCKSCREEN_DISMISSIBLE_MSG

See Also:

Constant Field Values

Constructor Detail

OnDriverDistraction

public OnDriverDistraction()

Constructs a newly allocated OnDriverDistraction object

OnDriverDistraction

public OnDriverDistraction(Hashtable<String,Object> hash)

Constructs a newly allocated OnDriverDistraction object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnDriverDistraction

public OnDriverDistraction(@NonNull
                           DriverDistractionState state)

Constructs a newly allocated OnDriverDistraction object

Parameters:

state - the current driver distraction state

Method Detail

getState

public DriverDistractionState getState()

Called to get the current driver distraction state(i.e. whether driver distraction rules are in effect, or not)

Returns:

DriverDistractionState the Current driver distraction state.

setState

public OnDriverDistraction setState(@NonNull
                                    DriverDistractionState state)

Called to set the driver distraction state(i.e. whether driver distraction rules are in effect, or not)

Parameters:

state - the current driver distraction state

setLockscreenDismissibility

public OnDriverDistraction setLockscreenDismissibility(boolean isDismissible)

Called to set dismissible state of Lockscreen

Parameters:

isDismissible - the Lockscreen's dismissibility

getLockscreenDismissibility

public Boolean getLockscreenDismissibility()

Called to get the dismissible state of Lockscreen

Returns:

true if the Lockscreen is dismissible, false otherwise

setLockscreenWarningMessage

public OnDriverDistraction setLockscreenWarningMessage(String msg)

Called to set a warning message for the lockscreen

Parameters:

msg - the message to be set

getLockscreenWarningMessage

public String getLockscreenWarningMessage()

Called to get the lockscreen warning message

Returns:

warning message