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
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
Show

Class Show

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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 com.smartdevicelink.proxy.rpc.enums.HMILevel is FULL or LIMITED, and the com.smartdevicelink.proxy.rpc.enums.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. N 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. N

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. N

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. N

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. N

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. N

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. N {"string_min_length": 0, "string_max_length": 500} SmartDeviceLink 1.0.0

Deprecated in SmartDeviceLink 7.1.0
mediaTrack String Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT. N

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.

Maxlength = 500		 SmartDeviceLink 1.0
graphic Image Image to be shown on supported displays. N If omitted on supported displays, the displayed graphic shall not change. SmartDeviceLink 2.0
secondaryGraphic Image

Image struct determining whether static or dynamic secondary image to display in app.

If omitted on supported displays, the displayed secondary graphic shall not change.		 N SmartDeviceLink 2.3.2
softButtons List Soft buttons as defined by the App N

If omitted on supported displays, the currently displayed SoftButton values will not change.

Array Minsize: 0; Array Maxsize: 8		 SmartDeviceLink 2.0
customPresets String Custom presets as defined by the App. N

If omitted on supported displays, the presets will be shown as not defined.

Minsize: 0; Maxsize: 6		 SmartDeviceLink 2.0
templateTitle String The title of the new template that will be displayed. N

How this will be displayed is dependent on the OEM design and implementation of the template..

Minsize: 0; Maxsize: 100		 SmartDeviceLink 6.0.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

UNSUPPORTED_RESOURCE

ABORTED

Quick Jump

Fields
Constructors
Methods

Fields

KEY_GRAPHIC

public static final java.lang.String KEY_GRAPHIC
Constant Value
"graphic"

KEY_CUSTOM_PRESETS

public static final java.lang.String KEY_CUSTOM_PRESETS
Constant Value
"customPresets"

KEY_MAIN_FIELD_1

public static final java.lang.String KEY_MAIN_FIELD_1
Constant Value
"mainField1"

KEY_MAIN_FIELD_2

public static final java.lang.String KEY_MAIN_FIELD_2
Constant Value
"mainField2"

KEY_MAIN_FIELD_3

public static final java.lang.String KEY_MAIN_FIELD_3
Constant Value
"mainField3"

KEY_MAIN_FIELD_4

public static final java.lang.String KEY_MAIN_FIELD_4
Constant Value
"mainField4"

KEY_STATUS_BAR

public static final java.lang.String KEY_STATUS_BAR
Constant Value
"statusBar"

KEY_MEDIA_CLOCK

public static final java.lang.String KEY_MEDIA_CLOCK
Constant Value
"mediaClock"

KEY_ALIGNMENT

public static final java.lang.String KEY_ALIGNMENT
Constant Value
"alignment"

KEY_MEDIA_TRACK

public static final java.lang.String KEY_MEDIA_TRACK
Constant Value
"mediaTrack"

KEY_SECONDARY_GRAPHIC

public static final java.lang.String KEY_SECONDARY_GRAPHIC
Constant Value
"secondaryGraphic"

KEY_SOFT_BUTTONS

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

KEY_METADATA_TAGS

public static final java.lang.String KEY_METADATA_TAGS
Constant Value
"metadataTags"

KEY_WINDOW_ID

public static final java.lang.String KEY_WINDOW_ID
Constant Value
"windowID"

KEY_TEMPLATE_CONFIGURATION

public static final java.lang.String KEY_TEMPLATE_CONFIGURATION
Constant Value
"templateConfiguration"

KEY_TEMPLATE_TITLE

public static final java.lang.String KEY_TEMPLATE_TITLE
Constant Value
"templateTitle"

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

Show()

Constructs a new Show object 

public Show()

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

Constructs a new Show object indicated by the Hashtable parameter 

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

Constructor Parameters

hash
The Hashtable to use

Methods

getMainField1()

Gets the text displayed in a single-line display, or in the upper display line in a two-line display 

public java.lang.String getMainField1()

setMainField1( String mainField1 )

Sets the text displayed in a single-line display, or in the upper display line in a two-line display 

public com.smartdevicelink.proxy.rpc.Show setMainField1(String mainField1)

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

Gets the text displayed on the second display line of a two-line display 

public java.lang.String getMainField2()

setMainField2( String mainField2 )

Sets the text displayed on the second display line of a two-line display 

public com.smartdevicelink.proxy.rpc.Show setMainField2(String mainField2)

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

Gets the text displayed on the first display line of the second page 

public java.lang.String getMainField3()

setMainField3( String mainField3 )

Sets the text displayed on the first display line of the second page 

public com.smartdevicelink.proxy.rpc.Show setMainField3(String mainField3)

Method 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

getMainField4()

Gets the text displayed on the second display line of the second page 

public java.lang.String getMainField4()

setMainField4( String mainField4 )

Sets the text displayed on the second display line of the second page 

public com.smartdevicelink.proxy.rpc.Show setMainField4(String mainField4)

Method 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

getAlignment()

Gets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display 

public com.smartdevicelink.proxy.rpc.enums.TextAlignment getAlignment()

setAlignment( TextAlignment alignment )

Sets the alignment that Specifies how mainField1 and mainField2 text should be aligned on display 

public com.smartdevicelink.proxy.rpc.Show setAlignment(TextAlignment alignment)

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

Gets text in the Status Bar 

public java.lang.String getStatusBar()

setStatusBar( String statusBar )

Sets text in the Status Bar 

public com.smartdevicelink.proxy.rpc.Show setStatusBar(String statusBar)

Method 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
Gets the mediaClock. 

public java.lang.String getMediaClock()

setMediaClock( String mediaClock )

Deprecated
Sets the mediaClock. 

public com.smartdevicelink.proxy.rpc.Show setMediaClock(String mediaClock)

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

getMediaTrack()

Gets the text in the track field 

public java.lang.String getMediaTrack()

setMediaTrack( String mediaTrack )

Sets the text in the track field 

public com.smartdevicelink.proxy.rpc.Show setMediaTrack(String mediaTrack)

Method 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( Image graphic )

Sets an image to be shown on supported displays 

public com.smartdevicelink.proxy.rpc.Show setGraphic(Image graphic)

Method Parameters

graphic
the value representing the image shown on supported displays

Notes: If omitted on supported displays, the displayed graphic shall not change

getGraphic()

Gets an image to be shown on supported displays 

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

setSecondaryGraphic( Image secondaryGraphic )

public com.smartdevicelink.proxy.rpc.Show setSecondaryGraphic(Image secondaryGraphic)

Method Parameters

secondaryGraphic

getSecondaryGraphic()

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

getSoftButtons()

Gets the Soft buttons defined by the App 

public java.util.List getSoftButtons()

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

Sets the Soft buttons defined by the App 

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

Method 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

getCustomPresets()

Gets the Custom Presets defined by the App 

public java.util.List getCustomPresets()

setCustomPresets( java.util.List<java.lang.String> customPresets )

Sets the Custom Presets defined by the App 

public com.smartdevicelink.proxy.rpc.Show setCustomPresets(java.util.List<java.lang.String> customPresets)

Method 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

setMetadataTags( MetadataTags metadataTags )

Sets text field metadata defined by the App 

public com.smartdevicelink.proxy.rpc.Show setMetadataTags(MetadataTags metadataTags)

Method Parameters

metadataTags
A Struct containing metadata pertaining to the main text fields

    getMetadataTags()

    Gets text field metadata defined by the App 

    public com.smartdevicelink.proxy.rpc.MetadataTags getMetadataTags()

    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. 

    public com.smartdevicelink.proxy.rpc.Show setWindowID(Integer windowID)

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

    getWindowID()

    Gets the windowID. 

    public java.lang.Integer getWindowID()

    getTemplateConfiguration()

    Gets the templateConfiguration. 

    public com.smartdevicelink.proxy.rpc.TemplateConfiguration getTemplateConfiguration()

    setTemplateConfiguration( TemplateConfiguration templateConfiguration )

    Sets the templateConfiguration. It's used to set an alternate template layout to a window. 

    public com.smartdevicelink.proxy.rpc.Show setTemplateConfiguration(TemplateConfiguration templateConfiguration)

    Method Parameters

    templateConfiguration

    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. 

    public com.smartdevicelink.proxy.rpc.Show setTemplateTitle(String templateTitle)

    Method Parameters

    templateTitle
    the title of the new template that will be displayed

    • Minlength: 0
    • Maxlength: 100

    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. 

    public java.lang.String getTemplateTitle()

    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