|
| 1 | +/* |
| 2 | + * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package net.dv8tion.jda.api.components.attribute; |
| 18 | + |
| 19 | +import net.dv8tion.jda.annotations.ForRemoval; |
| 20 | +import net.dv8tion.jda.annotations.ReplaceWith; |
| 21 | +import net.dv8tion.jda.api.components.Component; |
| 22 | +import net.dv8tion.jda.api.components.replacer.ComponentReplacer; |
| 23 | +import net.dv8tion.jda.api.components.replacer.IReplaceable; |
| 24 | +import net.dv8tion.jda.api.components.tree.ComponentTree; |
| 25 | +import net.dv8tion.jda.api.interactions.components.ComponentInteraction; |
| 26 | + |
| 27 | +import javax.annotation.Nonnull; |
| 28 | +import javax.annotation.Nullable; |
| 29 | + |
| 30 | +/** |
| 31 | + * Component which has an associated custom id. |
| 32 | + */ |
| 33 | +public interface ICustomId extends Component |
| 34 | +{ |
| 35 | + /** |
| 36 | + * An unique component ID or {@code null}. |
| 37 | + * <br>Some components such as link buttons don't have this. |
| 38 | + * |
| 39 | + * <p>Custom IDs can contain custom data, |
| 40 | + * this is typically used to pass data between a slash command and your button listener. |
| 41 | + * |
| 42 | + * <p>While this ID is unique and can be retrieved with {@link ComponentInteraction#getComponentId()}, |
| 43 | + * you should use {@link #getUniqueId()} to identify a component in a single message, |
| 44 | + * such as when replacing components using {@link ComponentTree} or {@link IReplaceable#replace(ComponentReplacer)}. |
| 45 | + * |
| 46 | + * @return The component ID or null if not present |
| 47 | + * |
| 48 | + * @see ComponentInteraction#getComponentId() |
| 49 | + * @see Component#getUniqueId() |
| 50 | + * |
| 51 | + * @deprecated |
| 52 | + * Replaced with {@link #getCustomId()} |
| 53 | + */ |
| 54 | + @Nullable |
| 55 | + @Deprecated |
| 56 | + @ForRemoval |
| 57 | + @ReplaceWith("getCustomId()") |
| 58 | + default String getId() |
| 59 | + { |
| 60 | + return getCustomId(); |
| 61 | + } |
| 62 | + |
| 63 | + /** |
| 64 | + * An unique component ID or {@code null}. |
| 65 | + * <br>Some components such as link buttons don't have this. |
| 66 | + * |
| 67 | + * <p>Custom IDs can contain custom data, |
| 68 | + * this is typically used to pass data between a slash command and your button listener. |
| 69 | + * |
| 70 | + * <p>While this ID is unique and can be retrieved with {@link ComponentInteraction#getComponentId()}, |
| 71 | + * you should use {@link #getUniqueId()} to identify a component in a single message, |
| 72 | + * such as when replacing components using {@link ComponentTree} or {@link IReplaceable#replace(ComponentReplacer)}. |
| 73 | + * |
| 74 | + * @return The component ID or null if not present |
| 75 | + * |
| 76 | + * @see ComponentInteraction#getComponentId() |
| 77 | + * @see Component#getUniqueId() |
| 78 | + */ |
| 79 | + @Nullable |
| 80 | + String getCustomId(); |
| 81 | + |
| 82 | + @Nonnull |
| 83 | + @Override |
| 84 | + ICustomId withUniqueId(int uniqueId); |
| 85 | +} |
0 commit comments