chorus 0.20.0

A library for interacting with multiple Spacebar-compatible Instances at once.
Documentation 
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use reqwest::Client;

use crate::{
    errors::ChorusResult,
    instance::ChorusUser,
    ratelimiter::ChorusRequest,
    types::{self, LimitType, PublicUser, Snowflake},
};

/// Useful metadata for working with [`types::Reaction`], bundled together nicely.
#[derive(Debug, Clone, PartialEq, Eq, Copy, Hash, PartialOrd, Ord)]
pub struct ReactionMeta {
    pub message_id: types::Snowflake,
    pub channel_id: types::Snowflake,
}

impl ReactionMeta {
    /// Deletes all reactions for a message.
    ///
    /// This endpoint requires the [`MANAGE_MESSAGES`](crate::types::PermissionFlags::MANAGE_MESSAGES) permission.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#delete-all-reactions>
    pub async fn delete_all(&self, user: &mut ChorusUser) -> ChorusResult<()> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id
        );

        let request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_handle_as_result(user).await
    }

    /// Gets a list of users that reacted with a specific emoji to a message.
    ///
    /// The emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji.
    /// To use custom emoji, the format of the emoji string must be name:id.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#get-reactions>
    pub async fn get(&self, emoji: &str, user: &mut ChorusUser) -> ChorusResult<Vec<PublicUser>> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions/{}",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id,
            emoji
        );

        let request = ChorusRequest {
            request: Client::new().get(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_deserialize_response::<Vec<PublicUser>>(user).await
    }

    /// Deletes all the reactions for a given emoji on a message.
    ///
    /// This endpoint requires the [`MANAGE_MESSAGES`](crate::types::PermissionFlags::MANAGE_MESSAGES) permission.
    ///
    /// The emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji.
    /// To use custom emoji, the format of the emoji string must be name:id.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji>
    pub async fn delete_emoji(&self, emoji: &str, user: &mut ChorusUser) -> ChorusResult<()> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions/{}",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id,
            emoji
        );

        let request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_handle_as_result(user).await
    }

    /// Create a reaction on a message.
    ///
    /// This endpoint requires the [`READ_MESSAGE_HISTORY`](crate::types::PermissionFlags::READ_MESSAGE_HISTORY) permission.
    ///
    /// Additionally, if nobody else has reacted to the message using this emoji,
    /// this endpoint requires the [`ADD_REACTIONS`](crate::types::PermissionFlags::ADD_REACTIONS) permission.
    ///
    /// The emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji.
    /// To use custom emoji, the format of the emoji string must be `name:id`.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#create-reaction>
    pub async fn create(&self, emoji: &str, user: &mut ChorusUser) -> ChorusResult<()> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions/{}/@me",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id,
            emoji
        );

        let request = ChorusRequest {
            request: Client::new().put(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_handle_as_result(user).await
    }

    /// Deletes a reaction the current user has made to the message.
    ///
    /// The reaction emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji.
    /// To use custom emoji, the format of the emoji string must be name:id.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#delete-own-reaction>
    pub async fn remove(&self, emoji: &str, user: &mut ChorusUser) -> ChorusResult<()> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions/{}/@me",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id,
            emoji
        );

        let request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_handle_as_result(user).await
    }

    /// Deletes a user's reaction to a message.
    ///
    /// This endpoint requires the [`MANAGE_MESSAGES`](crate::types::PermissionFlags::MANAGE_MESSAGES) permission.
    ///
    /// The reaction emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji.
    /// To use custom emoji, the format of the emoji string must be name:id.
    ///
    /// # Reference
    /// See <https://discord.com/developers/docs/resources/channel#delete-user-reaction>
    pub async fn delete_user(
        &self,
        user_id: Snowflake,
        emoji: &str,
        user: &mut ChorusUser,
    ) -> ChorusResult<()> {
        let url = format!(
            "{}/channels/{}/messages/{}/reactions/{}/{}",
            user.belongs_to.read().unwrap().urls.api,
            self.channel_id,
            self.message_id,
            emoji,
            user_id
        );

        let request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Channel(self.channel_id),
        }
        .with_headers_for(user);

        request.send_and_handle_as_result(user).await
    }
}