ShowConstantTbt (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.ShowConstantTbt

All Implemented Interfaces:

Cloneable
```
public class ShowConstantTbt
extends RPCRequest
```
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

Since:

SmartDeviceLink 2.0

See Also:

AlertManeuver, UpdateTurnList

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ETA`
`static String`	`KEY_MANEUVER_COMPLETE`
`static String`	`KEY_MANEUVER_DISTANCE`
`static String`	`KEY_MANEUVER_DISTANCE_SCALE`
`static String`	`KEY_MANEUVER_IMAGE`
`static String`	`KEY_NEXT_MANEUVER_IMAGE`
`static String`	`KEY_SOFT_BUTTONS`
`static String`	`KEY_TEXT1`
`static String`	`KEY_TEXT2`
`static String`	`KEY_TIME_TO_DESTINATION`
`static String`	`KEY_TOTAL_DISTANCE`

Fields inherited from class com.smartdevicelink.proxy.RPCRequest
onResponseListener

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
`ShowConstantTbt()` Constructs a new ShowConstantTbt object
`ShowConstantTbt(Hashtable<String,Object> hash)` Constructs a new ShowConstantTbt object indicated by the Hashtable parameter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`getDistanceToManeuver()` Gets the distanceToManeuver.
`Double`	`getDistanceToManeuverScale()` Gets the distanceToManeuverScale.
`String`	`getEta()` Gets a text field for estimated time of arrival
`Boolean`	`getManeuverComplete()` Gets a maneuver complete flag
`String`	`getNavigationText1()` Gets a text for navigation text field 1
`String`	`getNavigationText2()` Gets a text for navigation text field 2
`Image`	`getNextTurnIcon()` Gets an Image for nextTurnIcon
`List<SoftButton>`	`getSoftButtons()` Gets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns").
`String`	`getTimeToDestination()`
`String`	`getTotalDistance()` Gets a text field for total distance
`Image`	`getTurnIcon()` Gets an Image for turn icon
`ShowConstantTbt`	`setDistanceToManeuver(Double distanceToManeuver)` Sets the distanceToManeuver.
`ShowConstantTbt`	`setDistanceToManeuverScale(Double distanceToManeuverScale)` Sets the distanceToManeuverScale.
`ShowConstantTbt`	`setEta(String eta)` Sets a text field for estimated time of arrival
`ShowConstantTbt`	`setManeuverComplete(Boolean maneuverComplete)` Sets a maneuver complete flag.
`ShowConstantTbt`	`setNavigationText1(String navigationText1)` Sets a text for navigation text field 1
`ShowConstantTbt`	`setNavigationText2(String navigationText2)` Sets a text for navigation text field 2
`ShowConstantTbt`	`setNextTurnIcon(Image nextTurnIcon)` Sets an Image for nextTurnIcon
`ShowConstantTbt`	`setSoftButtons(List<SoftButton> softButtons)` Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns").
`ShowConstantTbt`	`setTimeToDestination(String timeToDestination)`
`ShowConstantTbt`	`setTotalDistance(String totalDistance)` Sets a text field for total distance
`ShowConstantTbt`	`setTurnIcon(Image turnIcon)` Sets an Image for turn icon

Methods inherited from class com.smartdevicelink.proxy.RPCRequest
getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

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_TEXT1
```
public static final String KEY_TEXT1
```
    See Also:
    
    Constant Field Values
  - KEY_TEXT2
```
public static final String KEY_TEXT2
```
    See Also:
    
    Constant Field Values
  - KEY_ETA
```
public static final String KEY_ETA
```
    See Also:
    
    Constant Field Values
  - KEY_TOTAL_DISTANCE
```
public static final String KEY_TOTAL_DISTANCE
```
    See Also:
    
    Constant Field Values
  - KEY_MANEUVER_DISTANCE
```
public static final String KEY_MANEUVER_DISTANCE
```
    See Also:
    
    Constant Field Values
  - KEY_MANEUVER_DISTANCE_SCALE
```
public static final String KEY_MANEUVER_DISTANCE_SCALE
```
    See Also:
    
    Constant Field Values
  - KEY_MANEUVER_IMAGE
```
public static final String KEY_MANEUVER_IMAGE
```
    See Also:
    
    Constant Field Values
  - KEY_NEXT_MANEUVER_IMAGE
```
public static final String KEY_NEXT_MANEUVER_IMAGE
```
    See Also:
    
    Constant Field Values
  - KEY_MANEUVER_COMPLETE
```
public static final String KEY_MANEUVER_COMPLETE
```
    See Also:
    
    Constant Field Values
  - KEY_SOFT_BUTTONS
```
public static final String KEY_SOFT_BUTTONS
```
    See Also:
    
    Constant Field Values
  - KEY_TIME_TO_DESTINATION
```
public static final String KEY_TIME_TO_DESTINATION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ShowConstantTbt
```
public ShowConstantTbt()
```
    Constructs a new ShowConstantTbt object
  - ShowConstantTbt
```
public ShowConstantTbt(Hashtable<String,Object> hash)
```
    Constructs a new ShowConstantTbt object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
- Method Detail
  - setNavigationText1
```
public ShowConstantTbt setNavigationText1(String navigationText1)
```
    Sets a text for navigation text field 1
    
    Parameters:
    
    navigationText1 - a String value representing a text for navigation text field 1
    Notes: Maxlength=500
  - getNavigationText1
```
public String getNavigationText1()
```
    Gets a text for navigation text field 1
    
    Returns:
    
    String -a String value representing a text for navigation text field 1
  - setNavigationText2
```
public ShowConstantTbt setNavigationText2(String navigationText2)
```
    Sets a text for navigation text field 2
    
    Parameters:
    
    navigationText2 - a String value representing a text for navigation text field 2
    Notes: Maxlength=500
  - getNavigationText2
```
public String getNavigationText2()
```
    Gets a text for navigation text field 2
    
    Returns:
    
    String -a String value representing a text for navigation text field 2
  - setEta
```
public ShowConstantTbt setEta(String eta)
```
    Sets a text field for estimated time of arrival
    
    Parameters:
    
    eta - a String value representing a text field for estimated time of arrival
    Notes: Maxlength=500
  - getEta
```
public String getEta()
```
    Gets a text field for estimated time of arrival
    
    Returns:
    
    String -a String value representing a text field for estimated time of arrival
  - setTotalDistance
```
public ShowConstantTbt setTotalDistance(String totalDistance)
```
    Sets a text field for total distance
    
    Parameters:
    
    totalDistance - a String value representing a text field for total distance
    Notes: Maxlength=500
  - getTotalDistance
```
public String getTotalDistance()
```
    Gets a text field for total distance
    
    Returns:
    
    String -a String value representing a text field for total distance
  - setTurnIcon
```
public ShowConstantTbt setTurnIcon(Image turnIcon)
```
    Sets an Image for turn icon
    
    Parameters:
    
    turnIcon - an Image value
  - getTurnIcon
```
public Image getTurnIcon()
```
    Gets an Image for turn icon
    
    Returns:
    
    Image -an Image value representing an Image for turnicon
  - setNextTurnIcon
```
public ShowConstantTbt setNextTurnIcon(Image nextTurnIcon)
```
    Sets an Image for nextTurnIcon
    
    Parameters:
    
    nextTurnIcon - an Image value
  - getNextTurnIcon
```
public Image getNextTurnIcon()
```
    Gets an Image for nextTurnIcon
    
    Returns:
    
    Image -an Image value representing an Image for nextTurnIcon
  - setDistanceToManeuver
```
public ShowConstantTbt setDistanceToManeuver(Double distanceToManeuver)
```
    Sets the distanceToManeuver.
    
    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}
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getDistanceToManeuver
```
public Double getDistanceToManeuver()
```
    Gets the distanceToManeuver.
    
    Returns:
    
    Float Distance (in meters) until next maneuver. May be used to calculate progress bar. {"num_min_value": 0.0, "num_max_value": 1000000000.0}
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setDistanceToManeuverScale
```
public ShowConstantTbt setDistanceToManeuverScale(Double distanceToManeuverScale)
```
    Sets the distanceToManeuverScale.
    
    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}
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getDistanceToManeuverScale
```
public Double getDistanceToManeuverScale()
```
    Gets the distanceToManeuverScale.
    
    Returns:
    
    Float 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}
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setManeuverComplete
```
public ShowConstantTbt 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
    
    Parameters:
    
    maneuverComplete - a Boolean value
  - getManeuverComplete
```
public Boolean getManeuverComplete()
```
    Gets a maneuver complete flag
    
    Returns:
    
    Boolean -a Boolean value
  - setSoftButtons
```
public ShowConstantTbt setSoftButtons(List<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
    
    Parameters:
    
    softButtons - a List value
  - getSoftButtons
```
public List<SoftButton> 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
    
    Returns:
    
    Vector -a Vector value
  - setTimeToDestination
```
public ShowConstantTbt setTimeToDestination(String timeToDestination)
```
  - getTimeToDestination
```
public String getTimeToDestination()
```

Class ShowConstantTbt

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

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

Constructor Detail

ShowConstantTbt

ShowConstantTbt

Method Detail

setNavigationText1

getNavigationText1

setNavigationText2

getNavigationText2

setEta

getEta

setTotalDistance

getTotalDistance

setTurnIcon

getTurnIcon

setNextTurnIcon

getNextTurnIcon

setDistanceToManeuver

getDistanceToManeuver

setDistanceToManeuverScale

getDistanceToManeuverScale

setManeuverComplete

getManeuverComplete

setSoftButtons

getSoftButtons

setTimeToDestination

getTimeToDestination