Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
OnDriverDistraction

Class OnDriverDistraction

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_STATE

public static final java.lang.String KEY_STATE
Constant Value
"state"

KEY_LOCKSCREEN_DISMISSIBLE

public static final java.lang.String KEY_LOCKSCREEN_DISMISSIBLE
Constant Value
"lockScreenDismissalEnabled"

KEY_LOCKSCREEN_DISMISSIBLE_MSG

public static final java.lang.String KEY_LOCKSCREEN_DISMISSIBLE_MSG
Constant Value
"lockScreenDismissalWarning"

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

OnDriverDistraction()

Constructs a newly allocated OnDriverDistraction object

public OnDriverDistraction()

OnDriverDistraction( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated OnDriverDistraction object indicated by the Hashtable parameter

public OnDriverDistraction(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

OnDriverDistraction( DriverDistractionState state )

Constructs a newly allocated OnDriverDistraction object

public OnDriverDistraction(DriverDistractionState state)

Constructor Parameters

state
the current driver distraction state

Methods

getState()

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

public com.smartdevicelink.proxy.rpc.enums.DriverDistractionState getState()

setState( DriverDistractionState state )

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

public com.smartdevicelink.proxy.rpc.OnDriverDistraction setState(DriverDistractionState state)

Method Parameters

state
the current driver distraction state

setLockscreenDismissibility( boolean isDismissible )

Called to set dismissible state of Lockscreen

public com.smartdevicelink.proxy.rpc.OnDriverDistraction setLockscreenDismissibility(boolean isDismissible)

Method Parameters

isDismissible
the Lockscreen's dismissibility

getLockscreenDismissibility()

Called to get the dismissible state of Lockscreen

public java.lang.Boolean getLockscreenDismissibility()

setLockscreenWarningMessage( String msg )

Called to set a warning message for the lockscreen

public com.smartdevicelink.proxy.rpc.OnDriverDistraction setLockscreenWarningMessage(String msg)

Method Parameters

msg
the message to be set

getLockscreenWarningMessage()

Called to get the lockscreen warning message

public java.lang.String getLockscreenWarningMessage()

Inherited Methods

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