java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
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} |
Quick Jump
FieldsKEY_GRAPHICpublic static final java.lang.String KEY_GRAPHIC
KEY_CUSTOM_PRESETSpublic static final java.lang.String KEY_CUSTOM_PRESETS
KEY_MAIN_FIELD_1public static final java.lang.String KEY_MAIN_FIELD_1
KEY_MAIN_FIELD_2public static final java.lang.String KEY_MAIN_FIELD_2
KEY_MAIN_FIELD_3public static final java.lang.String KEY_MAIN_FIELD_3
KEY_MAIN_FIELD_4public static final java.lang.String KEY_MAIN_FIELD_4
KEY_STATUS_BARpublic static final java.lang.String KEY_STATUS_BAR
KEY_MEDIA_CLOCKpublic static final java.lang.String KEY_MEDIA_CLOCK
KEY_ALIGNMENTpublic static final java.lang.String KEY_ALIGNMENT
KEY_MEDIA_TRACKpublic static final java.lang.String KEY_MEDIA_TRACK
KEY_SECONDARY_GRAPHICpublic static final java.lang.String KEY_SECONDARY_GRAPHIC
KEY_SOFT_BUTTONSpublic static final java.lang.String KEY_SOFT_BUTTONS
KEY_METADATA_TAGSpublic static final java.lang.String KEY_METADATA_TAGS
KEY_WINDOW_IDpublic static final java.lang.String KEY_WINDOW_ID
KEY_TEMPLATE_CONFIGURATIONpublic static final java.lang.String KEY_TEMPLATE_CONFIGURATION
KEY_TEMPLATE_TITLEpublic static final java.lang.String KEY_TEMPLATE_TITLE
Inherited FieldsConstructorsShow()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
MethodsgetMainField1()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
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
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
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
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
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
getMediaClock()
Deprecated public java.lang.String getMediaClock()
setMediaClock( String mediaClock )
Deprecated public com.smartdevicelink.proxy.rpc.Show setMediaClock(String mediaClock)
Method Parameters
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
setGraphic( Image graphic )Sets an image to be shown on supported displays public com.smartdevicelink.proxy.rpc.Show setGraphic(Image graphic)
Method Parameters
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
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
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
setMetadataTags( MetadataTags metadataTags )Sets text field metadata defined by the App public com.smartdevicelink.proxy.rpc.Show setMetadataTags(MetadataTags metadataTags)
Method Parameters
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
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
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
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
|