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

Quick Jump

Fields

KEY_TEXT1
KEY_TEXT2
KEY_ETA
KEY_TOTAL_DISTANCE
KEY_MANEUVER_DISTANCE
KEY_MANEUVER_DISTANCE_SCALE
KEY_MANEUVER_IMAGE
KEY_NEXT_MANEUVER_IMAGE
KEY_MANEUVER_COMPLETE
KEY_SOFT_BUTTONS
KEY_TIME_TO_DESTINATION

Constructors

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

Methods

setNavigationText1(String navigationText1)
getNavigationText1()
setNavigationText2(String navigationText2)
getNavigationText2()
setEta(String eta)
getEta()
setTotalDistance(String totalDistance)
getTotalDistance()
setTurnIcon(Image turnIcon)
getTurnIcon()
setNextTurnIcon(Image nextTurnIcon)
getNextTurnIcon()
setDistanceToManeuver(Double distanceToManeuver)
getDistanceToManeuver()
setDistanceToManeuverScale(Double distanceToManeuverScale)
getDistanceToManeuverScale()
setManeuverComplete(Boolean maneuverComplete)
getManeuverComplete()
setSoftButtons(java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons)
getSoftButtons()
setTimeToDestination(String timeToDestination)
getTimeToDestination()

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)

Constructor Parameters

hash: The Hashtable to use

Methods

setNavigationText1( String navigationText1 )

Sets a text for navigation text field 1

public com.smartdevicelink.proxy.rpc.ShowConstantTbt setNavigationText1(String navigationText1)

Method 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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setNavigationText2(String navigationText2)

Method 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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setEta(String eta)

Method 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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setTotalDistance(String totalDistance)

Method 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 turn icon

public com.smartdevicelink.proxy.rpc.ShowConstantTbt setTurnIcon(Image turnIcon)

Method Parameters

turnIcon: an Image value

getTurnIcon()

Gets an Image for turn icon

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

setNextTurnIcon( Image nextTurnIcon )

Sets an Image for nextTurnIcon

public com.smartdevicelink.proxy.rpc.ShowConstantTbt setNextTurnIcon(Image nextTurnIcon)

Method Parameters

nextTurnIcon: an Image value

getNextTurnIcon()

Gets an Image for nextTurnIcon

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

setDistanceToManeuver( Double distanceToManeuver )

Sets the distanceToManeuver.

public com.smartdevicelink.proxy.rpc.ShowConstantTbt setDistanceToManeuver(Double distanceToManeuver)

Method Parameters

distanceToManeuver: Distance (in meters) until next maneuver. May be used to calculate progress bar. {"num_min_value": 0.0, "num_max_value": 1000000000.0}

getDistanceToManeuver()

Gets the distanceToManeuver.

public java.lang.Double getDistanceToManeuver()

setDistanceToManeuverScale( Double distanceToManeuverScale )

Sets the distanceToManeuverScale.

public com.smartdevicelink.proxy.rpc.ShowConstantTbt setDistanceToManeuverScale(Double distanceToManeuverScale)

Method Parameters

distanceToManeuverScale: Distance (in meters) from previous maneuver to next maneuver. May be used to calculate progress bar. {"num_min_value": 0.0, "num_max_value": 1000000000.0}

getDistanceToManeuverScale()

Gets the distanceToManeuverScale.

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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setManeuverComplete(Boolean maneuverComplete)

Method 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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setSoftButtons(java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons)

Method 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 com.smartdevicelink.proxy.rpc.ShowConstantTbt setTimeToDestination(String timeToDestination)

Method 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	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