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
|
/*
* Copyright (c) 2019 Livio, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Livio Inc. nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Created by Nicole Yarroch on 7/17/19 8:40 AM
*/
package com.smartdevicelink.proxy.rpc;
import android.support.annotation.NonNull;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import java.util.Hashtable;
/*
* Used to dismiss a modal view programmatically without needing to wait for the timeout to complete. Can be used to dismiss alerts, scrollable messages, sliders, and perform interactions (i.e. pop-up menus).
*
* @see Alert, ScrollableMessage, Slider, PerformInteraction
*/
public class CancelInteraction extends RPCRequest {
public static final String KEY_CANCEL_ID = "cancelID";
public static final String KEY_FUNCTION_ID = "functionID";
// Constructors
/**
* Constructs a new CancelInteraction object
*/
public CancelInteraction() {
super(FunctionID.CANCEL_INTERACTION.toString());
}
/**
* Constructs a new CancelInteraction object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public CancelInteraction(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Convenience init for dismissing an interaction type.
* @param functionID - The ID of the type of interaction to dismiss
*/
public CancelInteraction(@NonNull Integer functionID) {
this();
setInteractionFunctionID(functionID);
}
/**
* Convenience init for dismissing a specific interaction.
* @param functionID - The ID of the type of interaction to dismiss
* @param cancelID - The ID of the specific interaction to dismiss
*/
public CancelInteraction(@NonNull Integer functionID, Integer cancelID) {
this();
setInteractionFunctionID(functionID);
setCancelID(cancelID);
}
// Custom Getters / Setters
/**
* The ID of the type of interaction to dismiss.
* Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), and 26 (SliderID) are permitted.
* @return - the functionID
*/
public Integer getInteractionFunctionID() {
return getInteger(KEY_FUNCTION_ID);
}
/**
* The ID of the type of interaction to dismiss.
* Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), and 26 (SliderID) are permitted.
* @param functionID - the functionID
*/
public void setInteractionFunctionID(@NonNull Integer functionID) {
setParameters(KEY_FUNCTION_ID, functionID);
}
/**
* The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed.
* @return - the cancelID
*/
public Integer getCancelID() {
return getInteger(KEY_CANCEL_ID);
}
/**
* The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed.
* @param cancelID - the cancelID
*/
public void setCancelID(Integer cancelID) {
setParameters(KEY_CANCEL_ID, cancelID);
}
}
|
