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.
To Top
To Bottom
Class VrHelpItem
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
VR help items i.e. the text strings to be displayed, and when pronounced by the user the recognition of any of which must trigger the corresponding VR command.Parameter List
| Param Name | Type | Description | Req. | Notes | Version Available |
|---|---|---|---|---|---|
| text | String | Text to display for VR Help item | Y | maxlength: 500 | SmartDeviceLink 2.3.2 |
| image | Image | Image struct for VR Help item | N | SmartDeviceLink 2.3.2 | |
| position | Integer | Position to display item in VR Help list | N | minvalue=1; maxvalue=100 | SmartDeviceLink 2.3.2 |
Quick Jump
Fields
KEY_POSITION
public static final java.lang.String KEY_POSITION
- Constant Value
- "position"
KEY_TEXT
public static final java.lang.String KEY_TEXT
- Constant Value
- "text"
KEY_IMAGE
public static final java.lang.String KEY_IMAGE
- Constant Value
- "image"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
VrHelpItem()
public VrHelpItem()
VrHelpItem( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new VrHelpItem object indicated by the Hashtable parameter
public VrHelpItem(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- -The Hashtable to use
VrHelpItem( String text, Integer position )
VR help items i.e. the text strings to be displayed, and when pronounced by the user the recognition of any of which must trigger the corresponding VR command.
public VrHelpItem(String text,Integer position)
Constructor Parameters
- text
- Text to display for VR Help item
- position
- Position to display item in VR Help list
Methods
setText( String text )
public com.smartdevicelink.proxy.rpc.VrHelpItem setText(String text)
Method Parameters
- text
getText()
public java.lang.String getText()
setImage( Image image )
public com.smartdevicelink.proxy.rpc.VrHelpItem setImage(Image image)
Method Parameters
- image
getImage()
public com.smartdevicelink.proxy.rpc.Image getImage()
setPosition( Integer position )
public com.smartdevicelink.proxy.rpc.VrHelpItem setPosition(Integer position)
Method Parameters
- position
getPosition()
public java.lang.Integer getPosition()
Inherited Methods
| From Class | Methods |
|---|---|
| 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 |