Add delete_emoji method with documentation

This commit is contained in:
bitfl0wer 2023-06-03 20:17:21 +02:00
parent 02db71055c
commit 5b579c551a
No known key found for this signature in database
GPG Key ID: 84BBB60DF895ABF2
1 changed files with 46 additions and 5 deletions

View File

@ -15,10 +15,10 @@ impl ReactionMeta {
/**
Deletes all reactions for a message.
# Arguments
* `user` - A mutable reference to a `UserMeta` instance.
* `user` - A mutable reference to a [`UserMeta`] instance.
# Returns
A `Result` containing a `reqwest::Response` or a `crate::errors::InstanceServerError`.
A `Result` containing a [`reqwest::Response`] or a [`crate::errors::InstanceServerError`].
*/
pub async fn delete_all(
&self,
@ -47,11 +47,13 @@ impl ReactionMeta {
Gets a list of users that reacted with a specific emoji to a message.
# Arguments
* `emoji` - A string slice containing the emoji to search for.
* `user` - A mutable reference to a `UserMeta` instance.
* `emoji` - A string slice containing the emoji to search for. The emoji must be URL Encoded or
the request will fail with 10014: Unknown Emoji. To use custom emoji, you must encode it in the
format name:id with the emoji name and emoji id.
* `user` - A mutable reference to a [`UserMeta`] instance.
# Returns
A `Result` containing a `reqwest::Response` or a `crate::errors::InstanceServerError`.
A `Result` containing a [`reqwest::Response`] or a [`crate::errors::InstanceServerError`].
*/
pub async fn get(
&self,
@ -77,4 +79,43 @@ impl ReactionMeta {
)
.await
}
/**
Deletes all the reactions for a given `emoji` on a message. This endpoint requires the
MANAGE_MESSAGES permission to be present on the current user. Fires a `Message Reaction
Remove Emoji` Gateway event.
# Arguments
* `emoji` - A string slice containing the emoji to delete. The `emoji` must be URL Encoded or
the request will fail with 10014: Unknown Emoji. To use custom emoji, you must encode it in the
format name:id with the emoji name and emoji id.
* `user` - A mutable reference to a [`UserMeta`] instance.
# Returns
A `Result` containing a [`reqwest::Response`] or a [`crate::errors::InstanceServerError`].
*/
pub async fn delete_emoji(
&self,
emoji: &str,
user: &mut UserMeta,
) -> Result<reqwest::Response, crate::errors::InstanceServerError> {
let mut belongs_to = user.belongs_to.borrow_mut();
let url = format!(
"{}/channels/{}/messages/{}/reactions/{}/",
belongs_to.urls.get_api(),
self.channel_id,
self.message_id,
emoji
);
let request = Client::new().delete(url).bearer_auth(user.token());
LimitedRequester::new()
.await
.send_request(
request,
crate::api::limits::LimitType::Channel,
&mut belongs_to.limits,
&mut user.limits,
)
.await
}
}