mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-17 08:47:22 +00:00
88 lines
3.1 KiB
TypeScript
88 lines
3.1 KiB
TypeScript
import type { Bot } from "../../bot.ts";
|
|
import { Message } from "../../transformers/message.ts";
|
|
import { DiscordMessage } from "../../types/discord.ts";
|
|
import { BigString } from "../../types/shared.ts";
|
|
import { Collection } from "../../util/collection.ts";
|
|
import { hasProperty } from "../../util/utils.ts";
|
|
|
|
/**
|
|
* Gets multiple messages from a channel.
|
|
*
|
|
* @param bot - The bot instance to use to make the request.
|
|
* @param channelId - The ID of the channel from which to get the messages.
|
|
* @param options - The parameters for the fetching of the messages.
|
|
* @returns A collection of {@link Message} objects assorted by message ID.
|
|
*
|
|
* @remarks
|
|
* Requires that the bot user be able to see the contents of the channel in which the messages were posted.
|
|
*
|
|
* If getting a messages from a guild channel:
|
|
* - Requires the `READ_MESSAGE_HISTORY` permission.
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages}
|
|
*/
|
|
export async function getMessages(
|
|
bot: Bot,
|
|
channelId: BigString,
|
|
options?: GetMessagesOptions,
|
|
): Promise<Collection<bigint, Message>> {
|
|
if (options?.limit && (options.limit < 0 || options.limit > 100)) {
|
|
throw new Error(bot.constants.Errors.INVALID_GET_MESSAGES_LIMIT);
|
|
}
|
|
|
|
const results = await bot.rest.runMethod<DiscordMessage[]>(
|
|
bot.rest,
|
|
"GET",
|
|
bot.constants.routes.CHANNEL_MESSAGES(channelId, options),
|
|
);
|
|
|
|
return new Collection(
|
|
results.map((result) => {
|
|
const message = bot.transformers.message(bot, result);
|
|
return [message.id, message];
|
|
}),
|
|
);
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
|
|
export interface GetMessagesLimit {
|
|
/** Max number of messages to return (1-100) default 50 */
|
|
limit?: number;
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
|
|
export interface GetMessagesAround extends GetMessagesLimit {
|
|
/** Get messages around this message id */
|
|
around?: BigString;
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
|
|
export interface GetMessagesBefore extends GetMessagesLimit {
|
|
/** Get messages before this message id */
|
|
before?: BigString;
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
|
|
export interface GetMessagesAfter extends GetMessagesLimit {
|
|
/** Get messages after this message id */
|
|
after?: BigString;
|
|
}
|
|
|
|
export type GetMessagesOptions = GetMessagesAfter | GetMessagesBefore | GetMessagesAround | GetMessagesLimit;
|
|
|
|
export function isGetMessagesAfter(options: GetMessagesOptions): options is GetMessagesAfter {
|
|
return hasProperty(options, "after");
|
|
}
|
|
|
|
export function isGetMessagesBefore(options: GetMessagesOptions): options is GetMessagesBefore {
|
|
return hasProperty(options, "before");
|
|
}
|
|
|
|
export function isGetMessagesAround(options: GetMessagesOptions): options is GetMessagesAround {
|
|
return hasProperty(options, "around");
|
|
}
|
|
|
|
export function isGetMessagesLimit(options: GetMessagesOptions): options is GetMessagesLimit {
|
|
return hasProperty(options, "limit");
|
|
}
|