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

Class ShowConstantTbt

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert type screen

Function Group: Navigation

HMILevel needs to be FULL, LIMITED or BACKGROUND

Fields

KEY_TEXT1

public static final java.lang.String KEY_TEXT1
Constant Value
"navigationText1"

KEY_TEXT2

public static final java.lang.String KEY_TEXT2
Constant Value
"navigationText2"

KEY_ETA

public static final java.lang.String KEY_ETA
Constant Value
"eta"

KEY_TOTAL_DISTANCE

public static final java.lang.String KEY_TOTAL_DISTANCE
Constant Value
"totalDistance"

KEY_MANEUVER_DISTANCE

public static final java.lang.String KEY_MANEUVER_DISTANCE
Constant Value
"distanceToManeuver"

KEY_MANEUVER_DISTANCE_SCALE

public static final java.lang.String KEY_MANEUVER_DISTANCE_SCALE
Constant Value
"distanceToManeuverScale"

KEY_MANEUVER_IMAGE

public static final java.lang.String KEY_MANEUVER_IMAGE
Constant Value
"turnIcon"

KEY_NEXT_MANEUVER_IMAGE

public static final java.lang.String KEY_NEXT_MANEUVER_IMAGE
Constant Value
"nextTurnIcon"

KEY_MANEUVER_COMPLETE

public static final java.lang.String KEY_MANEUVER_COMPLETE
Constant Value
"maneuverComplete"

KEY_SOFT_BUTTONS

public static final java.lang.String KEY_SOFT_BUTTONS
Constant Value
"softButtons"

KEY_TIME_TO_DESTINATION

public static final java.lang.String KEY_TIME_TO_DESTINATION
Constant Value
"timeToDestination"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
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

ShowConstantTbt()

Constructs a new ShowConstantTbt object

public ShowConstantTbt()

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

Constructs a new ShowConstantTbt object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setNavigationText1( String navigationText1 )

Sets a text for navigation text field 1

public void setNavigationText1(String navigationText1)

Parameters

navigationText1
a String value representing a text for navigation text field 1

Notes: Maxlength=500

getNavigationText1()

Gets a text for navigation text field 1

public java.lang.String getNavigationText1()

setNavigationText2( String navigationText2 )

Sets a text for navigation text field 2

public void setNavigationText2(String navigationText2)

Parameters

navigationText2
a String value representing a text for navigation text field 2

Notes: Maxlength=500

getNavigationText2()

Gets a text for navigation text field 2

public java.lang.String getNavigationText2()

setEta( String eta )

Sets a text field for estimated time of arrival

public void setEta(String eta)

Parameters

eta
a String value representing a text field for estimated time of arrival

Notes: Maxlength=500

getEta()

Gets a text field for estimated time of arrival

public java.lang.String getEta()

setTotalDistance( String totalDistance )

Sets a text field for total distance

public void setTotalDistance(String totalDistance)

Parameters

totalDistance
a String value representing a text field for total distance

Notes: Maxlength=500

getTotalDistance()

Gets a text field for total distance

public java.lang.String getTotalDistance()

setTurnIcon( Image turnIcon )

Sets an Image for turnicon

public void setTurnIcon(Image turnIcon)

Parameters

turnIcon
an Image value

getTurnIcon()

Gets an Image for turnicon

public com.smartdevicelink.proxy.rpc.Image getTurnIcon()

setNextTurnIcon( Image nextTurnIcon )

Sets an Image for nextTurnIcon

public void setNextTurnIcon(Image nextTurnIcon)

Parameters

nextTurnIcon
an Image value

getNextTurnIcon()

Gets an Image for nextTurnIcon

public com.smartdevicelink.proxy.rpc.Image getNextTurnIcon()

setDistanceToManeuver( Double distanceToManeuver )

Sets a Fraction of distance till next maneuver

public void setDistanceToManeuver(Double distanceToManeuver)

Parameters

distanceToManeuver
a Double value representing a Fraction of distance till next maneuver

Notes: Minvalue=0; Maxvalue=1000000000

getDistanceToManeuver()

Gets a Fraction of distance till next maneuver

public java.lang.Double getDistanceToManeuver()

setDistanceToManeuverScale( Double distanceToManeuverScale )

Sets a Distance till next maneuver (starting from) from previous maneuver

public void setDistanceToManeuverScale(Double distanceToManeuverScale)

Parameters

distanceToManeuverScale
a Double value representing a Distance till next maneuver (starting from) from previous maneuver

Notes: Minvalue=0; Maxvalue=1000000000

getDistanceToManeuverScale()

Gets a Distance till next maneuver (starting from) from previous maneuver

public java.lang.Double getDistanceToManeuverScale()

setManeuverComplete( Boolean maneuverComplete )

Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay If omitted the value will be assumed as FALSE

public void setManeuverComplete(Boolean maneuverComplete)

Parameters

maneuverComplete
a Boolean value

getManeuverComplete()

Gets a maneuver complete flag

public java.lang.Boolean getManeuverComplete()

setSoftButtons( java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons )

Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported displays, the currently displayed SoftButton values will not change

Notes: Minsize=0; Maxsize=3

public void setSoftButtons(java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons)

Parameters

softButtons
a List value

getSoftButtons()

Gets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported displays, the currently displayed SoftButton values will not change

public java.util.List getSoftButtons()

setTimeToDestination( String timeToDestination )

public void setTimeToDestination(String timeToDestination)

Parameters

timeToDestination

getTimeToDestination()

public java.lang.String getTimeToDestination()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
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