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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
use crate::model::prelude::*; #[cfg(feature = "model")] use std::fmt::Write as FmtWrite; #[cfg(feature = "model")] use crate::builder::{ CreateInvite, CreateMessage, EditChannel, EditMessage, GetMessages }; #[cfg(all(feature = "cache", feature = "model"))] use crate::cache::Cache; #[cfg(feature = "model")] use crate::http::AttachmentType; #[cfg(all(feature = "model", feature = "utils"))] use crate::utils; #[cfg(feature = "model")] use crate::http::{Http, CacheHttp, Typing}; #[cfg(feature = "model")] use serde_json::json; #[cfg(feature = "model")] use std::sync::Arc; use futures::stream::Stream; #[cfg(feature = "collector")] use crate::client::bridge::gateway::ShardMessenger; #[cfg(feature = "collector")] use crate::collector::{ CollectReaction, ReactionCollectorBuilder, CollectReply, MessageCollectorBuilder, }; #[cfg(feature = "model")] impl ChannelId { /// Broadcasts that the current user is typing to a channel for the next 5 /// seconds. /// /// After 5 seconds, another request must be made to continue broadcasting /// that the current user is typing. /// /// This should rarely be used for bots, and should likely only be used for /// signifying that a long-running command is still being executed. /// /// **Note**: Requires the [Send Messages] permission. /// /// # Examples /// /// ```rust,no_run /// use serenity::model::id::ChannelId; /// /// # async fn run() { /// # let http = serenity::http::Http::default(); /// let _successful = ChannelId(7).broadcast_typing(&http).await; /// # } /// ``` /// /// [Send Messages]: ../permissions/struct.Permissions.html#associatedconstant.SEND_MESSAGES #[inline] pub async fn broadcast_typing(self, http: impl AsRef<Http>) -> Result<()> { http.as_ref().broadcast_typing(self.0).await } /// Creates an invite leading to the given channel. #[cfg(feature = "utils")] pub async fn create_invite<F>(&self, http: impl AsRef<Http>, f: F) -> Result<RichInvite> where F: FnOnce(&mut CreateInvite) -> &mut CreateInvite { let mut invite = CreateInvite::default(); f(&mut invite); let map = utils::hashmap_to_json_map(invite.0); http.as_ref().create_invite(self.0, &map).await } /// Creates a [permission overwrite][`PermissionOverwrite`] for either a /// single [`Member`] or [`Role`] within the channel. /// /// Refer to the documentation for [`GuildChannel::create_permission`] for /// more information. /// /// Requires the [Manage Channels] permission. /// /// [`GuildChannel::create_permission`]: ../channel/struct.GuildChannel.html#method.create_permission /// [`Member`]: ../guild/struct.Member.html /// [`PermissionOverwrite`]: ../channel/struct.PermissionOverwrite.html /// [`Role`]: ../guild/struct.Role.html /// [Manage Channels]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_CHANNELS pub async fn create_permission(self, http: impl AsRef<Http>, target: &PermissionOverwrite) -> Result<()> { let (id, kind) = match target.kind { PermissionOverwriteType::Member(id) => (id.0, "member"), PermissionOverwriteType::Role(id) => (id.0, "role"), }; let map = json!({ "allow": target.allow.bits(), "deny": target.deny.bits(), "id": id, "type": kind, }); http.as_ref().create_permission(self.0, id, &map).await } /// 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`]: ../channel/struct.Message.html /// [`Message::react`]: ../channel/struct.Message.html#method.react /// [Add Reactions]: ../permissions/struct.Permissions.html#associatedconstant.ADD_REACTIONS #[inline] pub async fn create_reaction( self, http: impl AsRef<Http>, message_id: impl Into<MessageId>, reaction_type: impl Into<ReactionType> ) -> Result<()> { http.as_ref().create_reaction(self.0, message_id.into().0, &reaction_type.into()).await } /// Deletes this channel, returning the channel on a successful deletion. #[inline] pub async fn delete(self, http: impl AsRef<Http>) -> Result<Channel> { http.as_ref().delete_channel(self.0).await } /// Deletes a [`Message`] given its Id. /// /// Refer to [`Message::delete`] for more information. /// /// Requires the [Manage Messages] permission, if the current user is not /// the author of the message. /// /// [`Message`]: ../channel/struct.Message.html /// [`Message::delete`]: ../channel/struct.Message.html#method.delete /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[inline] pub async fn delete_message(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>) -> Result<()> { http.as_ref().delete_message(self.0, message_id.into().0).await } /// Deletes all messages by Ids from the given vector in the given channel. /// /// The minimum amount of messages is 2 and the maximum amount is 100. /// /// 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. /// /// [`ModelError::BulkDeleteAmount`]: ../error/enum.Error.html#variant.BulkDeleteAmount /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES pub async fn delete_messages<T, It>(self, http: impl AsRef<Http>, message_ids: It) -> Result<()> where T: AsRef<MessageId>, It: IntoIterator<Item=T>, { let ids = message_ids .into_iter() .map(|message_id| message_id.as_ref().0) .collect::<Vec<u64>>(); let len = ids.len(); if len == 0 || len > 100 { return Err(Error::Model(ModelError::BulkDeleteAmount)); } if ids.len() == 1 { self.delete_message(http, ids[0]).await } else { let map = json!({ "messages": ids }); http.as_ref().delete_messages(self.0, &map).await } } /// 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 pub async fn delete_permission( self, http: impl AsRef<Http>, permission_type: PermissionOverwriteType ) -> Result<()> { http.as_ref().delete_permission( self.0, match permission_type { PermissionOverwriteType::Member(id) => id.0, PermissionOverwriteType::Role(id) => id.0, }, ).await } /// Deletes the given [`Reaction`] from the channel. /// /// **Note**: Requires the [Manage Messages] permission, _if_ the current /// user did not perform the reaction. /// /// [`Reaction`]: ../channel/struct.Reaction.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[inline] pub async fn delete_reaction( self, http: impl AsRef<Http>, message_id: impl Into<MessageId>, user_id: Option<UserId>, reaction_type: impl Into<ReactionType> ) -> Result<()> { http.as_ref().delete_reaction( self.0, message_id.into().0, user_id.map(|uid| uid.0), &reaction_type.into(), ).await } /// Deletes all [`Reaction`]s of the given emoji to a message within the channel. /// /// **Note**: Requires the [Manage Messages] permission. /// /// [`Reaction`]: ../channel/struct.Reaction.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[inline] pub async fn delete_reaction_emoji( self, http: impl AsRef<Http>, message_id: impl Into<MessageId>, reaction_type: impl Into<ReactionType> ) -> Result<()> { http.as_ref().delete_message_reaction_emoji( self.0, message_id.into().0, &reaction_type.into() ).await } /// Edits the settings of a [`Channel`], optionally setting new values. /// /// Refer to `EditChannel`'s documentation for its methods. /// /// Requires the [Manage Channel] permission. /// /// # Examples /// /// Change a voice channel's name and bitrate: /// /// ```rust,no_run /// // assuming a `channel_id` has been bound /// ///# async fn run() { /// # use serenity::http::Http; /// # use serenity::model::id::ChannelId; /// # let http = Http::default(); /// # let channel_id = ChannelId(1234); /// channel_id.edit(&http, |c| c.name("test").bitrate(64000)).await; /// # } /// ``` /// /// [`Channel`]: ../channel/enum.Channel.html /// [Manage Channel]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_CHANNELS #[cfg(feature = "utils")] #[inline] pub async fn edit<F>(self, http: impl AsRef<Http>, f: F) -> Result<GuildChannel> where F: FnOnce(&mut EditChannel) -> &mut EditChannel { let mut channel = EditChannel::default(); f(&mut channel); let map = utils::hashmap_to_json_map(channel.0); http.as_ref().edit_channel(self.0, &map).await } /// 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`]: ../channel/struct.Message.html /// [`the limit`]: ../../builder/struct.EditMessage.html#method.content #[cfg(feature = "utils")] #[inline] pub async fn edit_message<F>(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>, f: F) -> Result<Message> where F: FnOnce(&mut EditMessage) -> &mut EditMessage { let mut msg = EditMessage::default(); f(&mut msg); if let Some(content) = msg.0.get(&"content") { if let Value::String(ref content) = *content { if let Some(length_over) = Message::overflow_length(content) { return Err(Error::Model(ModelError::MessageTooLong(length_over))); } } } let map = utils::hashmap_to_json_map(msg.0); http.as_ref().edit_message(self.0, message_id.into().0, &Value::Object(map)).await } /// Attempts to find a [`Channel`] by its Id in the cache. /// /// [`Channel`]: ../channel/enum.Channel.html #[cfg(feature = "cache")] #[inline] pub async fn to_channel_cached(self, cache: impl AsRef<Cache>) -> Option<Channel> { cache.as_ref().channel(self).await } /// First attempts to find a [`Channel`] by its Id in the cache, /// upon failure requests it via the REST API. /// /// **Note**: If the `cache`-feature is enabled permissions will be checked and upon /// owning the required permissions the HTTP-request will be issued. /// /// [`Channel`]: ../channel/enum.Channel.html #[inline] pub async fn to_channel(self, cache_http: impl CacheHttp) -> Result<Channel> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if let Some(channel) = cache.channel(self).await { return Ok(channel); } } } cache_http.http().get_channel(self.0).await } /// Gets all of the channel's invites. /// /// Requires the [Manage Channels] permission. /// /// [Manage Channels]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_CHANNELS #[inline] pub async fn invites(self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>> { http.as_ref().get_channel_invites(self.0).await } /// Gets a message from the channel. /// /// Requires the [Read Message History] permission. /// /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[inline] pub async fn message(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>) -> Result<Message> { http .as_ref() .get_message(self.0, message_id.into().0) .await .map(|mut msg| { msg.transform_content(); msg }) } /// 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 pub async fn messages<F>(self, http: impl AsRef<Http>, builder: F) -> Result<Vec<Message>> where F: FnOnce(&mut GetMessages) -> &mut GetMessages { let mut get_messages = GetMessages::default(); builder(&mut get_messages); let mut map = get_messages.0; let mut query = format!("?limit={}", map.remove(&"limit").unwrap_or(50)); if let Some(after) = map.remove(&"after") { write!(query, "&after={}", after)?; } else if let Some(around) = map.remove(&"around") { write!(query, "&around={}", around)?; } else if let Some(before) = map.remove(&"before") { write!(query, "&before={}", before)?; } http .as_ref() .get_messages(self.0, &query) .await .map(|msgs| { msgs.into_iter() .map(|mut msg| { msg.transform_content(); msg }) .collect::<Vec<Message>>() }) } /// Streams over all the messages in a channel. /// /// This is accomplished and equivalent to repeated calls to [`messages`]. /// A buffer of at most 100 messages is used to reduce the number of calls. /// necessary. /// /// The stream returns the oldest message first, followed by newer messages. /// /// # Examples /// /// ```rust,no_run /// # use serenity::model::id::ChannelId; /// # use serenity::http::Http; /// # /// # async fn run() { /// # let channel_id = ChannelId::default(); /// # let ctx = Http::default(); /// use serenity::model::channel::MessagesIter; /// use serenity::futures::StreamExt; /// /// let mut messages = channel_id.messages_iter(&ctx).boxed(); /// while let Some(message_result) = messages.next().await { /// match message_result { /// Ok(message) => println!( /// "{} said \"{}\".", /// message.author.name, /// message.content, /// ), /// Err(error) => eprintln!("Uh oh! Error: {}", error), /// } /// } /// # } /// ``` /// /// [`messages`]: ../id/struct.ChannelId.html#method.messages pub fn messages_iter<H: AsRef<Http>>(self, http: H) -> impl Stream<Item=Result<Message>> { MessagesIter::<H>::stream(http, self) } /// Returns the name of whatever channel this id holds. #[cfg(feature = "cache")] pub async fn name(self, cache: impl AsRef<Cache>) -> Option<String> { let channel = self.to_channel_cached(cache).await?; Some(match channel { Channel::Guild(channel) => channel.name().to_string(), Channel::Category(category) => category.name().to_string(), Channel::Private(channel) => channel.name(), }) } /// Pins a [`Message`] to the channel. /// /// [`Message`]: ../channel/struct.Message.html #[inline] pub async fn pin(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>) -> Result<()> { http.as_ref().pin_message(self.0, message_id.into().0).await } /// Gets the list of [`Message`]s which are pinned to the channel. /// /// [`Message`]: ../channel/struct.Message.html #[inline] pub async fn pins(self, http: impl AsRef<Http>) -> Result<Vec<Message>> { http.as_ref().get_pins(self.0).await } /// Gets the list of [`User`]s who have reacted to a [`Message`] with a /// certain [`Emoji`]. /// /// The default `limit` is `50` - specify otherwise to receive a different /// maximum number of users. The maximum that may be retrieve at a time is /// `100`, if a greater number is provided then it is automatically reduced. /// /// The optional `after` attribute is to retrieve the users after a certain /// user. This is useful for pagination. /// /// **Note**: Requires the [Read Message History] permission. /// /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Message`]: ../channel/struct.Message.html /// [`User`]: ../user/struct.User.html /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY pub async fn reaction_users(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>, reaction_type: impl Into<ReactionType>, limit: Option<u8>, after: impl Into<Option<UserId>>, ) -> Result<Vec<User>> { let limit = limit.map_or(50, |x| if x > 100 { 100 } else { x }); http.as_ref().get_reaction_users( self.0, message_id.into().0, &reaction_type.into(), limit, after.into().map(|x| x.0), ).await } /// 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`]: struct.ChannelId.html /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong #[inline] pub async fn say(self, http: impl AsRef<Http>, content: impl std::fmt::Display) -> Result<Message> { self.send_message(&http, |m| m.content(content)).await } /// Sends a file along with optional message contents. The filename _must_ /// be specified. /// /// Message contents may be passed by using the [`CreateMessage::content`] /// method. /// /// The [Attach Files] and [Send Messages] permissions are required. /// /// **Note**: Message contents must be under 2000 unicode code points. /// /// # Examples /// /// Send files with the paths `/path/to/file.jpg` and `/path/to/file2.jpg`: /// /// ```rust,no_run /// # use serenity::http::Http; /// # use std::sync::Arc; /// # /// # async fn run() { /// # let http = Arc::new(Http::default()); /// use serenity::model::id::ChannelId; /// /// let channel_id = ChannelId(7); /// /// let paths = vec!["/path/to/file.jpg", "path/to/file2.jpg"]; /// /// let _ = channel_id.send_files(&http, paths, |m| { /// m.content("a file") /// }) /// .await; /// # } /// ``` /// /// Send files using `File`: /// /// ```rust,no_run /// # use serenity::http::Http; /// # use std::sync::Arc; /// # /// # async fn run() -> Result<(), Box<dyn std::error::Error>> { /// # let http = Arc::new(Http::default()); /// use serenity::model::id::ChannelId; /// use tokio::fs::File; /// /// let channel_id = ChannelId(7); /// /// let f1 = File::open("my_file.jpg").await?; /// let f2 = File::open("my_file2.jpg").await?; /// /// let files = vec![(&f1, "my_file.jpg"), (&f2, "my_file2.jpg")]; /// /// let _ = channel_id.send_files(&http, files, |m| { /// m.content("a file") /// }) /// .await; /// # Ok(()) /// # } /// ``` /// /// # Errors /// /// If the content of the message is over the above limit, then a /// [`ModelError::MessageTooLong`] will be returned, containing the number /// of unicode code points over the limit. /// /// Returns an /// [`HttpError::UnsuccessfulRequest(ErrorResponse)`][`HttpError::UnsuccessfulRequest`] /// if the file is too large to send. /// /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [`HttpError::UnsuccessfulRequest`]: ../../http/enum.HttpError.html#variant.UnsuccessfulRequest /// [`CreateMessage::content`]: ../../builder/struct.CreateMessage.html#method.content /// [`GuildChannel`]: struct.GuildChannel.html /// [Attach Files]: ../permissions/struct.Permissions.html#associatedconstant.ATTACH_FILES /// [Send Messages]: ../permissions/struct.Permissions.html#associatedconstant.SEND_MESSAGES #[cfg(feature = "utils")] pub async 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> { let mut create_message = CreateMessage::default(); let msg = f(&mut create_message); if let Some(content) = msg.0.get(&"content") { if let Value::String(ref content) = *content { if let Some(length_over) = Message::overflow_length(content) { return Err(Error::Model(ModelError::MessageTooLong(length_over))); } } } if let Some(e) = msg.0.remove(&"embed") { msg.0.insert("payload_json", json!({ "embed": e })); } let map = utils::hashmap_to_json_map(msg.0.clone()); http.as_ref().send_files(self.0, files, map).await } /// Sends a message to the channel. /// /// Refer to the documentation for [`CreateMessage`] for more information /// regarding message restrictions and requirements. /// /// Requires the [Send Messages] permission. /// /// **Note**: Message contents must be under 2000 unicode code points. /// /// # 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. /// /// [`Channel`]: ../channel/enum.Channel.html /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [`CreateMessage`]: ../../builder/struct.CreateMessage.html /// [Send Messages]: ../permissions/struct.Permissions.html#associatedconstant.SEND_MESSAGES #[cfg(feature = "utils")] pub async 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> { let mut create_message = CreateMessage::default(); let msg = f(&mut create_message); if !msg.2.is_empty() { if let Some(e) = msg.0.remove(&"embed") { if let Some(c) = msg.0.remove(&"content") { msg.0.insert("payload_json", json!({ "content": c, "embed": e })); } else { msg.0.insert("payload_json", json!({ "embed": e })); } } } let map = utils::hashmap_to_json_map(msg.0.clone()); Message::check_content_length(&map)?; Message::check_embed_length(&map)?; let message = if msg.2.is_empty() { http.as_ref().send_message(self.0, &Value::Object(map)).await? } else { http.as_ref().send_files(self.0, msg.2.clone(), map).await? }; if let Some(reactions) = msg.1.clone() { for reaction in reactions { self.create_reaction(&http, message.id, reaction).await?; } } Ok(message) } /// Starts typing in the channel for an indefinite period of time. /// /// Returns [`Typing`] that is used to trigger the typing. [`Typing::stop`] must be called /// on the returned struct to stop typing. Note that on some clients, typing may persist /// for a few seconds after `stop` is called. /// Typing is also stopped when the struct is dropped. /// /// If a message is sent while typing is triggered, the user will stop typing for a brief period /// of time and then resume again until either `stop` is called or the struct is dropped. /// /// This should rarely be used for bots, although it is a good indicator that a /// long-running command is still being processed. /// /// ## Examples /// /// ```rust,no_run /// # use serenity::{http::{Http, Typing}, Result, model::id::ChannelId}; /// # use std::sync::Arc; /// # /// # fn long_process() {} /// # fn main() -> Result<()> { /// # let http = Arc::new(Http::default()); /// // Initiate typing (assuming http is `Arc<Http>`) /// let typing = ChannelId(7).start_typing(&http)?; /// /// // Run some long-running process /// long_process(); /// /// // Stop typing /// typing.stop(); /// # /// # Ok(()) /// # } /// ``` /// /// [`Typing`]: ../../http/typing/struct.Typing.html /// [`Typing::stop`]: ../../http/typing/struct.Typing.html#method.stop pub fn start_typing(self, http: &Arc<Http>) -> Result<Typing> { http.start_typing(self.0) } /// Unpins a [`Message`] in the channel given by its Id. /// /// Requires the [Manage Messages] permission. /// /// [`Message`]: ../channel/struct.Message.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[inline] pub async fn unpin(self, http: impl AsRef<Http>, message_id: impl Into<MessageId>) -> Result<()> { http.as_ref().unpin_message(self.0, message_id.into().0).await } /// Retrieves the channel's webhooks. /// /// **Note**: Requires the [Manage Webhooks] permission. /// /// [Manage Webhooks]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_WEBHOOKS #[inline] pub async fn webhooks(self, http: impl AsRef<Http>) -> Result<Vec<Webhook>> { http.as_ref().get_channel_webhooks(self.0).await } /// Returns a future that will await one message sent in this channel. #[cfg(feature = "collector")] pub fn await_reply<'a>(&self, shard_messenger: &'a impl AsRef<ShardMessenger>) -> CollectReply<'a> { CollectReply::new(shard_messenger).channel_id(self.0) } /// Returns a stream builder which can be awaited to obtain a stream of messages in this channel. #[cfg(feature = "collector")] pub fn await_replies<'a>(&self, shard_messenger: &'a impl AsRef<ShardMessenger>) -> MessageCollectorBuilder<'a> { MessageCollectorBuilder::new(shard_messenger).channel_id(self.0) } /// Await a single reaction in this guild. #[cfg(feature = "collector")] pub fn await_reaction<'a>(&self, shard_messenger: &'a impl AsRef<ShardMessenger>) -> CollectReaction<'a> { CollectReaction::new(shard_messenger).channel_id(self.0) } /// Returns a stream builder which can be awaited to obtain a stream of reactions sent in this channel. #[cfg(feature = "collector")] pub fn await_reactions<'a>(&self, shard_messenger: &'a impl AsRef<ShardMessenger>) -> ReactionCollectorBuilder<'a> { ReactionCollectorBuilder::new(shard_messenger).channel_id(self.0) } } impl From<Channel> for ChannelId { /// Gets the Id of a `Channel`. fn from(channel: Channel) -> ChannelId { channel.id() } } impl<'a> From<&'a Channel> for ChannelId { /// Gets the Id of a `Channel`. fn from(channel: &Channel) -> ChannelId { channel.id() } } impl From<PrivateChannel> for ChannelId { /// Gets the Id of a private channel. fn from(private_channel: PrivateChannel) -> ChannelId { private_channel.id } } impl<'a> From<&'a PrivateChannel> for ChannelId { /// Gets the Id of a private channel. fn from(private_channel: &PrivateChannel) -> ChannelId { private_channel.id } } impl From<GuildChannel> for ChannelId { /// Gets the Id of a guild channel. fn from(public_channel: GuildChannel) -> ChannelId { public_channel.id } } impl<'a> From<&'a GuildChannel> for ChannelId { /// Gets the Id of a guild channel. fn from(public_channel: &GuildChannel) -> ChannelId { public_channel.id } } /// A helper class returned by [`ChannelId::messages_iter`] /// /// [`ChannelId::messages_iter`]: ../id/struct.ChannelId.html#method.messages_iter #[derive(Clone, Debug)] #[cfg(feature = "model")] pub struct MessagesIter<H: AsRef<Http>> { channel_id: ChannelId, http: H, buffer: Vec<Message>, before: Option<MessageId>, tried_fetch: bool, } #[cfg(feature = "model")] impl<H: AsRef<Http>> MessagesIter<H> { fn new(channel_id: ChannelId, http: H) -> MessagesIter<H> { MessagesIter { channel_id, http, buffer: Vec::new(), before: None, tried_fetch: false, } } /// Fills the `self.buffer` cache of Messages. /// /// This drops any messages that were currently in the buffer, so it should /// only be called when `self.buffer` is empty. Additionally, this updates /// `self.before` so that the next call does not return duplicate items. /// If there are no more messages to be fetched, then this marks /// `self.before` as None, indicating that no more calls ought to be made. /// /// If this method is called with `self.before` as None, the last 100 /// (or lower) messages sent in the channel are added in the buffer. /// /// The messages are sorted such that the newest message is the first /// element of the buffer and the newest message is the last. async fn refresh(&mut self) -> Result<()> { // Number of messages to fetch. let grab_size = 100; // If `self.before` is not set yet, we can use `.messages` to fetch // the last message after very first fetch from last. self.buffer = self.channel_id.messages(&self.http, |b| { if let Some(before) = self.before { b.before(before); } b.limit(grab_size) }).await?; self.before = self.buffer.get(0) .map(|message| message.id); self.tried_fetch = true; Ok(()) } /// Streams over all the messages in a channel. /// /// This is accomplished and equivalent to repeated calls to [`messages`]. /// A buffer of at most 100 messages is used to reduce the number of calls. /// necessary. /// /// The stream returns the newest message first, followed by older messages. /// /// # Examples /// /// ```rust,no_run /// # use serenity::model::id::ChannelId; /// # use serenity::http::Http; /// # /// # async fn run() { /// # let channel_id = ChannelId::default(); /// # let ctx = Http::default(); /// use serenity::model::channel::MessagesIter; /// use serenity::futures::StreamExt; /// /// let mut messages = MessagesIter::<Http>::stream(&ctx, channel_id).boxed(); /// while let Some(message_result) = messages.next().await { /// match message_result { /// Ok(message) => println!( /// "{} said \"{}\"", /// message.author.name, /// message.content, /// ), /// Err(error) => eprintln!("Uh oh! Error: {}", error), /// } /// } /// # } /// ``` /// /// [`messages`]: ../id/struct.ChannelId.html#method.messages pub fn stream(http: impl AsRef<Http>, channel_id: ChannelId) -> impl Stream<Item=Result<Message>> { let init_state = MessagesIter::new(channel_id, http); futures::stream::unfold(init_state, |mut state| async { if state.buffer.is_empty() && state.before.is_some() || !state.tried_fetch { if let Err(error) = state.refresh().await { return Some((Err(error), state)); } } // the resultant stream goes from newest to oldest. state.buffer.pop().map(|entry| (Ok(entry), state)) }) } }