/
WebhookAction.java
96 lines (86 loc) · 2.95 KB
/
WebhookAction.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
91
92
93
94
95
96
/*
* Copyright 2015-2020 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.Guild;
import net.dv8tion.jda.api.entities.Icon;
import net.dv8tion.jda.api.entities.TextChannel;
import net.dv8tion.jda.api.entities.Webhook;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
/**
* {@link net.dv8tion.jda.api.entities.Webhook Webhook} Builder system created as an extension of {@link net.dv8tion.jda.api.requests.RestAction}
* <br>Provides an easy way to gather and deliver information to Discord to create {@link net.dv8tion.jda.api.entities.Webhook Webhooks}.
*
* @see net.dv8tion.jda.api.entities.TextChannel#createWebhook(String)
*/
public interface WebhookAction extends AuditableRestAction<Webhook>
{
@Nonnull
@Override
WebhookAction setCheck(@Nullable BooleanSupplier checks);
@Nonnull
@Override
WebhookAction timeout(long timeout, @Nonnull TimeUnit unit);
@Nonnull
@Override
WebhookAction deadline(long timestamp);
/**
* The {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} to create this webhook in
*
* @return The channel
*/
@Nonnull
TextChannel getChannel();
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} to create this webhook in
*
* @return The guild
*/
@Nonnull
default Guild getGuild()
{
return getChannel().getGuild();
}
/**
* Sets the <b>Name</b> for the custom Webhook User
*
* @param name
* A not-null String name for the new Webhook user.
*
* @throws IllegalArgumentException
* If the specified name is not in the range of 2-100.
*
* @return The current WebhookAction for chaining convenience.
*/
@Nonnull
@CheckReturnValue
WebhookAction setName(@Nonnull String name);
/**
* Sets the <b>Avatar</b> for the custom Webhook User
*
* @param icon
* An {@link net.dv8tion.jda.api.entities.Icon Icon} for the new avatar.
* Or null to use default avatar.
*
* @return The current WebhookAction for chaining convenience.
*/
@Nonnull
@CheckReturnValue
WebhookAction setAvatar(@Nullable Icon icon);
}