/
StageInstanceAction.java
80 lines (72 loc) · 2.76 KB
/
StageInstanceAction.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
/*
* 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.requests.restaction;
import net.dv8tion.jda.api.entities.StageInstance;
import net.dv8tion.jda.api.requests.RestAction;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
/**
* Specialized {@link RestAction} used to create a {@link StageInstance}
*
* @see net.dv8tion.jda.api.entities.StageChannel#createStageInstance(String)
*/
public interface StageInstanceAction extends RestAction<StageInstance>
{
@Nonnull
@Override
StageInstanceAction setCheck(@Nullable BooleanSupplier checks);
@Nonnull
@Override
StageInstanceAction timeout(long timeout, @Nonnull TimeUnit unit);
@Nonnull
@Override
StageInstanceAction deadline(long timestamp);
/**
* Sets the topic for the stage instance.
* <br>This shows up in stage discovery and in the stage view.
*
* @param topic
* The topic, must be 1-120 characters long
*
* @throws IllegalArgumentException
* If the topic is null, empty, or longer than 120 characters
*
* @return The StageInstanceAction for chaining
*/
@Nonnull
@CheckReturnValue
StageInstanceAction setTopic(@Nonnull String topic);
/**
* Sets the {@link net.dv8tion.jda.api.entities.StageInstance.PrivacyLevel PrivacyLevel} for the stage instance.
* <br>This indicates whether guild lurkers are allowed to join the stage instance or only guild members.
*
* @param level
* The {@link net.dv8tion.jda.api.entities.StageInstance.PrivacyLevel}
*
* @throws IllegalArgumentException
* If the privacy level is null, {@link net.dv8tion.jda.api.entities.StageInstance.PrivacyLevel#UNKNOWN UNKNOWN},
* or {@link net.dv8tion.jda.api.entities.StageInstance.PrivacyLevel#PUBLIC PUBLIC}.
*
* @return The StageInstanceAction for chaining
*/
@Nonnull
@CheckReturnValue
@SuppressWarnings("deprecation")
StageInstanceAction setPrivacyLevel(@Nonnull StageInstance.PrivacyLevel level);
}