Show (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.Show

All Implemented Interfaces:: Cloneable

public class Show
extends RPCRequest

Updates the application's display text area, regardless of whether or not this text area is visible to the user at the time of the request. The application's display text area remains unchanged until updated by subsequent calls to Show

The content of the application's display text area is visible to the user when the application's HMILevel is FULL or LIMITED, and the SystemContext=MAIN and no Alert is in progress

The Show operation cannot be used to create an animated scrolling screen. To avoid distracting the driver, Show commands cannot be issued more than once every 4 seconds. Requests made more frequently than this will be rejected

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Param Name Type Description Req. Notes Version Available

mainField1

String

Text to be displayed in a single-line display, or in the upper display line in a two-line display.

If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared.

Maxlength = 500

SmartDeviceLink 1.0

mainField2

String

Text to be displayed on the second display line of a two-line display.

If this parameter is omitted, the text of mainField2 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500

SmartDeviceLink 1.0

mainField3

String

Text to be displayed on the first display line of the second page.

If this parameter is omitted, the text of mainField3 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500

SmartDeviceLink 2.0

mainField4

String

Text to be displayed on the second display line of the second page.

If this parameter is omitted, the text of mainField4 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500

SmartDeviceLink 2.0

alignment

TextAlignment

Specifies how mainField1 and mainField2 text should be aligned on display.

Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.

If this parameter is omitted, text in both mainField1 and mainField2 will be centered.

Has no effect with navigation display

SmartDeviceLink 1.0

statusBar

String

The text is placed in the status bar area.

Note: The status bar only exists on navigation displays

If this parameter is omitted, the status bar text will remain unchanged.

If this parameter is an empty string, the field will be cleared.

If provided and the display has no status bar, this parameter is ignored.

Maxlength = 500

SmartDeviceLink 1.0

mediaClock

String

Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.

{"string_min_length": 0, "string_max_length": 500}

Since:: SmartDeviceLink 1.0.0, SmartDeviceLink 1.0
See Also:: Alert, SetMediaClockTimer

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ALIGNMENT`
`static String`	`KEY_CUSTOM_PRESETS`
`static String`	`KEY_GRAPHIC`
`static String`	`KEY_MAIN_FIELD_1`
`static String`	`KEY_MAIN_FIELD_2`
`static String`	`KEY_MAIN_FIELD_3`
`static String`	`KEY_MAIN_FIELD_4`
`static String`	`KEY_MEDIA_CLOCK` Deprecated. in SmartDeviceLink 7.1.0
`static String`	`KEY_MEDIA_TRACK`
`static String`	`KEY_METADATA_TAGS`
`static String`	`KEY_SECONDARY_GRAPHIC`
`static String`	`KEY_SOFT_BUTTONS`
`static String`	`KEY_STATUS_BAR`
`static String`	`KEY_TEMPLATE_CONFIGURATION`
`static String`	`KEY_TEMPLATE_TITLE`
`static String`	`KEY_WINDOW_ID`

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

Show()
Constructs a new Show object

Show(Hashtable<String,Object> hash)
Constructs a new Show object indicated by the Hashtable parameter

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TextAlignment`	`getAlignment()` Gets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display
`List<String>`	`getCustomPresets()` Gets the Custom Presets defined by the App
`Image`	`getGraphic()` Gets an image to be shown on supported displays
`String`	`getMainField1()` Gets the text displayed in a single-line display, or in the upper display line in a two-line display
`String`	`getMainField2()` Gets the text displayed on the second display line of a two-line display
`String`	`getMainField3()` Gets the text displayed on the first display line of the second page
`String`	`getMainField4()` Gets the text displayed on the second display line of the second page
`String`	`getMediaClock()` Deprecated. in SmartDeviceLink 7.1.0
`String`	`getMediaTrack()` Gets the text in the track field
`MetadataTags`	`getMetadataTags()` Gets text field metadata defined by the App
`Image`	`getSecondaryGraphic()`
`List<SoftButton>`	`getSoftButtons()` Gets the Soft buttons defined by the App
`String`	`getStatusBar()` Gets text in the Status Bar
`TemplateConfiguration`	`getTemplateConfiguration()` Gets the templateConfiguration.
`String`	`getTemplateTitle()` Gets the title of the new template that will be displayed How this will be displayed is dependent on the OEM design and implementation of the template.
`Integer`	`getWindowID()` Gets the windowID.
`Show`	`setAlignment(TextAlignment alignment)` Sets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display
`Show`	`setCustomPresets(List<String> customPresets)` Sets the Custom Presets defined by the App
`Show`	`setGraphic(Image graphic)` Sets an image to be shown on supported displays
`Show`	`setMainField1(String mainField1)` Sets the text displayed in a single-line display, or in the upper display line in a two-line display
`Show`	`setMainField2(String mainField2)` Sets the text displayed on the second display line of a two-line display
`Show`	`setMainField3(String mainField3)` Sets the text displayed on the first display line of the second page
`Show`	`setMainField4(String mainField4)` Sets the text displayed on the second display line of the second page
`Show`	`setMediaClock(String mediaClock)` Deprecated. in SmartDeviceLink 7.1.0
`Show`	`setMediaTrack(String mediaTrack)` Sets the text in the track field
`Show`	`setMetadataTags(MetadataTags metadataTags)` Sets text field metadata defined by the App
`Show`	`setSecondaryGraphic(Image secondaryGraphic)`
`Show`	`setSoftButtons(List<SoftButton> softButtons)` Sets the Soft buttons defined by the App
`Show`	`setStatusBar(String statusBar)` Sets text in the Status Bar
`Show`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)` Sets the templateConfiguration.
`Show`	`setTemplateTitle(String templateTitle)` Sets the title of the new template that will be displayed.
`Show`	`setWindowID(Integer windowID)` Sets the windowID.

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_GRAPHIC
```
public static final String KEY_GRAPHIC
```
    See Also:
    
    Constant Field Values
  - KEY_CUSTOM_PRESETS
```
public static final String KEY_CUSTOM_PRESETS
```
    See Also:
    
    Constant Field Values
  - KEY_MAIN_FIELD_1
```
public static final String KEY_MAIN_FIELD_1
```
    See Also:
    
    Constant Field Values
  - KEY_MAIN_FIELD_2
```
public static final String KEY_MAIN_FIELD_2
```
    See Also:
    
    Constant Field Values
  - KEY_MAIN_FIELD_3
```
public static final String KEY_MAIN_FIELD_3
```
    See Also:
    
    Constant Field Values
  - KEY_MAIN_FIELD_4
```
public static final String KEY_MAIN_FIELD_4
```
    See Also:
    
    Constant Field Values
  - KEY_STATUS_BAR
```
public static final String KEY_STATUS_BAR
```
    See Also:
    
    Constant Field Values
  - KEY_MEDIA_CLOCK
```
@Deprecated
public static final String KEY_MEDIA_CLOCK
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Since:
    
    SmartDeviceLink 1.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_ALIGNMENT
```
public static final String KEY_ALIGNMENT
```
    See Also:
    
    Constant Field Values
  - KEY_MEDIA_TRACK
```
public static final String KEY_MEDIA_TRACK
```
    See Also:
    
    Constant Field Values
  - KEY_SECONDARY_GRAPHIC
```
public static final String KEY_SECONDARY_GRAPHIC
```
    See Also:
    
    Constant Field Values
  - KEY_SOFT_BUTTONS
```
public static final String KEY_SOFT_BUTTONS
```
    See Also:
    
    Constant Field Values
  - KEY_METADATA_TAGS
```
public static final String KEY_METADATA_TAGS
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOW_ID
```
public static final String KEY_WINDOW_ID
```
    See Also:
    
    Constant Field Values
  - KEY_TEMPLATE_CONFIGURATION
```
public static final String KEY_TEMPLATE_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - KEY_TEMPLATE_TITLE
```
public static final String KEY_TEMPLATE_TITLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Show
```
public Show()
```
    Constructs a new Show object
  - Show
```
public Show(Hashtable<String,Object> hash)
```
    Constructs a new Show object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
- Method Detail
  - getMainField1
```
public String getMainField1()
```
    Gets the text displayed in a single-line display, or in the upper display line in a two-line display
    
    Returns:
    
    String -a String value representing the text displayed in a single-line display, or in the upper display line in a two-line display
  - setMainField1
```
public Show setMainField1(String mainField1)
```
    Sets the text displayed in a single-line display, or in the upper display line in a two-line display
    Parameters:
    mainField1 - the String value representing the text displayed in a single-line display, or in the upper display line in a two-line display
    Notes:
    
    If this parameter is omitted, the text of mainField1 does not change
    
    If this parameter is an empty string, the field will be cleared
  - getMainField2
```
public String getMainField2()
```
    Gets the text displayed on the second display line of a two-line display
    
    Returns:
    
    String -a String value representing the text displayed on the second display line of a two-line display
  - setMainField2
```
public Show setMainField2(String mainField2)
```
    Sets the text displayed on the second display line of a two-line display
    Parameters:
    mainField2 - the String value representing the text displayed on the second display line of a two-line display
    Notes:
    
    If this parameter is omitted, the text of mainField2 does not change
    
    If this parameter is an empty string, the field will be cleared
    
    If provided and the display is a single-line display, the parameter is ignored
    
    Maxlength = 500
  - getMainField3
```
public String getMainField3()
```
    Gets the text displayed on the first display line of the second page
    
    Returns:
    
    String -a String value representing the text displayed on the first display line of the second page
    
    Since:
    
    SmartDeviceLink 2.0
  - setMainField3
```
public Show setMainField3(String mainField3)
```
    Sets the text displayed on the first display line of the second page
    Parameters:
    mainField3 - the String value representing the text displayed on the first display line of the second page
    Notes:
    
    If this parameter is omitted, the text of mainField3 does not change
    
    If this parameter is an empty string, the field will be cleared
    
    If provided and the display is a single-line display, the parameter is ignored
    
    Maxlength = 500
    Since:
    
    SmartDeviceLink 2.0
  - getMainField4
```
public String getMainField4()
```
    Gets the text displayed on the second display line of the second page
    
    Returns:
    
    String -a String value representing the text displayed on the first display line of the second page
    
    Since:
    
    SmartDeviceLink 2.0
  - setMainField4
```
public Show setMainField4(String mainField4)
```
    Sets the text displayed on the second display line of the second page
    Parameters:
    mainField4 - the String value representing the text displayed on the second display line of the second page
    Notes:
    
    If this parameter is omitted, the text of mainField4 does not change
    
    If this parameter is an empty string, the field will be cleared
    
    If provided and the display is a single-line display, the parameter is ignored
    
    Maxlength = 500
    Since:
    
    SmartDeviceLink 2.0
  - getAlignment
```
public TextAlignment getAlignment()
```
    Gets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display
    
    Returns:
    
    TextAlignment -an Enumeration value
  - setAlignment
```
public Show setAlignment(TextAlignment alignment)
```
    Sets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display
    Parameters:
    alignment - an Enumeration value
    Notes:
    
    Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display
    
    If this parameter is omitted, text in both mainField1 and mainField2 will be centered
    
    Has no effect with navigation display
  - getStatusBar
```
public String getStatusBar()
```
    Gets text in the Status Bar
    
    Returns:
    
    String -the value in the Status Bar
  - setStatusBar
```
public Show setStatusBar(String statusBar)
```
    Sets text in the Status Bar
    Parameters:
    statusBar - a String representing the text you want to add in the Status Bar
    Notes: The status bar only exists on navigation displays
    
    If this parameter is omitted, the status bar text will remain unchanged
    
    If this parameter is an empty string, the field will be cleared
    
    If provided and the display has no status bar, this parameter is ignored
  - getMediaClock
```
@Deprecated
public String getMediaClock()
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Gets the mediaClock.
    
    Returns:
    
    String Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped. {"string_min_length": 0, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 1.0.0
  - setMediaClock
```
@Deprecated
public Show setMediaClock(String mediaClock)
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Sets the mediaClock.
    
    Parameters:
    
    mediaClock - Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped. {"string_min_length": 0, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 1.0.0
  - getMediaTrack
```
public String getMediaTrack()
```
    Gets the text in the track field
    
    Returns:
    
    String -a String displayed in the track field
  - setMediaTrack
```
public Show setMediaTrack(String mediaTrack)
```
    Sets the text in the track field
    Parameters:
    mediaTrack - a String value displayed in the track field
    Notes:
    
    If parameter is omitted, the track field remains unchanged
    
    If an empty string is provided, the field will be cleared
    
    This field is only valid for media applications on navigation displays
  - setGraphic
```
public Show setGraphic(Image graphic)
```
    Sets an image to be shown on supported displays
    
    Parameters:
    
    graphic - the value representing the image shown on supported displays
    Notes: If omitted on supported displays, the displayed graphic shall not change
    
    Since:
    
    SmartDeviceLink 2.0
  - getGraphic
```
public Image getGraphic()
```
    Gets an image to be shown on supported displays
    
    Returns:
    
    Image -the value representing the image shown on supported displays
    
    Since:
    
    SmartDeviceLink 2.0
  - setSecondaryGraphic
```
public Show setSecondaryGraphic(Image secondaryGraphic)
```
  - getSecondaryGraphic
```
public Image getSecondaryGraphic()
```
  - getSoftButtons
```
public List<SoftButton> getSoftButtons()
```
    Gets the Soft buttons defined by the App
    
    Returns:
    
    List -a List value representing the Soft buttons defined by the App
    
    Since:
    
    SmartDeviceLink 2.0
  - setSoftButtons
```
public Show setSoftButtons(List<SoftButton> softButtons)
```
    Sets the Soft buttons defined by the App
    Parameters:
    softButtons - a List value representing the Soft buttons defined by the App
    Notes:
    
    If omitted on supported displays, the currently displayed SoftButton values will not change
    
    Array Minsize: 0
    
    Array Maxsize: 8
    Since:
    
    SmartDeviceLink 2.0
  - getCustomPresets
```
public List<String> getCustomPresets()
```
    Gets the Custom Presets defined by the App
    
    Returns:
    
    List - a List value representing the Custom presets defined by the App
    
    Since:
    
    SmartDeviceLink 2.0
  - setCustomPresets
```
public Show setCustomPresets(List<String> customPresets)
```
    Sets the Custom Presets defined by the App
    Parameters:
    customPresets - a List value representing the Custom Presets defined by the App
    
    If omitted on supported displays, the presets will be shown as not defined
    
    Array Minsize: 0
    
    Array Maxsize: 6
    Since:
    
    SmartDeviceLink 2.0
  - setMetadataTags
```
public Show setMetadataTags(MetadataTags metadataTags)
```
    Sets text field metadata defined by the App
    Parameters:
    metadataTags - A Struct containing metadata pertaining to the main text fields
    Since:
    
    SmartDeviceLink 4.5.0
  - getMetadataTags
```
public MetadataTags getMetadataTags()
```
    Gets text field metadata defined by the App
    
    Returns:
    
    metadataTags - App defined metadata information. See MetadataTags. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.
    
    Since:
    
    SmartDeviceLink 4.5.0
  - setWindowID
```
public Show setWindowID(Integer windowID)
```
    Sets the windowID. It's a unique ID to identify the window. If this param is not included, it will be assumed that this request is specifically for the main window on the main display. See PredefinedWindows enum.
    
    Parameters:
    
    windowID - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.
    
    Since:
    
    6.0
  - getWindowID
```
public Integer getWindowID()
```
    Gets the windowID.
    
    Returns:
    
    int -an int value representing the windowID.
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    Gets the templateConfiguration.
    
    Returns:
    
    TemplateConfiguration
    
    Since:
    
    6.0
  - setTemplateConfiguration
```
public Show setTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    Sets the templateConfiguration. It's used to set an alternate template layout to a window.
    
    Parameters:
    
    templateConfiguration -
  - setTemplateTitle
```
public Show setTemplateTitle(String templateTitle)
```
    Sets the title of the new template that will be displayed. How this will be displayed is dependent on the OEM design and implementation of the template.
    Parameters:
    templateTitle - the title of the new template that will be displayed
    
    Minlength: 0
    
    Maxlength: 100
    Since:
    
    SmartDeviceLink 6.0.0
  - getTemplateTitle
```
public String getTemplateTitle()
```
    Gets the title of the new template that will be displayed How this will be displayed is dependent on the OEM design and implementation of the template.
    
    Returns:
    
    templateTitle - String value that represents the title of the new template that will be displayed
    
    Since:
    
    SmartDeviceLink 6.0.0

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class Show

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_GRAPHIC

KEY_CUSTOM_PRESETS

KEY_MAIN_FIELD_1

KEY_MAIN_FIELD_2

KEY_MAIN_FIELD_3

KEY_MAIN_FIELD_4

KEY_STATUS_BAR

KEY_MEDIA_CLOCK

KEY_ALIGNMENT

KEY_MEDIA_TRACK

KEY_SECONDARY_GRAPHIC

KEY_SOFT_BUTTONS

KEY_METADATA_TAGS

KEY_WINDOW_ID

KEY_TEMPLATE_CONFIGURATION

KEY_TEMPLATE_TITLE

Constructor Detail

Show

Show

Method Detail

getMainField1

setMainField1

getMainField2

setMainField2

getMainField3

setMainField3

getMainField4

setMainField4

getAlignment

setAlignment

getStatusBar

setStatusBar

getMediaClock

setMediaClock

getMediaTrack

setMediaTrack

setGraphic

getGraphic

setSecondaryGraphic

getSecondaryGraphic

getSoftButtons

setSoftButtons

getCustomPresets

setCustomPresets

setMetadataTags

getMetadataTags

setWindowID

getWindowID

getTemplateConfiguration

setTemplateConfiguration

setTemplateTitle

getTemplateTitle