-
-
Notifications
You must be signed in to change notification settings - Fork 718
/
ActionComponent.java
90 lines (82 loc) · 2.67 KB
/
ActionComponent.java
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
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.interactions.components;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Component which supports interactions via {@link ComponentInteraction}.
*/
public interface ActionComponent extends ItemComponent
{
/**
* The component ID or null.
* <br>Some components such as link buttons don't have this.
*
* <p>This need not be a numeric ID! All these component IDs are custom and user-provided data,
* unlike other IDs generated by Discord. This ID is used for event handling with {@link ComponentInteraction#getComponentId()}.
*
* @return The component ID or null if not present
*
* @see ComponentInteraction#getComponentId()
*/
@Nullable
String getId();
/**
* Whether this action component is disabled.
*
* <p>You can use {@link #asDisabled()} or {@link #asEnabled()} to create enabled/disabled instances.
*
* @return True, if this button is disabled
*/
boolean isDisabled();
/**
* Returns a copy of this component with {@link #isDisabled()} set to true.
*
* @return New disabled component instance
*/
@Nonnull
@CheckReturnValue
default ActionComponent asDisabled()
{
return withDisabled(true);
}
/**
* Returns a copy of this component with {@link #isDisabled()} set to false.
*
* @return New enabled component instance
*/
@Nonnull
@CheckReturnValue
default ActionComponent asEnabled()
{
return withDisabled(false);
}
/**
* Returns a copy of this component with {@link #isDisabled()} set to the provided value.
*
* @param disabled
* True, if this component should be disabled
*
* @throws UnsupportedOperationException
* If this component type cannot be disabled
*
* @return New enabled/disabled component instance
*/
@Nonnull
@CheckReturnValue
ActionComponent withDisabled(boolean disabled);
}