mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-08-19 23:04:51 +00:00
* api: add support for the X-Audit-Log-Reason header * api: inline reason parameter, where data struct has a single field
228 lines
6.6 KiB
Go
228 lines
6.6 KiB
Go
package api
|
|
|
|
import (
|
|
"github.com/diamondburned/arikawa/v3/discord"
|
|
"github.com/diamondburned/arikawa/v3/internal/intmath"
|
|
"github.com/diamondburned/arikawa/v3/utils/httputil"
|
|
)
|
|
|
|
const MaxMessageReactionFetchLimit = 100
|
|
|
|
// React creates a reaction for the message.
|
|
//
|
|
// This endpoint requires the READ_MESSAGE_HISTORY permission to be present on
|
|
// the current user. Additionally, if nobody else has reacted to the message
|
|
// using this emoji, this endpoint requires the 'ADD_REACTIONS' permission to
|
|
// be present on the current user.
|
|
func (c *Client) React(
|
|
channelID discord.ChannelID, messageID discord.MessageID, emoji discord.APIEmoji) error {
|
|
|
|
return c.FastRequest(
|
|
"PUT",
|
|
EndpointChannels+channelID.String()+
|
|
"/messages/"+messageID.String()+
|
|
"/reactions/"+emoji.PathString()+"/@me",
|
|
)
|
|
}
|
|
|
|
// Unreact removes a reaction the current user has made for the message.
|
|
func (c *Client) Unreact(
|
|
channelID discord.ChannelID, messageID discord.MessageID, emoji discord.APIEmoji) error {
|
|
|
|
return c.DeleteUserReaction(channelID, messageID, 0, emoji)
|
|
}
|
|
|
|
// Reactions returns a list of users that reacted with the passed Emoji. This
|
|
// method automatically paginates until it reaches the passed limit, or, if the
|
|
// limit is set to 0, has fetched all users within the passed range.
|
|
//
|
|
// As the underlying endpoint has a maximum of 100 users per request, at
|
|
// maximum a total of limit/100 rounded up requests will be made, although they
|
|
// may be less, if no more guilds are available.
|
|
//
|
|
// When fetching the users, those with the smallest ID will be fetched first.
|
|
func (c *Client) Reactions(
|
|
channelID discord.ChannelID,
|
|
messageID discord.MessageID, emoji discord.APIEmoji, limit uint) ([]discord.User, error) {
|
|
|
|
return c.ReactionsAfter(channelID, messageID, 0, emoji, limit)
|
|
}
|
|
|
|
// ReactionsBefore returns a list of users that reacted with the passed Emoji.
|
|
// This method automatically paginates until it reaches the passed limit, or,
|
|
// if the limit is set to 0, has fetched all users with an id smaller than
|
|
// before.
|
|
//
|
|
// As the underlying endpoint has a maximum of 100 users per request, at
|
|
// maximum a total of limit/100 rounded up requests will be made, although they
|
|
// may be less, if no more guilds are available.
|
|
func (c *Client) ReactionsBefore(
|
|
channelID discord.ChannelID, messageID discord.MessageID,
|
|
before discord.UserID, emoji discord.APIEmoji, limit uint) ([]discord.User, error) {
|
|
|
|
users := make([]discord.User, 0, limit)
|
|
|
|
fetch := uint(MaxMessageReactionFetchLimit)
|
|
|
|
unlimited := limit == 0
|
|
|
|
for limit > 0 || unlimited {
|
|
if limit > 0 {
|
|
// Only fetch as much as we need. Since limit gradually decreases,
|
|
// we only need to fetch intmath.Min(fetch, limit).
|
|
fetch = uint(intmath.Min(MaxMessageReactionFetchLimit, int(limit)))
|
|
limit -= fetch
|
|
}
|
|
|
|
r, err := c.reactionsRange(channelID, messageID, before, 0, emoji, fetch)
|
|
if err != nil {
|
|
return users, err
|
|
}
|
|
users = append(r, users...)
|
|
|
|
if len(r) < MaxMessageReactionFetchLimit {
|
|
break
|
|
}
|
|
|
|
before = r[0].ID
|
|
}
|
|
|
|
if len(users) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
return users, nil
|
|
}
|
|
|
|
// ReactionsAfter returns a list of users that reacted with the passed Emoji.
|
|
// This method automatically paginates until it reaches the passed limit, or,
|
|
// if the limit is set to 0, has fetched all users with an id higher than
|
|
// after.
|
|
//
|
|
// As the underlying endpoint has a maximum of 100 users per request, at
|
|
// maximum a total of limit/100 rounded up requests will be made, although they
|
|
// may be less, if no more guilds are available.
|
|
func (c *Client) ReactionsAfter(
|
|
channelID discord.ChannelID, messageID discord.MessageID,
|
|
after discord.UserID, emoji discord.APIEmoji, limit uint) ([]discord.User, error) {
|
|
|
|
users := make([]discord.User, 0, limit)
|
|
|
|
fetch := uint(MaxMessageReactionFetchLimit)
|
|
|
|
unlimited := limit == 0
|
|
|
|
for limit > 0 || unlimited {
|
|
if limit > 0 {
|
|
// Only fetch as much as we need. Since limit gradually decreases,
|
|
// we only need to fetch intmath.Min(fetch, limit).
|
|
fetch = uint(intmath.Min(MaxMessageReactionFetchLimit, int(limit)))
|
|
limit -= fetch
|
|
}
|
|
|
|
r, err := c.reactionsRange(channelID, messageID, 0, after, emoji, fetch)
|
|
if err != nil {
|
|
return users, err
|
|
}
|
|
users = append(users, r...)
|
|
|
|
if len(r) < MaxMessageReactionFetchLimit {
|
|
break
|
|
}
|
|
|
|
after = r[len(r)-1].ID
|
|
}
|
|
|
|
if len(users) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
return users, nil
|
|
}
|
|
|
|
// reactionsRange get users before and after IDs. Before, after, and limit are
|
|
// optional. A maximum limit of only 100 reactions could be returned.
|
|
func (c *Client) reactionsRange(
|
|
channelID discord.ChannelID, messageID discord.MessageID,
|
|
before, after discord.UserID, emoji discord.APIEmoji, limit uint) ([]discord.User, error) {
|
|
|
|
switch {
|
|
case limit == 0:
|
|
limit = 25
|
|
case limit > 100:
|
|
limit = 100
|
|
}
|
|
|
|
var param struct {
|
|
Before discord.UserID `schema:"before,omitempty"`
|
|
After discord.UserID `schema:"after,omitempty"`
|
|
|
|
Limit uint `schema:"limit"`
|
|
}
|
|
|
|
param.Before = before
|
|
param.After = after
|
|
param.Limit = limit
|
|
|
|
var users []discord.User
|
|
return users, c.RequestJSON(
|
|
&users, "GET", EndpointChannels+channelID.String()+
|
|
"/messages/"+messageID.String()+
|
|
"/reactions/"+emoji.PathString(),
|
|
httputil.WithSchema(c, param),
|
|
)
|
|
}
|
|
|
|
// DeleteUserReaction deletes another user's reaction.
|
|
//
|
|
// This endpoint requires the MANAGE_MESSAGES permission to be present on the
|
|
// current user.
|
|
func (c *Client) DeleteUserReaction(
|
|
channelID discord.ChannelID,
|
|
messageID discord.MessageID, userID discord.UserID, emoji discord.APIEmoji) error {
|
|
|
|
var user = "@me"
|
|
if userID > 0 {
|
|
user = userID.String()
|
|
}
|
|
|
|
return c.FastRequest(
|
|
"DELETE",
|
|
EndpointChannels+channelID.String()+
|
|
"/messages/"+messageID.String()+
|
|
"/reactions/"+emoji.PathString()+"/"+user,
|
|
)
|
|
}
|
|
|
|
// DeleteReactions 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.
|
|
func (c *Client) DeleteReactions(
|
|
channelID discord.ChannelID, messageID discord.MessageID, emoji discord.APIEmoji) error {
|
|
|
|
return c.FastRequest(
|
|
"DELETE",
|
|
EndpointChannels+channelID.String()+
|
|
"/messages/"+messageID.String()+
|
|
"/reactions/"+emoji.PathString(),
|
|
)
|
|
}
|
|
|
|
// DeleteAllReactions deletes all reactions on a message.
|
|
//
|
|
// This endpoint requires the MANAGE_MESSAGES permission to be present on the
|
|
// current user.
|
|
//
|
|
// Fires a Message Reaction Remove All Gateway event.
|
|
func (c *Client) DeleteAllReactions(
|
|
channelID discord.ChannelID, messageID discord.MessageID) error {
|
|
|
|
return c.FastRequest(
|
|
"DELETE",
|
|
EndpointChannels+channelID.String()+"/messages/"+messageID.String()+"/reactions",
|
|
)
|
|
}
|