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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
#[cfg(feature = "http")]
use super::Builder;
#[cfg(feature = "http")]
use crate::http::CacheHttp;
#[cfg(feature = "http")]
use crate::internal::prelude::*;
use crate::model::prelude::*;
/// A builder to create a [`RichInvite`] for use via [`GuildChannel::create_invite`].
///
/// This is a structured and cleaner way of creating an invite, as all parameters are optional.
///
/// # Examples
///
/// Create an invite with a max age of 3600 seconds and 10 max uses:
///
/// ```rust,no_run
/// # use serenity::{prelude::*, model::prelude::*};
/// use serenity::builder::CreateInvite;
/// # async fn run(context: impl CacheHttp, channel: GuildChannel) -> Result<(), Box<dyn std::error::Error>> {
/// let builder = CreateInvite::new().max_age(3600).max_uses(10);
/// let creation = channel.create_invite(&context, builder).await?;
/// # Ok(())
/// # }
/// ```
///
/// [Discord docs](https://discord.com/developers/docs/resources/channel#create-channel-invite)
#[derive(Clone, Debug, Default, Serialize)]
#[must_use]
pub struct CreateInvite<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
max_age: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
max_uses: Option<u8>,
#[serde(skip_serializing_if = "Option::is_none")]
temporary: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
unique: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
target_type: Option<InviteTargetType>,
#[serde(skip_serializing_if = "Option::is_none")]
target_user_id: Option<UserId>,
#[serde(skip_serializing_if = "Option::is_none")]
target_application_id: Option<ApplicationId>,
#[serde(skip)]
audit_log_reason: Option<&'a str>,
}
impl<'a> CreateInvite<'a> {
/// Equivalent to [`Self::default`].
pub fn new() -> Self {
Self::default()
}
/// The duration that the invite will be valid for.
///
/// Set to `0` for an invite which does not expire after an amount of time.
///
/// Defaults to `86400`, or 24 hours.
///
/// # Examples
///
/// Create an invite with a max age of `3600` seconds, or 1 hour:
///
/// ```rust,no_run
/// # use serenity::model::prelude::*;
/// # use serenity::builder::CreateInvite;
/// # use serenity::http::CacheHttp;
/// #
/// # async fn example(context: impl CacheHttp, channel: GuildChannel) -> Result<(), Box<dyn std::error::Error>> {
/// let builder = CreateInvite::new().max_age(3600);
/// let invite = channel.create_invite(context, builder).await?;
/// # Ok(())
/// # }
/// ```
pub fn max_age(mut self, max_age: u32) -> Self {
self.max_age = Some(max_age);
self
}
/// The number of uses that the invite will be valid for.
///
/// Set to `0` for an invite which does not expire after a number of uses.
///
/// Defaults to `0`.
///
/// # Examples
///
/// Create an invite with a max use limit of `5`:
///
/// Create an invite with a max age of `3600` seconds, or 1 hour:
///
/// ```rust,no_run
/// # use serenity::model::prelude::*;
/// # use serenity::builder::CreateInvite;
/// # use serenity::http::CacheHttp;
/// #
/// # async fn example(context: impl CacheHttp, channel: GuildChannel) -> Result<(), Box<dyn std::error::Error>> {
/// let builder = CreateInvite::new().max_uses(5);
/// let invite = channel.create_invite(context, builder).await?;
/// # Ok(())
/// # }
/// ```
pub fn max_uses(mut self, max_uses: u8) -> Self {
self.max_uses = Some(max_uses);
self
}
/// Whether an invite grants a temporary membership.
///
/// Defaults to `false`.
///
/// # Examples
///
/// Create an invite which is temporary:
///
/// ```rust,no_run
/// # use serenity::model::prelude::*;
/// # use serenity::builder::CreateInvite;
/// # use serenity::http::CacheHttp;
/// #
/// # async fn example(context: impl CacheHttp, channel: GuildChannel) -> Result<(), Box<dyn std::error::Error>> {
/// let builder = CreateInvite::new().temporary(true);
/// let invite = channel.create_invite(context, builder).await?;
/// # Ok(())
/// # }
/// ```
pub fn temporary(mut self, temporary: bool) -> Self {
self.temporary = Some(temporary);
self
}
/// Whether or not to try to reuse a similar invite.
///
/// Defaults to `false`.
///
/// # Examples
///
/// Create an invite which is unique:
///
/// ```rust,no_run
/// # use serenity::model::prelude::*;
/// # use serenity::builder::CreateInvite;
/// # use serenity::http::CacheHttp;
/// #
/// # async fn example(context: impl CacheHttp, channel: GuildChannel) -> Result<(), Box<dyn std::error::Error>> {
/// let builder = CreateInvite::new().unique(true);
/// let invite = channel.create_invite(context, builder).await?;
/// # Ok(())
/// # }
/// ```
pub fn unique(mut self, unique: bool) -> Self {
self.unique = Some(unique);
self
}
/// The type of target for this voice channel invite.
pub fn target_type(mut self, target_type: InviteTargetType) -> Self {
self.target_type = Some(target_type);
self
}
/// The ID of the user whose stream to display for this invite, required if `target_type` is
/// `Stream`
/// The user must be streaming in the channel.
pub fn target_user_id(mut self, target_user_id: UserId) -> Self {
self.target_user_id = Some(target_user_id);
self
}
/// The ID of the embedded application to open for this invite, required if `target_type` is
/// `EmmbeddedApplication`.
///
/// The application must have the `EMBEDDED` flag.
///
/// When sending an invite with this value, the first user to use the invite will have to click
/// on the URL, that will enable the buttons in the embed.
///
/// These are some of the known applications which have the flag:
///
/// betrayal: `773336526917861400`
/// youtube: `755600276941176913`
/// fishing: `814288819477020702`
/// poker: `755827207812677713`
/// chess: `832012774040141894`
pub fn target_application_id(mut self, target_application_id: ApplicationId) -> Self {
self.target_application_id = Some(target_application_id);
self
}
/// Sets the request's audit log reason.
pub fn audit_log_reason(mut self, reason: &'a str) -> Self {
self.audit_log_reason = Some(reason);
self
}
}
#[cfg(feature = "http")]
#[async_trait::async_trait]
impl Builder for CreateInvite<'_> {
type Context<'ctx> = ChannelId;
type Built = RichInvite;
/// Creates an invite for the given channel.
///
/// **Note**: Requires the [Create Instant Invite] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns [`ModelError::InvalidPermissions`] if the current user
/// lacks permission. Otherwise returns [`Error::Http`], as well as if invalid data is given.
///
/// [Create Instant Invite]: Permissions::CREATE_INSTANT_INVITE
async fn execute(
self,
cache_http: impl CacheHttp,
ctx: Self::Context<'_>,
) -> Result<RichInvite> {
#[cfg(feature = "cache")]
{
if let Some(cache) = cache_http.cache() {
crate::utils::user_has_perms_cache(cache, ctx, Permissions::CREATE_INSTANT_INVITE)?;
}
}
cache_http.http().create_invite(ctx, &self, self.audit_log_reason).await
}
}