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
use std::ops::Deref;
use serde::{Deserialize, Serialize};
use crate::types::{UntilDate, User};
/// This object contains information about one member of the chat.
///
/// [The official docs](https://core.telegram.org/bots/api#chatmember).
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct ChatMember {
/// Information about the user.
pub user: User,
/// The member's status in the chat.
#[serde(flatten)]
pub kind: ChatMemberKind,
}
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "status")]
pub enum ChatMemberKind {
#[serde(rename = "creator")]
Owner(Owner),
Administrator(Administrator),
Member,
Restricted(Restricted),
Left,
#[serde(rename = "kicked")]
Banned(Banned),
}
/// Owner of the group. This struct is part of the [`ChatMemberKind`] enum.
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct Owner {
/// Custom title for this user.
pub custom_title: Option<String>,
/// True, if the user's presence in the chat is hidden
pub is_anonymous: bool,
}
/// Administrator of the group. This struct is part of the [`ChatMemberKind`]
/// enum.
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct Administrator {
/// Custom title for this user.
pub custom_title: Option<String>,
/// `true` if the user's presence in the chat is hidden
pub is_anonymous: bool,
/// `true` if the bot is allowed to edit administrator privileges of that
/// user.
pub can_be_edited: bool,
/// `true` if the administrator can access the chat event log, chat
/// statistics, message statistics in channels, see channel members, see
/// anonymous administrators in supergroups and ignore slow mode. Implied by
/// any other administrator privilege
pub can_manage_chat: bool,
/// `true` if the administrator can change the chat title, photo and other
/// settings.
pub can_change_info: bool,
/// `true` if the administrator can post in the channel, channels only.
#[serde(default)]
pub can_post_messages: bool,
/// `true` if the administrator can edit messages of other users and can pin
/// messages, channels only.
#[serde(default)]
pub can_edit_messages: bool,
/// `true` if the administrator can delete messages of other users.
pub can_delete_messages: bool,
/// `true` if the administrator can manage video chats.
pub can_manage_video_chats: bool,
/// `true` if the administrator can invite new users to the chat.
pub can_invite_users: bool,
/// `true` if the administrator can restrict, ban or unban chat members.
pub can_restrict_members: bool,
/// `true` if the administrator can pin messages, supergroups only.
#[serde(default)]
pub can_pin_messages: bool,
/// `true`, if the user is allowed to create, rename, close, and reopen
/// forum topics; supergroups only
#[serde(default)]
pub can_manage_topics: bool,
/// `true` if the administrator can add new administrators with a subset of
/// his own privileges or demote administrators that he has promoted,
/// directly or indirectly (promoted by administrators that were appointed
/// by the user).
pub can_promote_members: bool,
}
/// User, restricted in the group. This struct is part of the [`ChatMemberKind`]
/// enum.
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct Restricted {
/// Date when restrictions will be lifted for this user.
pub until_date: UntilDate,
/// `true` if the user is a member of the chat at the moment of the request.
pub is_member: bool,
/// `true` if the user can send text messages, contacts, locations and
/// venues.
pub can_send_messages: bool,
/// `true` if the user is allowed to send audios, documents, photos, videos,
/// video notes and voice notes.
pub can_send_media_messages: bool,
/// `true` if the user is allowed to send animations, games, stickers and
/// use inline bots.
pub can_send_other_messages: bool,
/// `true` if the user is allowed to add web page previews to their
/// messages.
pub can_add_web_page_previews: bool,
/// `true` if the user is allowed to change the chat title, photo
/// and other settings.
pub can_change_info: bool,
/// `true` if the user is allowed to invite new users to the chat.
pub can_invite_users: bool,
/// `true` if the user is allowed to pin messages.
pub can_pin_messages: bool,
/// `true`, if the user is allowed to create, rename, close, and reopen
/// forum topics
pub can_manage_topics: bool,
/// `true` if the user is allowed to send polls.
pub can_send_polls: bool,
}
/// User that was banned in the chat and can't return to it or view chat
/// messages. This struct is part of the [`ChatMemberKind`] enum.
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct Banned {
/// Date when restrictions will be lifted for this user.
pub until_date: UntilDate,
}
/// This allows calling [`ChatMemberKind`]'s methods directly on [`ChatMember`].
///
/// ```no_run
/// use teloxide_core::types::ChatMember;
///
/// let member: ChatMember = todo!();
///
/// let _ = member.status();
/// let _ = member.kind.status();
/// ```
impl Deref for ChatMember {
type Target = ChatMemberKind;
fn deref(&self) -> &Self::Target {
&self.kind
}
}
/// Simple methods for checking a user status.
impl ChatMemberKind {
/// Returns chat member status.
#[must_use]
pub fn status(&self) -> ChatMemberStatus {
match self {
ChatMemberKind::Owner(_) => ChatMemberStatus::Owner,
ChatMemberKind::Administrator(_) => ChatMemberStatus::Administrator,
ChatMemberKind::Member => ChatMemberStatus::Member,
ChatMemberKind::Restricted(_) => ChatMemberStatus::Restricted,
ChatMemberKind::Left => ChatMemberStatus::Left,
ChatMemberKind::Banned(_) => ChatMemberStatus::Banned,
}
}
/// Returns `true` if the user is the [owner] of the given chat.
///
/// [owner]: ChatMemberKind::Owner
#[must_use]
pub fn is_owner(&self) -> bool {
matches!(self, Self::Owner { .. })
}
/// Returns `true` if the user is an [administrator] of the given chat.
///
/// [administrator]: ChatMemberKind::Administrator
///
/// **Note**: this function **doesn't** return `true` if the user is the
/// owner of the given chat. See also: [`is_privileged`].
///
/// [`is_privileged`]: ChatMemberKind::is_privileged
#[must_use]
pub fn is_administrator(&self) -> bool {
matches!(self, Self::Administrator { .. })
}
/// Returns `true` if the user is a common [member] of the given chat.
///
/// ⚠️ Don't confuse this with [`is_present`]. This method merely checks
/// for [`ChatMemberKind::Member`] variant which is not enough to determine
/// if the user is joinned to the chat. Use [`is_present`] for that instead.
///
/// [member]: ChatMemberKind::Member
/// [`is_present`]: ChatMemberKind::is_present
#[must_use]
pub fn is_member(&self) -> bool {
matches!(self, Self::Member { .. })
}
/// Returns `true` if the user is [restricted] in the given chat.
///
/// [restricted]: ChatMemberKind::Restricted
#[must_use]
pub fn is_restricted(&self) -> bool {
matches!(self, Self::Restricted { .. })
}
/// Returns `true` if the user [left] the given chat.
///
/// ⚠️ Don't confuse this with [`is_present`]. This method merely checks
/// for [`ChatMemberKind::Left`] variant which is not enough to determine
/// if the user is joinned to the chat. Use [`is_present`] for that instead.
///
/// [left]: ChatMemberKind::Left
/// [`is_present`]: ChatMemberKind::is_present
#[must_use]
pub fn is_left(&self) -> bool {
matches!(self, Self::Left { .. })
}
/// Returns `true` if the user is [banned] in the given chat.
///
/// [banned]: ChatMemberKind::Banned
#[must_use]
pub fn is_banned(&self) -> bool {
matches!(self, Self::Banned { .. })
}
/// Returns `true` if the user is [kicked] from the given chat.
///
/// [kicked]: ChatMemberKind::Banned
#[deprecated = "use `is_banned` instead"]
#[must_use]
pub fn is_kicked(&self) -> bool {
self.is_banned()
}
/// Returns `true` if the user is the [creator] (owner) of the given chat.
///
/// [creator]: ChatMemberKind::Owner
#[deprecated = "use `is_owner` instead"]
#[must_use]
pub fn is_creator(&self) -> bool {
self.is_owner()
}
}
/// Compound methods for checking a user status.
impl ChatMemberKind {
/// Returns `true` if the user is privileged in the given chat. i.e. if the
/// user is either the [owner] or an [administrator] in the given chat.
///
/// [owner]: ChatMemberKind::Owner
/// [administrator]: ChatMemberKind::Administrator
#[must_use]
pub fn is_privileged(&self) -> bool {
self.is_administrator() || self.is_owner()
}
/// Returns `true` if the user is currently present in the chat. i.e. if the
/// user **hasn't** [left] or been [banned]. It also returns `false` if the
/// user left the chat, but was [restricted].
///
/// [left]: ChatMemberKind::Left
/// [banned]: ChatMemberKind::Banned
/// [restricted]: ChatMemberKind::Restricted
#[must_use]
pub fn is_present(&self) -> bool {
let is_restricted_non_member =
matches!(self, Self::Restricted(Restricted { is_member: false, .. }));
!(self.is_left() || self.is_banned() || is_restricted_non_member)
}
}
impl ChatMemberKind {
/// Getter for [`Administrator::custom_title`] and [`Owner::custom_title`]
/// fields.
#[must_use]
pub fn custom_title(&self) -> Option<&str> {
match &self {
Self::Administrator(Administrator { custom_title, .. })
| Self::Owner(Owner { custom_title, .. }) => custom_title.as_deref(),
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => None,
}
}
/// Returns `true` if the user's presence in the chat is hidden.
///
/// I.e. returns `true` if the user is the owner of the chat or an
/// administrator in the chat and has the [`can_manage_chat`] privilege.
/// Returns `false` otherwise.
///
/// [`can_manage_chat`]: Administrator::can_manage_chat
#[must_use]
pub fn is_anonymous(&self) -> bool {
match self {
Self::Owner(Owner { is_anonymous, .. })
| Self::Administrator(Administrator { is_anonymous, .. }) => *is_anonymous,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Getter for [`Restricted::until_date`] and [`Banned::until_date`] fields.
#[must_use]
pub fn until_date(&self) -> Option<UntilDate> {
match &self {
Self::Owner(_) | Self::Administrator(_) | Self::Member | Self::Left => None,
Self::Restricted(Restricted { until_date, .. })
| Self::Banned(Banned { until_date, .. }) => Some(*until_date),
}
}
}
/// Methods for checking admin privileges.
impl ChatMemberKind {
/// Returns `true` if the user is an administrator in the given chat and the
/// bot is allowed to edit administrator privileges of that user.
#[must_use]
pub fn can_be_edited(&self) -> bool {
match self {
Self::Administrator(Administrator { can_be_edited, .. }) => *can_be_edited,
// Owner can't ever be edited by any bot.
Self::Owner(_) | Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => {
false
}
}
}
/// Returns `true` if the user can access the chat event log, chat
/// statistics, message statistics in channels, see channel members, see
/// anonymous administrators in supergroups and ignore slow mode. Implied by
/// any other administrator privilege.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has [`can_manage_chat`]
/// privilege.
/// Returns `false` otherwise.
///
/// [`can_manage_chat`]: Administrator::can_manage_chat
#[must_use]
pub fn can_manage_chat(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_manage_chat, .. }) => *can_manage_chat,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can change the chat title, photo and other
/// settings.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has the
/// [`Administrator::can_change_info`] privilege.
/// - is restricted, but does have [`Restricted::can_change_info`] privilege
/// Returns `false` otherwise.
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_change_info` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_change_info(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_change_info, .. })
| Self::Restricted(Restricted { can_change_info, .. }) => *can_change_info,
Self::Member | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can post in the channel, channels only.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat (even if the chat is not a channel)
/// - is an administrator in the given chat and has [`can_post_messages`]
/// privilege.
/// Returns `false` otherwise.
///
/// [`can_post_messages`]: Administrator::can_post_messages
#[must_use]
pub fn can_post_messages(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_post_messages, .. }) => *can_post_messages,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can edit messages of other users and can pin
/// messages, channels only.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat (even if the chat is not a channel)
/// - is an administrator in the given chat and has the
/// [`can_edit_messages`] privilege.
/// Returns `false` otherwise.
///
/// [`can_edit_messages`]: Administrator::can_edit_messages
#[must_use]
pub fn can_edit_messages(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_edit_messages, .. }) => *can_edit_messages,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can delete messages of other users.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has the
/// [`can_delete_messages`] privilege.
/// Returns `false` otherwise.
///
/// [`can_delete_messages`]: Administrator::can_delete_messages
#[must_use]
pub fn can_delete_messages(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_delete_messages, .. }) => *can_delete_messages,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can manage video chats.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has the
/// [`can_manage_video_chats`] privilege.
/// Returns `false` otherwise.
///
/// [`can_manage_video_chats`]: Administrator::can_manage_video_chats
#[must_use]
pub fn can_manage_video_chats(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_manage_video_chats, .. }) => {
*can_manage_video_chats
}
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
#[deprecated(since = "0.6.0", note = "renamed to `can_manage_video_chats`")]
#[must_use]
pub fn can_manage_voice_chats(&self) -> bool {
self.can_manage_video_chats()
}
/// Returns `true` if the user can can invite new users to the chat.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has the
/// [`Administrator::can_invite_users`] privilege.
/// - is restricted, but does have [`Restricted::can_invite_users`]
/// privilege
/// Returns `false` otherwise.
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_invite_users` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_invite_users(&self) -> bool {
match &self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_invite_users, .. })
| Self::Restricted(Restricted { can_invite_users, .. }) => *can_invite_users,
Self::Member | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can restrict, ban or unban chat members.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat
/// - is an administrator in the given chat and has the
/// [`can_restrict_members`] privilege.
/// Returns `false` otherwise.
///
/// [`can_restrict_members`]: Administrator::can_restrict_members
#[must_use]
pub fn can_restrict_members(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_restrict_members, .. }) => {
*can_restrict_members
}
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user can pin messages, supergroups only.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat (even if the chat is not a supergroup)
/// - is an administrator in the given chat and has the
/// [`Administrator::can_pin_messages`] privilege.
/// - is restricted, but does have [`Restricted::can_pin_messages`]
/// privilege
/// Returns `false` otherwise.
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_pin_messages` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_pin_messages(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_pin_messages, .. })
| Self::Restricted(Restricted { can_pin_messages, .. }) => *can_pin_messages,
Self::Member | Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user is allowed to manage topics.
///
/// I.e. returns `true` if the user
/// - is the owner of the chat (even if the chat is not a supergroup)
/// - is an administrator in the given chat and has the
/// [`Administrator::can_manage_topics`] privilege.
/// - is restricted, but does have [`Restricted::can_manage_topics`]
/// privilege
/// Returns `false` otherwise.
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_manage_topics` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_manage_topics(&self) -> bool {
match self {
ChatMemberKind::Owner(_) => true,
ChatMemberKind::Administrator(Administrator { can_manage_topics, .. })
| ChatMemberKind::Restricted(Restricted { can_manage_topics, .. }) => {
*can_manage_topics
}
ChatMemberKind::Member | ChatMemberKind::Left | ChatMemberKind::Banned(_) => false,
}
}
/// Returns `true` if the user can add new administrators with a subset of
/// his own privileges or demote administrators that he has promoted,
/// directly or indirectly (promoted by administrators that were appointed
/// by the user).
///
/// I.e. returns `true` if the user
/// - is the owner of the chat (even if the chat is not a channel)
/// - is an administrator in the given chat and has the
/// [`can_promote_members`] privilege.
/// Returns `false` otherwise.
///
/// [`can_promote_members`]: Administrator::can_promote_members
#[must_use]
pub fn can_promote_members(&self) -> bool {
match self {
Self::Owner(_) => true,
Self::Administrator(Administrator { can_promote_members, .. }) => *can_promote_members,
Self::Member | Self::Restricted(_) | Self::Left | Self::Banned(_) => false,
}
}
}
/// Methods for checking member rights.
impl ChatMemberKind {
/// Returns `true` if the user can send text messages, contacts, locations
/// and venues.
///
/// I.e. returns **`false`** if the user
/// - has left or has been banned in the chat
/// - is restricted and doesn't have the [`can_send_messages`] right
/// Returns `true` otherwise.
///
/// [`can_send_messages`]: Restricted::can_send_messages
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_send_messages` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_send_messages(&self) -> bool {
match &self {
Self::Restricted(Restricted { can_send_messages, .. }) => *can_send_messages,
Self::Owner(_) | Self::Administrator(_) | Self::Member => true,
Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user is allowed to send audios, documents, photos,
/// videos, video notes and voice notes.
///
/// I.e. returns **`false`** if the user
/// - has left or has been banned in the chat
/// - is restricted and doesn't have the [`can_send_media_messages`] right
/// Returns `true` otherwise.
///
/// [`can_send_media_messages`]: Restricted::can_send_media_messages
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_send_media_messages` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_send_media_messages(&self) -> bool {
match &self {
Self::Restricted(Restricted { can_send_media_messages, .. }) => {
*can_send_media_messages
}
Self::Owner(_) | Self::Administrator(_) | Self::Member => true,
Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user is allowed to send animations, games,
/// stickers and use inline bots.
///
/// I.e. returns **`false`** if the user
/// - has left or has been banned from the chat
/// - is restricted and doesn't have the [`can_send_media_messages`] right
/// Returns `true` otherwise.
///
/// [`can_send_media_messages`]: Restricted::can_send_media_messages
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_send_other_messages` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_send_other_messages(&self) -> bool {
match &self {
Self::Restricted(Restricted { can_send_other_messages, .. }) => {
*can_send_other_messages
}
Self::Owner(_) | Self::Administrator(_) | Self::Member => true,
Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user is allowed to add web page previews to their
/// messages.
///
/// I.e. returns **`false`** if the user
/// - has left or has been banned from the chat
/// - is restricted and doesn't have the [`can_send_media_messages`] right
/// Returns `true` otherwise.
///
/// [`can_send_media_messages`]: Restricted::can_send_media_messages
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_add_web_page_previews` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_add_web_page_previews(&self) -> bool {
match &self {
Self::Restricted(Restricted { can_add_web_page_previews, .. }) => {
*can_add_web_page_previews
}
Self::Owner(_) | Self::Administrator(_) | Self::Member => true,
Self::Left | Self::Banned(_) => false,
}
}
/// Returns `true` if the user is allowed to send polls.
///
/// I.e. returns **`false`** if the user
/// - has left or has been banned from the chat
/// - is restricted and doesn't have the [`can_send_polls`] right
/// Returns `true` otherwise.
///
/// [`can_send_polls`]: Restricted::can_send_polls
#[deprecated(
since = "0.9.0",
note = "Match manually and use `can_send_polls` field directly. Details: https://github.com/teloxide/teloxide/issues/781"
)]
#[must_use]
pub fn can_send_polls(&self) -> bool {
match &self {
Self::Restricted(Restricted { can_send_polls, .. }) => *can_send_polls,
Self::Owner(_) | Self::Administrator(_) | Self::Member => true,
Self::Left | Self::Banned(_) => false,
}
}
}
#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ChatMemberStatus {
#[serde(rename = "creator")]
Owner,
Administrator,
Member,
Restricted,
Left,
#[serde(rename = "kicked")]
Banned,
}
/// Simple methods for checking a user status.
impl ChatMemberStatus {
/// Returns `true` if the user is the [owner] of the given chat.
///
/// [owner]: ChatMemberKind::Owner
#[must_use]
pub fn is_owner(&self) -> bool {
matches!(self, Self::Owner { .. })
}
/// Returns `true` if the user is an [administrator] of the given chat.
///
/// [administrator]: ChatMemberKind::Administrator
///
/// **Note**: this function **doesn't** return `true` if the user is the
/// owner of the given chat. See also: [`is_privileged`].
///
/// [`is_privileged`]: ChatMemberKind::is_privileged
#[must_use]
pub fn is_administrator(&self) -> bool {
matches!(self, Self::Administrator { .. })
}
/// Returns `true` if the user is a common [member] of the given chat.
///
/// ⚠️ Don't confuse this with [`is_present`]. This method merely checks
/// for [`ChatMemberStatus::Member`] variant which is not enough to
/// determine if the user is joinned to the chat. Use [`is_present`] for
/// that instead.
///
/// [member]: ChatMemberKind::Member
/// [`is_present`]: ChatMemberKind::is_present
#[must_use]
pub fn is_member(&self) -> bool {
matches!(self, Self::Member { .. })
}
/// Returns `true` if the user is [restricted] in the given chat.
///
/// [restricted]: ChatMemberKind::Restricted
#[must_use]
pub fn is_restricted(&self) -> bool {
matches!(self, Self::Restricted { .. })
}
/// Returns `true` if the user [left] the given chat.
///
/// ⚠️ Don't confuse this with [`is_present`]. This method merely checks
/// for [`ChatMemberStatus::Left`] variant which is not enough to determine
/// if the user is joinned to the chat. Use [`is_present`] for that instead.
///
/// [left]: ChatMemberKind::Left
/// [`is_present`]: ChatMemberKind::is_present
#[must_use]
pub fn is_left(&self) -> bool {
matches!(self, Self::Left { .. })
}
/// Returns `true` if the user is [banned] in the given chat.
///
/// [banned]: ChatMemberKind::Banned
#[must_use]
pub fn is_banned(&self) -> bool {
matches!(self, Self::Banned { .. })
}
}
/// Compound methods for checking a user status.
impl ChatMemberStatus {
/// Returns `true` if the user is privileged in the given chat. i.e. if the
/// user is either the [owner] or an [administrator] in the given chat.
///
/// [owner]: ChatMemberKind::Owner
/// [administrator]: ChatMemberKind::Administrator
#[must_use]
pub fn is_privileged(&self) -> bool {
self.is_administrator() || self.is_owner()
}
/// Returns `true` if the user is currently present in the chat. i.e. if the
/// user **hasn't** [left] or been [banned].
///
/// [left]: ChatMemberKind::Left
/// [banned]: ChatMemberKind::Banned
#[must_use]
#[deprecated(
since = "0.9.0",
note = "Use `ChatMemberKind::is_present` method instead. Details: https://github.com/teloxide/teloxide/issues/781"
)]
pub fn is_present(&self) -> bool {
!(self.is_left() || self.is_banned())
}
}
#[cfg(test)]
mod tests {
use crate::types::UserId;
use super::*;
#[test]
fn deserialize() {
let json = r#"{
"user":{
"id":1029940401,
"is_bot":false,
"first_name":"First",
"last_name":"Last",
"username":"fl",
"language_code":"en"
},
"status":"administrator",
"is_anonymous": false,
"can_be_edited": false,
"can_manage_chat": true,
"can_change_info": true,
"can_delete_messages": true,
"can_manage_video_chats": true,
"can_invite_users": true,
"can_restrict_members": true,
"can_pin_messages": true,
"can_promote_members": true
}"#;
let expected = ChatMember {
user: User {
id: UserId(1029940401),
is_bot: false,
first_name: "First".to_string(),
last_name: Some("Last".to_string()),
username: Some("fl".to_string()),
language_code: Some("en".to_string()),
is_premium: false,
added_to_attachment_menu: false,
},
kind: ChatMemberKind::Administrator(Administrator {
custom_title: None,
is_anonymous: false,
can_be_edited: false,
can_manage_chat: true,
can_change_info: true,
can_post_messages: false,
can_edit_messages: false,
can_delete_messages: true,
can_manage_video_chats: true,
can_invite_users: true,
can_restrict_members: true,
can_pin_messages: true,
can_promote_members: true,
can_manage_topics: false,
}),
};
let actual = serde_json::from_str::<ChatMember>(json).unwrap();
assert_eq!(actual, expected)
}
}