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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
use chrono::{DateTime, FixedOffset}; use crate::model::prelude::*; use std::fmt::{ Display, Formatter, Result as FmtResult }; use super::{deserialize_single_recipient, serialize_single_recipient}; #[cfg(feature = "model")] use crate::builder::{ CreateMessage, EditMessage, GetMessages }; #[cfg(feature = "model")] use crate::http::AttachmentType; #[cfg(feature = "model")] use crate::internal::RwLockExt; #[cfg(feature = "http")] use crate::http::Http; /// A Direct Message text channel with another user. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct PrivateChannel { /// The unique Id of the private channel. /// /// Can be used to calculate the first message's creation date. pub id: ChannelId, /// The Id of the last message sent. pub last_message_id: Option<MessageId>, /// Timestamp of the last time a [`Message`] was pinned. /// /// [`Message`]: struct.Message.html pub last_pin_timestamp: Option<DateTime<FixedOffset>>, /// Indicator of the type of channel this is. /// /// This should always be [`ChannelType::Private`]. /// /// [`ChannelType::Private`]: enum.ChannelType.html#variant.Private #[serde(rename = "type")] pub kind: ChannelType, /// The recipient to the private channel. #[serde(deserialize_with = "deserialize_single_recipient", serialize_with = "serialize_single_recipient", rename = "recipients")] pub recipient: Arc<RwLock<User>>, #[serde(skip)] pub(crate) _nonexhaustive: (), } #[cfg(feature = "model")] impl PrivateChannel { /// Broadcasts that the current user is typing to the recipient. #[cfg(feature = "http")] pub fn broadcast_typing(&self, http: impl AsRef<Http>) -> Result<()> { self.id.broadcast_typing(&http) } /// React to a [`Message`] with a custom [`Emoji`] or unicode character. /// /// [`Message::react`] may be a more suited method of reacting in most /// cases. /// /// Requires the [Add Reactions] permission, _if_ the current user is the /// first user to perform a react with a certain emoji. /// /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Message`]: struct.Message.html /// [`Message::react`]: struct.Message.html#method.react /// [Add Reactions]: ../permissions/struct.Permissions.html#associatedconstant.ADD_REACTIONS #[cfg(feature = "http")] pub fn create_reaction<M, R>(&self, http: impl AsRef<Http>, message_id: M, reaction_type: R) -> Result<()> where M: Into<MessageId>, R: Into<ReactionType> { self.id.create_reaction(&http, message_id, reaction_type) } /// Deletes the channel. This does not delete the contents of the channel, /// and is equivalent to closing a private channel on the client, which can /// be re-opened. #[cfg(feature = "http")] #[inline] pub fn delete(&self, http: impl AsRef<Http>) -> Result<Channel> { self.id.delete(&http) } /// Deletes all messages by Ids from the given vector in the channel. /// /// Refer to [`Channel::delete_messages`] for more information. /// /// Requires the [Manage Messages] permission. /// /// **Note**: Messages that are older than 2 weeks can't be deleted using /// this method. /// /// # Errors /// /// Returns [`ModelError::BulkDeleteAmount`] if an attempt was made to /// delete either 0 or more than 100 messages. /// /// [`Channel::delete_messages`]: enum.Channel.html#method.delete_messages /// [`ModelError::BulkDeleteAmount`]: ../error/enum.Error.html#variant.BulkDeleteAmount /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] #[inline] pub fn delete_messages<T: AsRef<MessageId>, It: IntoIterator<Item=T>>(&self, http: impl AsRef<Http>, message_ids: It) -> Result<()> { self.id.delete_messages(&http, message_ids) } /// Deletes all permission overrides in the channel from a member /// or role. /// /// **Note**: Requires the [Manage Channel] permission. /// /// [Manage Channel]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_CHANNELS #[cfg(feature = "http")] #[inline] pub fn delete_permission(&self, http: impl AsRef<Http>, permission_type: PermissionOverwriteType) -> Result<()> { self.id.delete_permission(&http, permission_type) } /// Deletes the given [`Reaction`] from the channel. /// /// **Note**: Requires the [Manage Messages] permission, _if_ the current /// user did not perform the reaction. /// /// [`Reaction`]: struct.Reaction.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] #[inline] pub fn delete_reaction<M, R>(&self, http: impl AsRef<Http>, message_id: M, user_id: Option<UserId>, reaction_type: R) -> Result<()> where M: Into<MessageId>, R: Into<ReactionType> { self.id.delete_reaction(&http, message_id, user_id, reaction_type) } /// Edits a [`Message`] in the channel given its Id. /// /// Message editing preserves all unchanged message data. /// /// Refer to the documentation for [`EditMessage`] for more information /// regarding message restrictions and requirements. /// /// **Note**: Requires that the current user be the author of the message. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the [`the limit`], containing the number of unicode code points /// over the limit. /// /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [`EditMessage`]: ../../builder/struct.EditMessage.html /// [`Message`]: struct.Message.html /// [`the limit`]: ../../builder/struct.EditMessage.html#method.content #[cfg(feature = "http")] #[inline] pub fn edit_message<F, M>(&self, http: impl AsRef<Http>, message_id: M, f: F) -> Result<Message> where F: FnOnce(&mut EditMessage) -> &mut EditMessage, M: Into<MessageId> { self.id.edit_message(&http, message_id, f) } /// Determines if the channel is NSFW. /// /// **Note**: This method is for consistency. This will always return /// `false`, due to DMs not being considered NSFW. #[inline] pub fn is_nsfw(&self) -> bool { false } /// Gets a message from the channel. /// /// Requires the [Read Message History] permission. /// /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[cfg(feature = "http")] #[inline] pub fn message<M: Into<MessageId>>(&self, http: impl AsRef<Http>, message_id: M) -> Result<Message> { self.id.message(&http, message_id) } /// Gets messages from the channel. /// /// Refer to [`GetMessages`] for more information on how to use `builder`. /// /// Requires the [Read Message History] permission. /// /// [`GetMessages`]: ../../builder/struct.GetMessages.html /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[cfg(feature = "http")] #[inline] pub fn messages<F>(&self, http: impl AsRef<Http>, builder: F) -> Result<Vec<Message>> where F: FnOnce(&mut GetMessages) -> &mut GetMessages { self.id.messages(&http, builder) } /// Returns "DM with $username#discriminator". pub fn name(&self) -> String { format!("DM with {}", self.recipient.with(|r| r.tag())) } /// Gets the list of [`User`]s who have reacted to a [`Message`] with a /// certain [`Emoji`]. /// /// Refer to [`Channel::reaction_users`] for more information. /// /// **Note**: Requires the [Read Message History] permission. /// /// [`Channel::reaction_users`]: enum.Channel.html#method.reaction_users /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Message`]: struct.Message.html /// [`User`]: ../user/struct.User.html /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[cfg(feature = "http")] #[inline] pub fn reaction_users<M, R, U>(&self, http: impl AsRef<Http>, message_id: M, reaction_type: R, limit: Option<u8>, after: U, ) -> Result<Vec<User>> where M: Into<MessageId>, R: Into<ReactionType>, U: Into<Option<UserId>> { self.id.reaction_users(&http, message_id, reaction_type, limit, after) } /// Pins a [`Message`] to the channel. /// /// [`Message`]: struct.Message.html #[cfg(feature = "http")] #[inline] pub fn pin<M: Into<MessageId>>(&self, http: impl AsRef<Http>, message_id: M) -> Result<()> { self.id.pin(&http, message_id) } /// Retrieves the list of messages that have been pinned in the private /// channel. #[cfg(feature = "http")] #[inline] pub fn pins(&self, http: impl AsRef<Http>) -> Result<Vec<Message>> { self.id.pins(&http) } /// Sends a message with just the given message content in the channel. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the above limit, containing the number of unicode code points /// over the limit. /// /// [`ChannelId`]: ../id/struct.ChannelId.html /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong #[cfg(feature = "http")] #[inline] pub fn say(&self, http: impl AsRef<Http>, content: impl std::fmt::Display) -> Result<Message> { self.id.say(&http, content) } /// Sends (a) file(s) along with optional message contents. /// /// Refer to [`ChannelId::send_files`] for examples and more information. /// /// The [Attach Files] and [Send Messages] permissions are required. /// /// **Note**: Message contents must be under 2000 unicode code points. /// /// # Errors /// /// If the content of the message is over the above limit, then a /// [`ClientError::MessageTooLong`] will be returned, containing the number /// of unicode code points over the limit. /// /// [`ChannelId::send_files`]: ../id/struct.ChannelId.html#method.send_files /// [`ClientError::MessageTooLong`]: ../../client/enum.ClientError.html#variant.MessageTooLong /// [Attach Files]: ../permissions/struct.Permissions.html#associatedconstant.ATTACH_FILES /// [Send Messages]: ../permissions/struct.Permissions.html#associatedconstant.SEND_MESSAGES #[cfg(feature = "http")] #[inline] pub fn send_files<'a, F, T, It>(&self, http: impl AsRef<Http>, files: It, f: F) -> Result<Message> where for <'b> F: FnOnce(&'b mut CreateMessage<'a>) -> &'b mut CreateMessage<'a>, T: Into<AttachmentType<'a>>, It: IntoIterator<Item=T> { self.id.send_files(&http, files, f) } /// Sends a message to the channel with the given content. /// /// Refer to the documentation for [`CreateMessage`] for more information /// regarding message restrictions and requirements. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the above limit, containing the number of unicode code points /// over the limit. /// /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [`CreateMessage`]: ../../builder/struct.CreateMessage.html /// [`Message`]: struct.Message.html #[cfg(feature = "http")] #[inline] pub fn send_message<'a, F>(&self, http: impl AsRef<Http>, f: F) -> Result<Message> where for <'b> F: FnOnce(&'b mut CreateMessage<'a>) -> &'b mut CreateMessage<'a> { self.id.send_message(&http, f) } /// Unpins a [`Message`] in the channel given by its Id. /// /// Requires the [Manage Messages] permission. /// /// [`Message`]: struct.Message.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] #[inline] pub fn unpin<M: Into<MessageId>>(&self, http: impl AsRef<Http>, message_id: M) -> Result<()> { self.id.unpin(&http, message_id) } } impl Display for PrivateChannel { /// Formats the private channel, displaying the recipient's username. fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult { f.write_str(&self.recipient.read().name) } }