blob: 5c5820fbd6db444219f099fa52b3ee3c738ebe8b (
plain)
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
|
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import java.util.Hashtable;
/**
* Removes a command from the Command Menu.
*
* <p><b>HMI Status Requirements:</b></p>
* <p>HMILevel: FULL, LIMITED or BACKGROUND</p>
* AudioStreamingState: N/A
* <p>SystemContext: Should not be attempted when VRSESSION or MENU</p>
*
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
* <th>Version</th>
* </tr>
* <tr>
* <td>cmdID</td>
* <td>Integer</td>
* <td>Unique ID that identifies the Command to be deleted from Command Menu</td>
* <td>Y</td>
* <td>Min Value: 0;Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
*
*<p><b> Response:</b></p>
*
* Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully.
*
*<p><b> Non-default Result Codes:</b></p>
* <p>SUCCESS</p>
* <p>INVALID_DATA</p>
* <p>OUT_OF_MEMORY</p>
* <p>TOO_MANY_PENDING_REQUESTS</p>
* <p>APPLICATION_NOT_REGISTERED</p>
* <p> GENERIC_ERROR</p>
* <p>REJECTED</p>
* <p> INVALID_ID</p>
* <p> IN_USER</p>
* @since SmartDeviceLink 1.0
* @see AddCommand
* @see AddSubMenu
* @see DeleteSubMenu
*/
public class DeleteCommand extends RPCRequest {
public static final String KEY_CMD_ID = "cmdID";
/**
* Constructs a new DeleteCommand object
*/
public DeleteCommand() {
super(FunctionID.DELETE_COMMAND.toString());
}
/**
* Constructs a new DeleteCommand object indicated by the Hashtable
* parameter
*
*
* @param hash
* The Hashtable to use
*/
public DeleteCommand(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Gets the Command ID that identifies the Command to be deleted from
* Command Menu
*
* @return Integer - Integer value representing Command ID that identifies
* the Command to be deleted from Command Menu
*/
public Integer getCmdID() {
return getInteger( KEY_CMD_ID );
}
/**
* Sets the Command ID that identifies the Command to be deleted from Command Menu
*
* @param cmdID
* an Integer value representing Command ID
*
* <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
*/
public void setCmdID( Integer cmdID ) {
setParameters(KEY_CMD_ID, cmdID);
}
}
|
