summaryrefslogtreecommitdiff
path: root/android/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java
blob: 2a4581f06a2051cd577f5cc07d64fa5f592bd34d (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
package com.smartdevicelink.proxy.rpc;

import android.support.annotation.NonNull;

import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCNotification;

import java.util.Hashtable;

/**
 * 	Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.).
 * Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.
 * <p></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>hashID</td>
 * 			<td>String</td>
 * 			<td>Calculated hash ID to be referenced during RegisterAppInterface.</td>
 *                 <td>Y</td>
 *                 <td>maxlength: 100</td>
 * 			<td>SmartDeviceLink 3.0 </td>
 * 		</tr>
 *  </table>
 * @since SmartDeviceLink 3.0
 *
 */
public class OnHashChange extends RPCNotification {
	public static final String KEY_HASH_ID = "hashID";
	/**
	 * Constructs a new OnHashChange object
	 */

    public OnHashChange() {
        super(FunctionID.ON_HASH_CHANGE.toString());
    }
    /**
	* <p>
	* Constructs a new OnKeyboardInput object indicated by the Hashtable
	* parameter
	* </p>
	* 
	* @param hash
	*            The Hashtable to use
	*/

    public OnHashChange(Hashtable<String, Object> hash) {
        super(hash);
    }

    /**
     * Constructs a new OnHashChange object
     */
    public OnHashChange(@NonNull String hashID) {
        this();
        setHashID(hashID);
    }
    
    public String getHashID() {
        return getString(KEY_HASH_ID);
    }
   
    public void setHashID(@NonNull String hashID) {
        setParameters(KEY_HASH_ID, hashID);
    }   
    
}