com.smartdevicelink.proxy.rpc

Class VrHelpItem

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.VrHelpItem

All Implemented Interfaces:

Cloneable

public class VrHelpItem
extends RPCStruct

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_IMAGE
static String	KEY_POSITION
static String	KEY_TEXT

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
VrHelpItem()
VrHelpItem(Hashtable<String,Object> hash) Constructs a new VrHelpItem object indicated by the Hashtable parameter
VrHelpItem(String text, Integer position) VR help items i.e.

Method Summary

Modifier and Type	Method and Description
Image	getImage()
Integer	getPosition()
String	getText()
VrHelpItem	setImage(Image image)
VrHelpItem	setPosition(Integer position)
VrHelpItem	setText(String text)

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_POSITION

public static final String KEY_POSITION

See Also:

Constant Field Values

KEY_TEXT

public static final String KEY_TEXT

See Also:

Constant Field Values

KEY_IMAGE

public static final String KEY_IMAGE

See Also:

Constant Field Values

Constructor Detail

VrHelpItem

public VrHelpItem()

VrHelpItem

public VrHelpItem(Hashtable<String,Object> hash)

Constructs a new VrHelpItem object indicated by the Hashtable parameter

Parameters:

hash - -The Hashtable to use

VrHelpItem

public VrHelpItem(@NonNull
                  String text,
                  @NonNull
                  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.

Parameters:

text - Text to display for VR Help item

position - Position to display item in VR Help list

Method Detail

setText

public VrHelpItem setText(@NonNull
                          String text)

getText

public String getText()

setImage

public VrHelpItem setImage(Image image)

getImage

public Image getImage()

setPosition

public VrHelpItem setPosition(@NonNull
                              Integer position)

getPosition

public Integer getPosition()