1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
package com.smartdevicelink.proxy.rpc;
import android.support.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
import java.util.List;
/**
* A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
* For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>choiceID</td>
* <td>Integer</td>
* <td>Application-scoped identifier that uniquely identifies this choice.
* Min: 0;
* Max: 65535
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>menuName</td>
* <td>String</td>
* <td>Text which appears in menu, representing this choice.
* Min: 1;
* Max: 100
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>vrCommands</td>
* <td>String[]</td>
* <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>image</td>
* <td>Image</td>
* <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
*
* @since SmartDeviceLink 1.0
*
* @see AddCommand
* @see PerformInteraction
* @see Image
*/
public class Choice extends RPCStruct {
public static final String KEY_SECONDARY_TEXT = "secondaryText";
public static final String KEY_TERTIARY_TEXT = "tertiaryText";
public static final String KEY_SECONDARY_IMAGE = "secondaryImage";
public static final String KEY_MENU_NAME = "menuName";
public static final String KEY_VR_COMMANDS = "vrCommands";
public static final String KEY_CHOICE_ID = "choiceID";
public static final String KEY_IMAGE = "image";
/**
* Constructs a newly allocated Choice object
*/
public Choice() { }
/**
* Constructs a newly allocated Choice object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public Choice(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated Choice object
* @param choiceID Min: 0 Max: 65535
* @param menuName the menu name
* @param vrCommands the List of vrCommands
*/
public Choice(@NonNull Integer choiceID, @NonNull String menuName, @NonNull List<String> vrCommands) {
this();
setChoiceID(choiceID);
setMenuName(menuName);
setVrCommands(vrCommands);
}
/**
* Get the application-scoped identifier that uniquely identifies this choice.
* @return choiceID Min: 0; Max: 65535
*/
public Integer getChoiceID() {
return getInteger(KEY_CHOICE_ID);
}
/**
* Set the application-scoped identifier that uniquely identifies this choice.
* @param choiceID Min: 0 Max: 65535
*/
public void setChoiceID(@NonNull Integer choiceID) {
setValue(KEY_CHOICE_ID, choiceID);
}
/**
* Text which appears in menu, representing this choice.
* Min: 1;
* Max: 100
* @return menuName the menu name
*/
public String getMenuName() {
return getString(KEY_MENU_NAME);
}
/**
* Text which appears in menu, representing this choice.
* Min: 1;
* Max: 100
* @param menuName the menu name
*/
public void setMenuName(@NonNull String menuName) {
setValue(KEY_MENU_NAME, menuName);
}
/**
* Get an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
* @return vrCommands List
* @since SmartDeviceLink 2.0
*/
@SuppressWarnings("unchecked")
public List<String> getVrCommands() {
return (List<String>) getObject(String.class, KEY_VR_COMMANDS);
}
/**
* Set an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
* @param vrCommands the List of vrCommands
* @since SmartDeviceLink 2.0
*/
public void setVrCommands(@NonNull List<String> vrCommands) {
setValue(KEY_VR_COMMANDS, vrCommands);
}
/**
* Set the image
* @param image the image of the choice
*/
public void setImage(Image image) {
setValue(KEY_IMAGE, image);
}
/**
* Get the image
* @return the image of the choice
*/
@SuppressWarnings("unchecked")
public Image getImage() {
return (Image) getObject(Image.class, KEY_IMAGE);
}
public String getSecondaryText() {
return getString(KEY_SECONDARY_TEXT);
}
public void setSecondaryText(String secondaryText) {
setValue(KEY_SECONDARY_TEXT, secondaryText);
}
public String getTertiaryText() {
return getString(KEY_TERTIARY_TEXT);
}
public void setTertiaryText(String tertiaryText) {
setValue(KEY_TERTIARY_TEXT, tertiaryText);
}
public void setSecondaryImage(Image image) {
setValue(KEY_SECONDARY_IMAGE, image);
}
@SuppressWarnings("unchecked")
public Image getSecondaryImage() {
return (Image) getObject(Image.class, KEY_SECONDARY_IMAGE);
}
}
|
