package requests
- Source
- package.scala
- Alphabetic
- By Inheritance
- requests
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class AddGuildMember(guildId: GuildId, userId: UserId, params: AddGuildMemberData) extends GuildMemberRequest[AddGuildMemberData] with Product with Serializable
Adds a user to a guild.
Adds a user to a guild. Requires the
guilds.join
OAuth2 scope. - case class AddGuildMemberData(accessToken: String, nick: Option[String] = None, roles: Option[Seq[RoleId]] = None, mute: Option[Boolean] = None, deaf: Option[Boolean] = None) extends Product with Serializable
- accessToken
The OAuth2 access token.
- nick
The nickname to give to the user.
- roles
The roles to give to the user. If the guild has membership screening enabled, this setting this will bypass that.
- mute
If the user should be muted.
- deaf
If the user should be deafened.
- case class AddGuildMemberRole(guildId: GuildId, userId: UserId, roleId: RoleId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[AddGuildMemberRole] with Product with Serializable
Add a role to a guild member.
- case class AddThreadMember(channelId: ThreadGuildChannelId, userId: UserId) extends NoParamsResponseRequest with Product with Serializable
Adds the specified user to a thread.
- trait BaseRESTRequest[RawResponse, NiceResponse] extends Request[RawResponse]
Base trait for all REST requests in AckCord.
Base trait for all REST requests in AckCord. If you feel an endpoint is missing, and AckCord hasn't added it yet, you can extend this and create your own request. I'd recommend you to extend RESTRequest tough for simplicity.
- RawResponse
The response type of the request
- NiceResponse
A nicer and less raw type of response created from the response.
- case class BeginGuildPrune(guildId: GuildId, params: BeginGuildPruneData, reason: Option[String] = None) extends NoNiceResponseRequest[BeginGuildPruneData, BeginGuildPruneResponse] with NoNiceResponseReasonRequest[BeginGuildPrune, BeginGuildPruneData, BeginGuildPruneResponse] with Product with Serializable
Begin a guild prune.
- case class BeginGuildPruneData(days: Int, computePruneCount: Option[Boolean], includeRoles: Seq[RoleId], reason: Option[String] = None) extends Product with Serializable
- days
The amount of days to prune for.
- computePruneCount
If the pruned return field should be present.
- includeRoles
Roles that should be ignored when checking for inactive users.
- case class BeginGuildPruneResponse(pruned: Option[Int]) extends Product with Serializable
- pruned
The number of members that were removed.
- case class BulkDeleteMessages(channelId: TextChannelId, params: BulkDeleteMessagesData, reason: Option[String] = None) extends NoResponseReasonRequest[BulkDeleteMessages, BulkDeleteMessagesData] with Product with Serializable
Delete multiple messages in a single request.
Delete multiple messages in a single request. Can only be used on guild channels.
- case class BulkDeleteMessagesData(messages: Seq[MessageId]) extends Product with Serializable
- messages
All the messages to delete.
- case class CreateChannelInvite(channelId: GuildChannelId, params: CreateChannelInviteData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[CreateChannelInvite, CreateChannelInviteData, Invite] with Product with Serializable
Create a new invite for a channel.
Create a new invite for a channel. Can only be used on guild channels.
- case class CreateChannelInviteData(maxAge: util.JsonOption[Int] = JsonUndefined, maxUses: util.JsonOption[Int] = JsonUndefined, temporary: util.JsonOption[Boolean] = JsonUndefined, unique: util.JsonOption[Boolean] = JsonUndefined, targetUserId: util.JsonOption[UserId] = JsonUndefined, targetType: util.JsonOption[InviteTargetType] = JsonUndefined, targetApplicationId: util.JsonOption[ApplicationId] = JsonUndefined) extends Product with Serializable
- maxAge
Duration in seconds before this invite expires.
- maxUses
Amount of times this invite can be used before expiring, or 0 for unlimited.
- temporary
If this invite only grants temporary membership.
- unique
If true, guarantees to create a new invite.
- targetUserId
The target user for this invite, who's stream will be displayed.
- targetType
The type of target for this voice channel invite
- case class CreateDMData(recipientId: UserId) extends Product with Serializable
- recipientId
User to send a DM to.
- case class CreateDm(params: CreateDMData) extends RESTRequest[CreateDMData, RawChannel, Option[DMChannel]] with Product with Serializable
Create a new DM channel.
- case class CreateFollowupMessage(id: SnowflakeType[Webhook], token: String, params: ExecuteWebhookData) extends RESTRequest[ExecuteWebhookData, Option[RawMessage], Option[Message]] with Product with Serializable
- case class CreateGroupDMData(accessTokens: Seq[String], nicks: SnowflakeMap[User, String]) extends Product with Serializable
- accessTokens
The access tokens of users that have granted the bot the
gdm.join
scope.- nicks
A map specifying the nicknames for the users in this group DM.
- case class CreateGuild(params: CreateGuildData) extends RESTRequest[CreateGuildData, RawGuild, RequestsGuild] with Product with Serializable
Create a new guild.
Create a new guild. Can only be used by bots in less than 10 guilds.
- case class CreateGuildBan(guildId: GuildId, userId: UserId, params: CreateGuildBanData, reason: Option[String] = None) extends NoResponseReasonRequest[CreateGuildBan, CreateGuildBanData] with Product with Serializable
Ban a user from a guild.
- case class CreateGuildBanData(deleteMessageDays: Option[Int]) extends Product with Serializable
- deleteMessageDays
The number of days to delete messages for this banned user.
- case class CreateGuildChannel(guildId: GuildId, params: CreateGuildChannelData, reason: Option[String] = None) extends ReasonRequest[CreateGuildChannel, CreateGuildChannelData, RawChannel, Option[GuildChannel]] with Product with Serializable
Create a channel in a guild.
- case class CreateGuildChannelData(name: String, type: util.JsonOption[ChannelType] = JsonUndefined, topic: util.JsonOption[String] = JsonUndefined, bitrate: util.JsonOption[Int] = JsonUndefined, userLimit: util.JsonOption[Int] = JsonUndefined, rateLimitPerUser: util.JsonOption[Int] = JsonUndefined, permissionOverwrites: util.JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, parentId: util.JsonOption[SnowflakeType[GuildCategory]] = JsonUndefined, nsfw: util.JsonOption[Boolean] = JsonUndefined) extends Product with Serializable
- name
The name of the channel.
- topic
The topic to give this channel.
- bitrate
The bitrate for the channel if it's a voice channel.
- userLimit
The user limit for the channel if it's a voice channel.
- rateLimitPerUser
The user ratelimit to give this channel.
- permissionOverwrites
The permission overwrites for the channel.
- parentId
The category id for the channel.
- nsfw
If the channel is NSFW.
- case class CreateGuildData(name: String, icon: Option[ImageData], verificationLevel: Option[VerificationLevel], defaultMessageNotifications: Option[NotificationLevel], explicitContentFilter: Option[FilterLevel], roles: Option[Seq[Role]], channels: Option[Seq[CreateGuildChannelData]], afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Option[Int], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: Option[SystemChannelFlags]) extends Product with Serializable
- name
The name of the guild
- icon
The icon to use for the guild. Must be 1024x1024 png/jpeg.
- verificationLevel
The verification level to use for the guild.
- defaultMessageNotifications
The notification level to use for the guild.
- roles
The roles for the new guild. Note, here the snowflake is just a placeholder.
- channels
The channels for the new guild.
- afkChannelId
The id for the AFK channel
- afkTimeout
The timeout in seconds until users are moved to the AFK channel.
- systemChannelId
The id of the system channel.
- systemChannelFlags
The flags for the system channel.
- case class CreateGuildEmoji(guildId: GuildId, params: CreateGuildEmojiData, reason: Option[String] = None) extends ReasonRequest[CreateGuildEmoji, CreateGuildEmojiData, RawEmoji, Emoji] with Product with Serializable
Create a new emoji for a guild.
- case class CreateGuildEmojiData(name: String, image: ImageData, roles: Seq[RoleId]) extends Product with Serializable
- name
The name of the emoji.
- image
The image data for the emoji.
- roles
Whitelist of roles that can use this emoji.
- case class CreateGuildFromTemplate(code: String, params: CreateGuildFromTemplateData) extends NoNiceResponseRequest[CreateGuildFromTemplateData, RawGuild] with Product with Serializable
Create a guild from a guild template.
- case class CreateGuildFromTemplateData(name: String, icon: Option[ImageData]) extends Product with Serializable
- case class CreateGuildRole(guildId: GuildId, params: CreateGuildRoleData, reason: Option[String] = None) extends ReasonRequest[CreateGuildRole, CreateGuildRoleData, RawRole, Role] with Product with Serializable
Create a new role in a guild.
- case class CreateGuildRoleData(name: Option[String] = None, permissions: Option[Permission] = None, color: Option[Int] = None, hoist: Option[Boolean] = None, icon: Option[ImageData] = None, unicodeEmoji: Option[String] = None, mentionable: Option[Boolean] = None) extends Product with Serializable
- name
The name of the role.
- permissions
The permissions this role has.
- color
The color of the role.
- hoist
If this role is shown in the right sidebar.
- icon
The role's icon image.
- unicodeEmoji
The role's unicode emoji.
- mentionable
If this role is mentionable.
- case class CreateGuildScheduledEvent(guildId: GuildId, params: CreateGuildScheduledEventData) extends NoNiceResponseRequest[CreateGuildScheduledEventData, GuildScheduledEvent] with Product with Serializable
Create a new guild scheduled event.
- case class CreateGuildScheduledEventData(channelId: Option[VoiceGuildChannelId], entityMetadata: Option[GuildScheduledEventEntityMetadata], name: String, privacyLevel: GuildScheduledEventPrivacyLevel, scheduledStartTime: OffsetDateTime, scheduledEndTime: Option[OffsetDateTime], description: Option[String], entityType: Option[GuildScheduledEventEntityType]) extends Product with Serializable
- case class CreateGuildSticker(guildId: GuildId, sticker: CreateGuildStickerData, reason: Option[String] = None) extends NoParamsReasonRequest[CreateGuildSticker, RawSticker, Sticker] with Product with Serializable
- case class CreateGuildStickerData(name: String, description: String, tags: String, file: CreateMessageFile) extends Product with Serializable
- case class CreateGuildTemplate(guildId: GuildId, params: CreateGuildTemplateData) extends NoNiceResponseRequest[CreateGuildTemplateData, GuildTemplate] with Product with Serializable
Create a guild template for the guild.
- case class CreateGuildTemplateData(name: String, description: util.JsonOption[String] = JsonUndefined) extends Product with Serializable
- name
Name of the template
- description
Description of the template
- case class CreateMessage(channelId: TextChannelId, params: CreateMessageData) extends RESTRequest[CreateMessageData, RawMessage, Message] with Product with Serializable
Create a message in a channel.
- case class CreateMessageData(content: String = "", nonce: Option[Either[String, RawSnowflake]] = None, tts: Boolean = false, files: Seq[CreateMessageFile] = Seq.empty, embeds: Seq[OutgoingEmbed] = Seq.empty, allowedMentions: AllowedMention = AllowedMention.all, replyTo: Option[MessageId] = None, replyFailIfNotExist: Boolean = true, components: Seq[ActionRow] = Nil, stickerIds: Seq[StickerId] = Nil) extends Product with Serializable
- content
The content of the message.
- nonce
A nonce used for optimistic message sending (up to 25 characters).
- tts
If this is a text-to-speech message.
- files
The files to send with this message. You can reference these files in the embed using
attachment://filename
.- embeds
Embeds to send with this message.
- replyTo
The message to reply to
- replyFailIfNotExist
Fail the reply if the message to reply to does not exist.
- sealed trait CreateMessageFile extends AnyRef
- case class CreateReaction(channelId: TextChannelId, messageId: MessageId, emoji: String) extends NoParamsResponseRequest with Product with Serializable
Create a reaction for a message.
Create a reaction for a message.
- emoji
The emoji to send.
- case class CreateStageInstance(params: CreateStageInstanceData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[CreateStageInstance, CreateStageInstanceData, StageInstance] with Product with Serializable
- case class CreateStageInstanceData(channelId: StageGuildChannelId, topic: String, privacyLevel: StageInstancePrivacyLevel = StageInstancePrivacyLevel.GuildOnly) extends Product with Serializable
- case class CreateWebhook(channelId: TextChannelId, params: CreateWebhookData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[CreateWebhook, CreateWebhookData, Webhook] with Product with Serializable
Create a new webhook in a channel.
- case class CreateWebhookData(name: String, avatar: Option[ImageData]) extends Product with Serializable
- name
Name of the webhook
- avatar
The avatar data of the webhook
- case class CrosspostMessage(channelId: ChannelId, messageId: MessageId) extends NoParamsRequest[RawMessage, Message] with Product with Serializable
- case class DeleteAllReactions(channelId: TextChannelId, messageId: MessageId) extends NoParamsResponseRequest with Product with Serializable
Clear all reactions from a message.
- case class DeleteAllReactionsForEmoji(channelId: TextChannelId, messageId: MessageId, emoji: String) extends NoParamsResponseRequest with Product with Serializable
Clear all reactions for a single emoji from a message.
- case class DeleteChannelPermission(channelId: GuildChannelId, overwriteId: UserOrRoleId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteChannelPermission] with Product with Serializable
Delete a permission overwrite for a channel.
- case class DeleteCloseChannel(channelId: ChannelId, reason: Option[String] = None) extends NoParamsReasonRequest[DeleteCloseChannel, RawChannel, Option[Channel]] with Product with Serializable
Delete a guild channel, or close a DM channel.
- case class DeleteGuild(guildId: GuildId) extends NoParamsResponseRequest with Product with Serializable
Delete a guild.
Delete a guild. Must be the owner.
- case class DeleteGuildEmoji(emojiId: EmojiId, guildId: GuildId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildEmoji] with Product with Serializable
Delete an emoji from a guild.
- case class DeleteGuildIntegration(guildId: GuildId, integrationId: IntegrationId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildIntegration] with Product with Serializable
Delete an integration.
- case class DeleteGuildRole(guildId: GuildId, roleId: RoleId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildRole] with Product with Serializable
Delete a role in a guild.
- case class DeleteGuildScheduledEvent(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent]) extends NoParamsResponseRequest with Product with Serializable
Delete a specific guild scheduled event.
- case class DeleteGuildSticker(guildId: GuildId, stickerId: StickerId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildSticker] with Product with Serializable
- case class DeleteGuildTemplate(guildId: GuildId, code: String) extends NoParamsNiceResponseRequest[GuildTemplate] with Product with Serializable
Deletes the given guild template.
- case class DeleteInvite(inviteCode: String, reason: Option[String] = None) extends NoParamsNiceResponseReasonRequest[DeleteInvite, Invite] with Product with Serializable
Delete an invite.
- case class DeleteMessage(channelId: TextChannelId, messageId: MessageId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteMessage] with Product with Serializable
Delete a message
- case class DeleteOriginalWebhookMessage(id: SnowflakeType[Webhook], token: String) extends NoParamsResponseRequest with Product with Serializable
- case class DeleteOwnReaction(channelId: TextChannelId, messageId: MessageId, emoji: String) extends NoParamsResponseRequest with Product with Serializable
Delete the clients reaction to a message.
- case class DeleteStageInstance(channelId: StageGuildChannelId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteStageInstance] with Product with Serializable
- case class DeleteUserReaction(channelId: TextChannelId, messageId: MessageId, emoji: String, userId: UserId) extends NoParamsResponseRequest with Product with Serializable
Delete the reaction of another user to a message.
- case class DeleteWebhook(id: SnowflakeType[Webhook], reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteWebhook] with Product with Serializable
Delete a webhook.
- case class DeleteWebhookMessage(id: SnowflakeType[Webhook], token: String, messageId: MessageId, threadId: Option[ThreadGuildChannelId] = None) extends NoParamsResponseRequest with Product with Serializable
- case class DeleteWebhookWithToken(id: SnowflakeType[Webhook], token: String, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteWebhookWithToken] with Product with Serializable
Delete a webhook with a token.
Delete a webhook with a token. Doesn't require authentication
- case class DroppedRequestException(uri: Uri) extends Exception with Product with Serializable
An exception that signals that a request was dropped.
An exception that signals that a request was dropped.
- uri
The Uri for the request.
- case class EditChannelPermissions(channelId: GuildChannelId, overwriteId: UserOrRoleId, params: EditChannelPermissionsData, reason: Option[String] = None) extends NoResponseReasonRequest[EditChannelPermissions, EditChannelPermissionsData] with Product with Serializable
Edit a permission overwrite for a channel.
- case class EditChannelPermissionsData(allow: Permission, deny: Permission, type: PermissionOverwriteType) extends Product with Serializable
- allow
The permissions to allow.
- deny
The permissions to deny.
- case class EditMessage(channelId: TextChannelId, messageId: MessageId, params: EditMessageData) extends RESTRequest[EditMessageData, RawMessage, Message] with Product with Serializable
Edit an existing message
- case class EditMessageData(content: util.JsonOption[String] = JsonUndefined, files: Seq[CreateMessageFile] = Seq.empty, allowedMentions: util.JsonOption[AllowedMention] = JsonUndefined, embeds: util.JsonOption[Seq[OutgoingEmbed]] = JsonUndefined, flags: util.JsonOption[MessageFlags] = JsonUndefined, components: util.JsonOption[Seq[ActionRow]] = JsonUndefined, attachments: util.JsonOption[Seq[PartialAttachment]] = JsonUndefined) extends Product with Serializable
- content
The content of the new message
- attachments
The attachments to keep in the new message.
- case class EditOriginalWebhookMessage(id: SnowflakeType[Webhook], token: String, params: EditWebhookMessageData) extends NoNiceResponseRequest[EditWebhookMessageData, Json] with Product with Serializable
- case class EditWebhookMessage(id: SnowflakeType[Webhook], token: String, messageId: MessageId, params: EditWebhookMessageData, threadId: Option[ThreadGuildChannelId] = None) extends NoNiceResponseRequest[EditWebhookMessageData, Json] with Product with Serializable
- case class EditWebhookMessageData(content: util.JsonOption[String] = JsonUndefined, embeds: util.JsonOption[Seq[OutgoingEmbed]] = JsonUndefined, files: util.JsonOption[Seq[CreateMessageFile]] = JsonUndefined, allowedMentions: util.JsonOption[AllowedMention] = JsonUndefined, components: util.JsonOption[Seq[ActionRow]] = JsonUndefined, attachments: util.JsonOption[Seq[PartialAttachment]] = JsonUndefined) extends Product with Serializable
- content
The new content of the message.
- embeds
The new embeds of the message.
- files
The new files of the message.
- allowedMentions
The new allowed mentions of the message.
- attachments
The attachments to keep in the new message.
- case class ExecuteWebhook(id: SnowflakeType[Webhook], token: String, waitQuery: Boolean = false, threadId: Option[ThreadGuildChannelId], params: ExecuteWebhookData) extends RESTRequest[ExecuteWebhookData, Option[RawMessage], Option[Message]] with Product with Serializable
- case class ExecuteWebhookData(content: String = "", username: Option[String] = None, avatarUrl: Option[String] = None, tts: Option[Boolean] = None, files: Seq[CreateMessageFile] = Seq.empty, embeds: Seq[OutgoingEmbed] = Nil, allowedMentions: Option[AllowedMention] = None, components: Option[Seq[ActionRow]] = None, attachments: Option[Seq[PartialAttachment]] = None, flags: Option[MessageFlags] = None) extends Product with Serializable
- content
The content of the message.
- username
The username to use with the message.
- avatarUrl
The avatar url to use with the message.
- tts
If this is a text-to-speech message.
- files
The files to send with this message. You can reference these files in the embed using
attachment://filename
.- embeds
Embeds to send with this message.
- sealed trait FailedRequest extends RequestAnswer[Nothing]
A failed request.
- trait FlattenUnflatten[In, Out] extends AnyRef
- case class FollowNewsChannel(channelId: ChannelId, params: FollowNewsChannelData) extends RESTRequest[FollowNewsChannelData, FollowedChannel, FollowedChannel] with Product with Serializable
- channelId
Where to send messages to
- case class FollowNewsChannelData(webhookChannelId: ChannelId) extends Product with Serializable
- case class FollowedChannel(channelId: ChannelId, webhookId: SnowflakeType[Webhook]) extends Product with Serializable
- channelId
Source channel id
- webhookId
Id of the created webhook
- case class GetAchievementIconImage(desiredSize: Int, format: ImageFormat, applicationId: ApplicationId, achievementId: String, iconHash: String) extends ImageRequest with Product with Serializable
Get the achievement icon of an application.
Get the achievement icon of an application. Allowed formats are PNG, JPEG and WebP.
- case class GetApplicationAssetImage(desiredSize: Int, format: ImageFormat, applicationId: ApplicationId, assetId: String) extends ImageRequest with Product with Serializable
Get the asset of an application.
Get the asset of an application. Allowed formats are PNG, JPEG and WebP.
- case class GetApplicationCoverImage(desiredSize: Int, format: ImageFormat, applicationId: ApplicationId) extends ImageRequest with Product with Serializable
Get the cover image of an application.
Get the cover image of an application. Allowed formats are PNG, JPEG and WebP.
- case class GetApplicationIconImage(desiredSize: Int, format: ImageFormat, applicationId: ApplicationId) extends ImageRequest with Product with Serializable
Get the icon of an application.
Get the icon of an application. Allowed formats are PNG, JPEG and WebP.
- case class GetChannel(channelId: ChannelId) extends NoParamsRequest[RawChannel, Option[Channel]] with Product with Serializable
Get a channel by id.
- case class GetChannelInvites(channelId: GuildChannelId) extends NoParamsNiceResponseRequest[Seq[InviteWithMetadata]] with Product with Serializable
Get all invites for this channel.
Get all invites for this channel. Can only be used on guild channels.
- case class GetChannelMessage(channelId: TextChannelId, messageId: MessageId) extends NoParamsRequest[RawMessage, Message] with Product with Serializable
Get a specific message in a channel.
- case class GetChannelMessages(channelId: TextChannelId, query: GetChannelMessagesData) extends NoParamsRequest[Seq[RawMessage], Seq[Message]] with Product with Serializable
Get the messages in a channel.
- case class GetChannelMessagesData(around: Option[MessageId] = None, before: Option[MessageId] = None, after: Option[MessageId] = None, limit: Option[Int] = None) extends Product with Serializable
- around
Get messages around this message id.
- before
Get messages before this message id.
- after
Get messages after this message id.
- limit
The max amount of messages to return. The default is 50.
- case class GetChannelWebhooks(channelId: TextChannelId) extends NoParamsNiceResponseRequest[Seq[Webhook]] with Product with Serializable
Get the webhooks in a channel.
- case class GetCurrentUserGuilds(queryParams: GetCurrentUserGuildsData) extends NoParamsNiceResponseRequest[Seq[GetUserGuildsGuild]] with Product with Serializable
Get the guilds the client user is in.
- case class GetCurrentUserGuildsData(before: Option[GuildId] = None, after: Option[GuildId] = None, limit: Option[Int] = None) extends Product with Serializable
- before
Get guilds before this id.
- after
Get guilds after this id.
- limit
The max amount of guilds to return.
- case class GetCustomEmojiImage(desiredSize: Int, format: ImageFormat, emojiId: EmojiId) extends ImageRequest with Product with Serializable
Get the image of a custom emoji.
Get the image of a custom emoji. Always returns a PNG.
- case class GetDefaultUserAvatarImage(desiredSize: Int, discriminator: Int) extends ImageRequest with Product with Serializable
Get the default avatar of a user.
Get the default avatar of a user. Always returns a PNG.
- case class GetDiscoverySplashImage(desiredSize: Int, format: ImageFormat, guildId: GuildId, splashHash: String) extends ImageRequest with Product with Serializable
- case class GetGuild(guildId: GuildId, withCounts: Boolean = false) extends NoParamsRequest[RawGuild, RequestsGuild] with Product with Serializable
Get a guild by id.
- case class GetGuildAuditLog(guildId: GuildId, queryParams: GetGuildAuditLogData) extends NoParamsNiceResponseRequest[AuditLog] with Product with Serializable
Get an audit log for a given guild.
- case class GetGuildAuditLogData(userId: Option[UserId] = None, actionType: Option[AuditLogEvent] = None, before: Option[RawSnowflake] = None, limit: Option[Int] = None) extends Product with Serializable
- case class GetGuildBan(guildId: GuildId, userId: UserId) extends NoParamsRequest[RawBan, Ban] with Product with Serializable
Get the ban object for a specific member in a guild.
- case class GetGuildBannerImage(desiredSize: Int, format: ImageFormat, guildId: GuildId, bannerHash: String) extends ImageRequest with Product with Serializable
- case class GetGuildBans(guildId: GuildId) extends NoParamsRequest[Seq[RawBan], Seq[Ban]] with Product with Serializable
Get all the bans for this guild.
- case class GetGuildChannels(guildId: GuildId) extends NoParamsRequest[Seq[RawChannel], Seq[Option[GuildChannel]]] with Product with Serializable
Get all the channels for a guild.
- case class GetGuildEmoji(emojiId: EmojiId, guildId: GuildId) extends NoParamsRequest[RawEmoji, Emoji] with Product with Serializable
Get an emoji in a guild by id.
- case class GetGuildIconImage(desiredSize: Int, format: ImageFormat, guildId: GuildId, iconHash: String) extends ImageRequest with Product with Serializable
Get a guild icon image.
Get a guild icon image. Allowed formats are PNG, JPEG and WebP.
- case class GetGuildIntegrations(guildId: GuildId) extends NoParamsNiceResponseRequest[Seq[Integration]] with Product with Serializable
Get the integrations for this guild.
- case class GetGuildInvites(guildId: GuildId) extends NoParamsNiceResponseRequest[Seq[InviteWithMetadata]] with Product with Serializable
Get the invites for this guild.
- case class GetGuildMember(guildId: GuildId, userId: UserId) extends GuildMemberRequest[NotUsed] with Product with Serializable
Get a guild member by id.
- case class GetGuildPreview(guildId: GuildId) extends NoParamsNiceResponseRequest[GuildPreview] with Product with Serializable
Get a guild preview by it's id.
Get a guild preview by it's id. Only usable for public guilds.
- case class GetGuildPruneCount(guildId: GuildId, queryParams: GuildPruneCountData) extends NoParamsNiceResponseRequest[GuildPruneCountResponse] with Product with Serializable
Check how many members would be removed if a prune was started now.
- case class GetGuildRoles(guildId: GuildId) extends RESTRequest[NotUsed, Seq[RawRole], Seq[Role]] with Product with Serializable
Get all the roles in a guild.
- case class GetGuildScheduledEvent(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent]) extends NoParamsNiceResponseRequest[GuildScheduledEvent] with Product with Serializable
Get a specific guild scheduled event.
- case class GetGuildScheduledEventUsers(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent], limit: Option[Int] = None, withMember: Option[Boolean] = None, before: Option[UserId] = None, after: Option[UserId] = None) extends NoParamsNiceResponseRequest[Seq[GuildScheduledEventUser]] with Product with Serializable
Get the users that have subscribed to a guild scheduled event.
Get the users that have subscribed to a guild scheduled event.
- limit
How many users to receive.
- withMember
If the members should be included if they exist.
- before
Only return users before the given user id.
- after
Only return users after the given user id.
- case class GetGuildSplashImage(desiredSize: Int, format: ImageFormat, guildId: GuildId, splashHash: String) extends ImageRequest with Product with Serializable
Get a guild splash image.
Get a guild splash image. Allowed formats are PNG, JPEG and WebP.
- case class GetGuildSticker(guildId: GuildId, stickerId: StickerId) extends NoParamsRequest[RawSticker, Sticker] with Product with Serializable
- case class GetGuildTemplate(code: String) extends NoParamsRequest[GuildTemplate, GuildTemplate] with Product with Serializable
Get a template by it's code.
- case class GetGuildTemplates(guildId: GuildId) extends NoParamsNiceResponseRequest[Seq[GuildTemplate]] with Product with Serializable
Gets the guild templates for a guild.
- case class GetGuildVanityUrl(guildId: GuildId) extends NoParamsNiceResponseRequest[VanityUrlResponse] with Product with Serializable
Get a partial invite object for guilds with that feature enabled.
- case class GetGuildVoiceRegions(guildId: GuildId) extends NoParamsNiceResponseRequest[Seq[VoiceRegion]] with Product with Serializable
Get the voice regions for this guild.
- case class GetGuildWebhooks(guildId: GuildId) extends NoParamsNiceResponseRequest[Seq[Webhook]] with Product with Serializable
Get the webhooks in a guild.
- case class GetGuildWelcomeScreen(guildId: GuildId) extends NoParamsNiceResponseRequest[WelcomeScreen] with Product with Serializable
- case class GetGuildWidget(guildId: GuildId) extends NoParamsNiceResponseRequest[GuildWidget] with Product with Serializable
Get the guild widget for a guild.
- case class GetGuildWidgetImage(guildId: GuildId, style: WidgetImageStyle = WidgetImageStyle.Shield) extends ImageRequest with Product with Serializable
Get the widget image for a specific guild.
Get the widget image for a specific guild.
- guildId
The guild to get the widget for.
- style
Which style should be gotten.
- case class GetGuildWidgetSettings(guildId: GuildId) extends NoParamsNiceResponseRequest[GuildWidgetSettings] with Product with Serializable
Get the guild widget settings for a guild.
- case class GetInvite(inviteCode: String, withCounts: Boolean = false, withExpiration: Boolean = false, guildScheduledEventId: Option[SnowflakeType[GuildScheduledEvent]] = None) extends NoParamsNiceResponseRequest[Invite] with Product with Serializable
Get an invite for a given invite code.
Get an invite for a given invite code.
- withCounts
If the returned invite object should return approximate counts for members and people online.
- withExpiration
If the invite should contain the expiration date.
- guildScheduledEventId
The guild scheduled event to include in the invite.
- case class GetOriginalWebhookMessage(id: SnowflakeType[Webhook], token: String) extends NoParamsRequest[RawMessage, Message] with Product with Serializable
- case class GetPinnedMessages(channelId: TextChannelId) extends NoParamsRequest[Seq[RawMessage], Seq[Message]] with Product with Serializable
Get all the pinned messages in a channel.
- case class GetReactions(channelId: TextChannelId, messageId: MessageId, emoji: String, queryParams: GetReactionsData) extends NoParamsNiceResponseRequest[Seq[User]] with Product with Serializable
Get all the users that have reacted with an emoji for a message.
- case class GetReactionsData(after: Option[UserId] = None, limit: Option[Int] = None) extends Product with Serializable
- after
Get users after this user.
- limit
The max amount of users to return. Defaults to 25.
- case class GetRoleIconImage(desiredSize: Int, format: ImageFormat, roleId: RoleId, iconHash: String) extends ImageRequest with Product with Serializable
Get the role icon image
- case class GetStageInstance(channelId: StageGuildChannelId) extends NoParamsNiceResponseRequest[StageInstance] with Product with Serializable
- case class GetSticker(stickerId: StickerId) extends NoParamsRequest[RawSticker, Sticker] with Product with Serializable
- case class GetStickerImage(format: ImageFormat, stickerId: StickerId) extends ImageRequest with Product with Serializable
Get a sticker image.
Get a sticker image. Allowed formats are PNG and Lottie.
- case class GetStickerPackBannerImage(desiredSize: Int, format: ImageFormat, stickerPackBannerAssetId: String) extends ImageRequest with Product with Serializable
Get the banner for a sticker pack.
Get the banner for a sticker pack. Allowed formats are PNG, JPEG and WebP.
- case class GetTeamIconImage(desiredSize: Int, format: ImageFormat, teamId: SnowflakeType[Team], teamIcon: String) extends ImageRequest with Product with Serializable
Get the icon for a team
Get the icon for a team
- teamId
The id of the team to get the icon for
- teamIcon
The icon identifier
- case class GetThreadMember(channelId: ThreadGuildChannelId, userId: UserId) extends NoParamsRequest[RawThreadMember, ThreadMember] with Product with Serializable
Returns a ThreadMember for a specified user in a thread.
- case class GetThreadsResponse(threads: Seq[RawChannel], members: Seq[RawThreadMember], hasMore: Boolean) extends Product with Serializable
- case class GetUser(userId: UserId) extends NoParamsNiceResponseRequest[User] with Product with Serializable
Get a user by id.
- case class GetUserAvatarImage(desiredSize: Int, format: ImageFormat, userId: UserId, avatarHash: String) extends ImageRequest with Product with Serializable
Get the image of a user avatar.
Get the image of a user avatar. Allowed formats are PNG, JPEG, WebP and GIF.
- case class GetUserBannerImage(desiredSize: Int, format: ImageFormat, userId: UserId, bannerHash: String) extends ImageRequest with Product with Serializable
- case class GetUserGuildAvatarImage(desiredSize: Int, format: ImageFormat, guildId: GuildId, userId: UserId, avatarHash: String) extends ImageRequest with Product with Serializable
Get the image of a user guild avatar.
Get the image of a user guild avatar. Allowed formats are PNG, JPEG, WebP and GIF.
- case class GetUserGuildsGuild(id: GuildId, name: String, icon: Option[String], owner: Boolean, permissions: Permission, features: Seq[GuildFeature]) extends Product with Serializable
- case class GetWebhook(id: SnowflakeType[Webhook]) extends NoParamsNiceResponseRequest[Webhook] with Product with Serializable
Get a webhook by id.
- case class GetWebhookMessage(id: SnowflakeType[Webhook], token: String, messageId: MessageId, threadId: Option[ThreadGuildChannelId] = None) extends NoParamsRequest[RawMessage, Message] with Product with Serializable
- case class GetWebhookWithToken(id: SnowflakeType[Webhook], token: String) extends NoParamsNiceResponseRequest[Webhook] with Product with Serializable
Get a webhook by id with a token.
Get a webhook by id with a token. Doesn't require authentication.
- trait GuildMemberRequest[Params] extends RESTRequest[Params, RawGuildMember, GuildMember]
- case class GuildPruneCountData(days: Int, includeRoles: Seq[RoleId]) extends Product with Serializable
- days
The amount of days to prune for.
- includeRoles
Roles that should be ignored when checking for inactive users.
- case class GuildPruneCountResponse(pruned: Int) extends Product with Serializable
- pruned
The number of members that would be removed.
- case class HttpException(uri: Uri, method: HttpMethod, statusCode: StatusCode, extraInfo: Option[String]) extends Exception with Product with Serializable
An exception for Http errors.
- case class HttpJsonDecodeException(message: String) extends Exception with Product with Serializable
An exception thrown when parsing JSON if something goes wrong.
- trait ImageRequest extends Request[ByteString]
Base traits for all traits to get images
- case class JoinThread(channelId: ThreadGuildChannelId) extends NoParamsResponseRequest with Product with Serializable
Adds the current user to a thread.
- case class LeaveGuild(guildId: GuildId) extends NoParamsResponseRequest with Product with Serializable
Leave a guild.
- case class LeaveThread(channelId: ThreadGuildChannelId) extends NoParamsResponseRequest with Product with Serializable
Makes the current user leave a thread.
- case class ListActiveGuildThreads(guildId: GuildId) extends NoParamsNiceResponseRequest[ListActiveThreadsResponse] with Product with Serializable
- case class ListActiveThreadsResponse(threads: Seq[RawChannel], members: Seq[RawThreadMember]) extends Product with Serializable
- threads
The active threads.
- members
A thread member object for each thread the current user has joined.
- case class ListGuildEmojis(guildId: GuildId) extends RESTRequest[NotUsed, Seq[RawEmoji], Seq[Emoji]] with Product with Serializable
Get all the emojis for this guild.
- case class ListGuildMembers(guildId: GuildId, queryParams: ListGuildMembersData) extends NoParamsRequest[Seq[RawGuildMember], Seq[GuildMember]] with Product with Serializable
Get all the guild members in this guild.
- case class ListGuildMembersData(limit: Option[Int] = None, after: Option[UserId] = None) extends Product with Serializable
- limit
The max amount of members to get
- after
Get userIds after this id
- case class ListGuildStickers(guildId: GuildId) extends NoParamsRequest[Seq[RawSticker], Seq[Sticker]] with Product with Serializable
- case class ListJoinedPrivateArchivedThreads(channelId: TextGuildChannelId, before: Option[OffsetDateTime], limit: Option[Int]) extends NoParamsNiceResponseRequest[GetThreadsResponse] with Product with Serializable
Lists all the joined private archived threads in a channel.
Lists all the joined private archived threads in a channel. Threads are ordered in descending order by RawThreadMetadata.archiveTimestamp.
- case class ListNitroStickerPacksResponse(stickerPacks: Seq[StickerPack]) extends Product with Serializable
- case class ListPrivateArchivedThreads(channelId: TextGuildChannelId, before: Option[OffsetDateTime], limit: Option[Int]) extends NoParamsNiceResponseRequest[GetThreadsResponse] with Product with Serializable
Lists all the private archived threads in a channel.
Lists all the private archived threads in a channel. Threads are ordered in descending order by RawThreadMetadata.archiveTimestamp.
- case class ListPublicArchivedThreads(channelId: TextGuildChannelId, before: Option[OffsetDateTime], limit: Option[Int]) extends NoParamsNiceResponseRequest[GetThreadsResponse] with Product with Serializable
Lists all the public archived threads in a channel.
Lists all the public archived threads in a channel. Threads are ordered in descending order by RawThreadMetadata.archiveTimestamp.
- case class ListScheduledEventsForGuild(guildId: GuildId, withUserCount: Option[Boolean] = None) extends NoParamsNiceResponseRequest[Seq[GuildScheduledEvent]] with Product with Serializable
List the scheduled events for a guild.
List the scheduled events for a guild.
- withUserCount
Include number of users subscribed to each event.
- case class ListThreadMembers(channelId: ThreadGuildChannelId) extends NoParamsRequest[Seq[RawThreadMember], Seq[ThreadMember]] with Product with Serializable
Gets all the members of a thread.
Gets all the members of a thread. Requires the privileged
GUILD_MEMBERS
intent. - trait LowPriorityFlatten extends AnyRef
- case class ModifyChannel(channelId: ChannelId, params: ModifyChannelData, reason: Option[String] = None) extends ReasonRequest[ModifyChannel, ModifyChannelData, RawChannel, Option[Channel]] with Product with Serializable
Update the settings of a channel.
Update the settings of a channel.
- channelId
The channel to update.
- case class ModifyChannelData(name: util.JsonOption[String] = JsonUndefined, icon: util.JsonOption[ImageData] = JsonUndefined, tpe: util.JsonOption[ChannelType] = JsonUndefined, position: util.JsonOption[Int] = JsonUndefined, topic: util.JsonOption[String] = JsonUndefined, nsfw: util.JsonOption[Boolean] = JsonUndefined, rateLimitPerUser: util.JsonOption[Int] = JsonUndefined, bitrate: util.JsonOption[Int] = JsonUndefined, userLimit: util.JsonOption[Int] = JsonUndefined, permissionOverwrites: util.JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, parentId: util.JsonOption[SnowflakeType[GuildCategory]] = JsonUndefined, rtcRegion: util.JsonOption[String] = JsonUndefined, videoQualityMode: util.JsonOption[VideoQualityMode] = JsonUndefined, archived: util.JsonOption[Boolean] = JsonUndefined, locked: util.JsonOption[Boolean] = JsonUndefined, invitable: util.JsonOption[Boolean] = JsonUndefined, autoArchiveDuration: util.JsonOption[Int] = JsonUndefined) extends Product with Serializable
- name
New name of the channel.
- position
New position of the channel.
- topic
The new channel topic for text channels.
- nsfw
If the channel is NSFW for text channels.
- rateLimitPerUser
The new user ratelimit for guild text channels.
- bitrate
The new channel bitrate for voice channels.
- userLimit
The new user limit for voice channel.
- permissionOverwrites
The new channel permission overwrites.
- parentId
The new category id of the channel.
- rtcRegion
The voice region to use. Automatic if None.
- case class ModifyCurrentMember(guildId: GuildId, params: ModifyCurrentMemberData, reason: Option[String] = None) extends ReasonRequest[ModifyCurrentMember, ModifyCurrentMemberData, RawGuildMember, GuildMember] with Product with Serializable
Modify Current Member
- case class ModifyCurrentMemberData(nick: util.JsonOption[String] = JsonUndefined) extends Product with Serializable
- case class ModifyCurrentUser(params: ModifyCurrentUserData) extends NoNiceResponseRequest[ModifyCurrentUserData, User] with Product with Serializable
Modify the current user.
- case class ModifyCurrentUserData(username: util.JsonOption[String], avatar: util.JsonOption[ImageData]) extends Product with Serializable
- case class ModifyGuild(guildId: GuildId, params: ModifyGuildData, reason: Option[String] = None) extends ReasonRequest[ModifyGuild, ModifyGuildData, RawGuild, RequestsGuild] with Product with Serializable
Modify an existing guild.
- case class ModifyGuildChannelPositions(guildId: GuildId, params: Seq[ModifyGuildChannelPositionsData], reason: Option[String] = None) extends NoResponseReasonRequest[ModifyGuildChannelPositions, Seq[ModifyGuildChannelPositionsData]] with Product with Serializable
Modify the positions of several channels.
- case class ModifyGuildChannelPositionsData(id: GuildChannelId, position: util.JsonOption[Int] = JsonUndefined, lockPermissions: util.JsonOption[Boolean] = JsonUndefined, parentId: util.JsonOption[ChannelId] = JsonUndefined) extends Product with Serializable
- id
The channel id.
- position
It's new position.
- lockPermissions
If the permissions should be synced with the category if the channel is moved to a new category.
- parentId
Parent category id to move the channel to a new category.
- case class ModifyGuildData(name: util.JsonOption[String] = JsonUndefined, verificationLevel: util.JsonOption[VerificationLevel] = JsonUndefined, defaultMessageNotifications: util.JsonOption[NotificationLevel] = JsonUndefined, explicitContentFilter: util.JsonOption[FilterLevel] = JsonUndefined, afkChannelId: util.JsonOption[NormalVoiceGuildChannelId] = JsonUndefined, afkTimeout: util.JsonOption[Int] = JsonUndefined, icon: util.JsonOption[ImageData] = JsonUndefined, ownerId: util.JsonOption[UserId] = JsonUndefined, splash: util.JsonOption[ImageData] = JsonUndefined, discoverySplash: util.JsonOption[ImageData] = JsonUndefined, banner: util.JsonOption[ImageData] = JsonUndefined, systemChannelId: util.JsonOption[TextGuildChannelId] = JsonUndefined, systemChannelFlags: util.JsonOption[SystemChannelFlags] = JsonUndefined, preferredLocale: util.JsonOption[String] = JsonUndefined, features: util.JsonOption[Seq[String]] = JsonUndefined, description: util.JsonOption[String] = JsonUndefined, premiumProgressBarEnabled: util.JsonOption[Boolean] = JsonUndefined) extends Product with Serializable
- name
The new name of the guild
- verificationLevel
The new verification level to use for the guild.
- defaultMessageNotifications
The new notification level to use for the guild.
- afkChannelId
The new afk channel of the guild.
- afkTimeout
The new afk timeout in seconds for the guild.
- icon
The new icon to use for the guild. Must be 1024x1024 png/jpeg/gif. Can be animated if the guild has the
ANIMATED_ICON
feature.- ownerId
Transfer ownership of this guild. Must be the owner.
- splash
The new splash for the guild. Must be 16:9 png/jpeg. Only available if the guild has the
INVITE_SPLASH
feature.- discoverySplash
Thew new discovery slash for the guild's discovery splash. Only available if the guild has the
DISCOVERABLE
feature.- banner
The new banner for the guild. Must be 16:9 png/jpeg. Only available if the guild has the
BANNER
feature.- systemChannelId
The new channel which system messages will be sent to.
- systemChannelFlags
The new flags for the system channel.
- preferredLocale
The new preferred locale for the guild.
- features
The new enabled features for the guild.
- description
The new description for the guild if it is discoverable.
- premiumProgressBarEnabled
If the boosting progress bar should be shown.
- case class ModifyGuildEmoji(emojiId: EmojiId, guildId: GuildId, params: ModifyGuildEmojiData, reason: Option[String] = None) extends ReasonRequest[ModifyGuildEmoji, ModifyGuildEmojiData, RawEmoji, Emoji] with Product with Serializable
Modify an existing emoji.
- case class ModifyGuildEmojiData(name: String, roles: util.JsonOption[Seq[RoleId]] = JsonUndefined) extends Product with Serializable
- name
The new emoji name.
- roles
Whitelist of roles that can use this emoji.
- case class ModifyGuildMember(guildId: GuildId, userId: UserId, params: ModifyGuildMemberData, reason: Option[String] = None) extends ReasonRequest[ModifyGuildMember, ModifyGuildMemberData, RawGuildMember, GuildMember] with Product with Serializable
Modify a guild member.
- case class ModifyGuildMemberData(nick: util.JsonOption[String] = JsonUndefined, roles: util.JsonOption[Seq[RoleId]] = JsonUndefined, mute: util.JsonOption[Boolean] = JsonUndefined, deaf: util.JsonOption[Boolean] = JsonUndefined, channelId: util.JsonOption[VoiceGuildChannelId] = JsonUndefined, communicationDisabledUntil: util.JsonOption[OffsetDateTime] = JsonUndefined) extends Product with Serializable
- nick
The nickname to give to the user.
- roles
The roles to give to the user.
- mute
If the user should be muted. Will return an error if the user is not in a voice channel.
- deaf
If the user should be deafened. Will return an error if the user is not in a voice channel.
- channelId
The id of the channel to move the user to.
- case class ModifyGuildRole(guildId: GuildId, roleId: RoleId, params: ModifyGuildRoleData, reason: Option[String] = None) extends ReasonRequest[ModifyGuildRole, ModifyGuildRoleData, RawRole, Role] with Product with Serializable
Modify a role.
- case class ModifyGuildRoleData(name: util.JsonOption[String] = JsonUndefined, permissions: util.JsonOption[Permission] = JsonUndefined, color: util.JsonOption[Int] = JsonUndefined, hoist: util.JsonOption[Boolean] = JsonUndefined, icon: util.JsonOption[ImageData] = JsonUndefined, unicodeEmoji: util.JsonOption[String] = JsonUndefined, mentionable: util.JsonOption[Boolean] = JsonUndefined) extends Product with Serializable
- name
The new name of the role.
- permissions
The new permissions this role has.
- color
The new color of the role.
- hoist
If this role is shown in the right sidebar.
- icon
The role's icon image.
- unicodeEmoji
The role's unicode emoji.
- mentionable
If this role is mentionable.
- case class ModifyGuildRolePositions(guildId: GuildId, params: Seq[ModifyGuildRolePositionsData], reason: Option[String] = None) extends ReasonRequest[ModifyGuildRolePositions, Seq[ModifyGuildRolePositionsData], Seq[RawRole], Seq[Role]] with Product with Serializable
Modify the positions of several roles.
- case class ModifyGuildRolePositionsData(id: RoleId, position: Int) extends Product with Serializable
- id
The role id.
- position
The new position of the role.
- case class ModifyGuildScheduledEvent(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent], params: ModifyGuildScheduledEventData) extends NoNiceResponseRequest[ModifyGuildScheduledEventData, GuildScheduledEvent] with Product with Serializable
Modify a specific guild scheduled event.
- case class ModifyGuildScheduledEventData(channelId: util.JsonOption[VoiceGuildChannelId] = JsonUndefined, entityMetadata: util.JsonOption[GuildScheduledEventEntityMetadata] = JsonUndefined, name: util.JsonOption[String] = JsonUndefined, privacyLevel: util.JsonOption[StageInstancePrivacyLevel] = JsonUndefined, scheduledStartTime: util.JsonOption[OffsetDateTime] = JsonUndefined, scheduledEndTime: util.JsonOption[OffsetDateTime] = JsonUndefined, description: util.JsonOption[String] = JsonUndefined, entityType: util.JsonOption[GuildScheduledEventEntityType] = JsonUndefined, status: util.JsonOption[GuildScheduledEventStatus] = JsonUndefined) extends Product with Serializable
- case class ModifyGuildSticker(guildId: GuildId, stickerId: StickerId, params: ModifyGuildStickerData, reason: Option[String] = None) extends ReasonRequest[ModifyGuildSticker, ModifyGuildStickerData, RawSticker, Sticker] with Product with Serializable
- case class ModifyGuildStickerData(name: util.JsonOption[String], description: util.JsonOption[String], tags: util.JsonOption[String]) extends Product with Serializable
- case class ModifyGuildTemplate(guildId: GuildId, code: String, params: ModifyGuildTemplateData) extends NoNiceResponseRequest[ModifyGuildTemplateData, GuildTemplate] with Product with Serializable
Modify the info around a guild template.
- case class ModifyGuildTemplateData(name: util.JsonOption[String] = JsonUndefined, description: util.JsonOption[String] = JsonUndefined) extends Product with Serializable
- case class ModifyGuildWelcomeScreen(guildId: GuildId, params: ModifyGuildWelcomeScreenData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyGuildWelcomeScreen, ModifyGuildWelcomeScreenData, WelcomeScreen] with Product with Serializable
- case class ModifyGuildWelcomeScreenData(enabled: util.JsonOption[Boolean] = JsonUndefined, welcomeChannels: util.JsonOption[Seq[WelcomeScreenChannel]] = JsonUndefined, description: util.JsonOption[String] = JsonUndefined) extends Product with Serializable
- case class ModifyGuildWidget(guildId: GuildId, params: GuildWidgetSettings, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyGuildWidget, GuildWidgetSettings, GuildWidgetSettings] with Product with Serializable
Modify a guild widget for a guild.
- case class ModifyWebhook(id: SnowflakeType[Webhook], params: ModifyWebhookData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyWebhook, ModifyWebhookData, Webhook] with Product with Serializable
Modify a webhook.
- case class ModifyWebhookData(name: util.JsonOption[String] = JsonUndefined, avatar: util.JsonOption[ImageData] = JsonUndefined, channelId: util.JsonOption[TextGuildChannelId] = JsonUndefined) extends Product with Serializable
- name
Name of the webhook.
- avatar
The avatar data of the webhook.
- channelId
The channel this webhook should be moved to.
- case class ModifyWebhookWithToken(id: SnowflakeType[Webhook], token: String, params: ModifyWebhookData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyWebhookWithToken, ModifyWebhookData, Webhook] with Product with Serializable
Modify a webhook with a token.
Modify a webhook with a token. Doesn't require authentication
- trait NoNiceResponseReasonRequest[Self <: NoNiceResponseReasonRequest[Self, Params, Response], Params, Response] extends ReasonRequest[Self, Params, Response, Response] with NoNiceResponseRequest[Params, Response]
A request, with an audit log reason, where the response type and the nice response type are the same.
- trait NoNiceResponseRequest[Params, Response] extends RESTRequest[Params, Response, Response]
A request where the response type and the nice response type are the same.
- trait NoParamsNiceResponseReasonRequest[Self <: NoParamsNiceResponseReasonRequest[Self, Response], Response] extends NoParamsReasonRequest[Self, Response, Response] with NoNiceResponseReasonRequest[Self, NotUsed, Response]
A request, with an audit log reason, that takes no params, and where the response type and the nice response type are the same.
- trait NoParamsNiceResponseRequest[Response] extends NoParamsRequest[Response, Response] with NoNiceResponseRequest[NotUsed, Response]
A request that takes no params, and where the response type and the nice response type are the same.
- trait NoParamsReasonRequest[Self <: NoParamsReasonRequest[Self, RawResponse, NiceResponse], RawResponse, NiceResponse] extends ReasonRequest[Self, NotUsed, RawResponse, NiceResponse] with NoParamsRequest[RawResponse, NiceResponse]
A request that takes no params with an audit log reason.
- trait NoParamsRequest[RawResponse, NiceResponse] extends RESTRequest[NotUsed, RawResponse, NiceResponse]
A request that takes no params.
- trait NoParamsResponseReasonRequest[Self <: NoParamsResponseReasonRequest[Self]] extends NoParamsReasonRequest[Self, NotUsed, NotUsed] with NoResponseReasonRequest[Self, NotUsed]
A request that has neither params nor a response with a reason.
- trait NoParamsResponseRequest extends NoParamsRequest[NotUsed, NotUsed] with NoResponseRequest[NotUsed]
A request that has neither params nor a response.
- trait NoResponseReasonRequest[Self <: NoResponseReasonRequest[Self, Params], Params] extends NoNiceResponseReasonRequest[Self, Params, NotUsed] with NoResponseRequest[Params]
A request, with an audit log reason, that doesn't have a response.
- trait NoResponseRequest[Params] extends NoNiceResponseRequest[Params, NotUsed]
A request that doesn't have a response.
- case class PinMessage(channelId: TextChannelId, messageId: MessageId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[PinMessage] with Product with Serializable
Pin a message in a channel.
- trait RESTRequest[Params, RawResponse, NiceResponse] extends BaseRESTRequest[RawResponse, NiceResponse]
A simpler, request trait where the params are defined explicitly and converted to json.
A simpler, request trait where the params are defined explicitly and converted to json.
- Params
The json parameters of the request.
- case class RatelimitException(global: Boolean, tilRetry: FiniteDuration, uri: Uri, identifier: UUID) extends Exception with Product with Serializable
An exception that signals than an endpoint is ratelimited.
An exception that signals than an endpoint is ratelimited.
- global
If the rate limit is global.
- tilRetry
The amount of time in milliseconds until the ratelimit goes away.
- uri
The Uri for the request.
- case class RatelimitInfo(tilReset: FiniteDuration, tilRatelimit: Int, bucketLimit: Int, bucket: String) extends Product with Serializable
Misc info needed to handle ratelimits correctly.
Misc info needed to handle ratelimits correctly.
- tilReset
The amount of time until this endpoint ratelimit is reset. Minus if unknown.
- tilRatelimit
The amount of requests that can be made until this endpoint is ratelimited. -1 if unknown.
- bucketLimit
The total amount of requests that can be sent to this to this endpoint until a ratelimit kicks in. -1 if unknown.
- bucket
The ratelimit bucket for this request. Does not include any parameters.
- trait Ratelimiter extends AnyRef
- class RatelimiterActor extends AbstractBehavior[Command]
- trait ReasonRequest[Self <: ReasonRequest[Self, Params, RawResponse, NiceResponse], Params, RawResponse, NiceResponse] extends RESTRequest[Params, RawResponse, NiceResponse]
A complex REST request with an audit log reason.
- case class RemoveGuildBan(guildId: GuildId, userId: UserId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[RemoveGuildBan] with Product with Serializable
Unban a user from a guild.
- case class RemoveGuildMember(guildId: GuildId, userId: UserId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[RemoveGuildMember] with Product with Serializable
Kicks a guild member.
- case class RemoveGuildMemberRole(guildId: GuildId, userId: UserId, roleId: RoleId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[RemoveGuildMemberRole] with Product with Serializable
Remove a role from a guild member.
- case class RemoveThreadMember(channelId: ThreadGuildChannelId, userId: UserId) extends NoParamsResponseRequest with Product with Serializable
Removes the specified user from a thread.
- trait Request[+Data] extends AnyRef
Base super simple trait for all HTTP requests in AckCord.
Base super simple trait for all HTTP requests in AckCord.
- Data
The parsed response type.
- sealed trait RequestAnswer[+Data] extends AnyRef
Sent as a response to a request.
- case class RequestDropped(route: RequestRoute, identifier: UUID) extends FailedRequest with Product with Serializable
A request that was dropped before it entered the network, most likely because of timing out while waiting for ratelimits.
- case class RequestError(e: Throwable, route: RequestRoute, identifier: UUID) extends FailedRequest with Product with Serializable
A request that failed for some other reason.
- case class RequestRatelimited(global: Boolean, ratelimitInfo: RatelimitInfo, route: RequestRoute, identifier: UUID) extends FailedRequest with Product with Serializable
A request that did not succeed because of a ratelimit.
- case class RequestResponse[+Data](data: Data, ratelimitInfo: RatelimitInfo, route: RequestRoute, identifier: UUID) extends RequestAnswer[Data] with Product with Serializable
A successful request response.
- case class RequestRoute(uriWithMajor: String, uriWithoutMajor: String, uri: Uri, method: HttpMethod) extends Product with Serializable
Used by requests for specifying an uri to send to, together with a method to use.
Used by requests for specifying an uri to send to, together with a method to use.
- uriWithMajor
A string containing the route without any minor parameters filled in
- uriWithoutMajor
A string containing the route without any major or minor parameters filled in
- uri
The uri to send to
- method
The method to use
- case class RequestSettings(credentials: Option[HttpCredentials], ratelimiter: Ratelimiter, relativeTime: Boolean = false, parallelism: Int = 4, maxRetryCount: Int = 3, bufferSize: Int = 32, overflowStrategy: OverflowStrategy = OverflowStrategy.backpressure, userAgent: User-Agent = RequestStreams.defaultUserAgent) extends Product with Serializable
- credentials
The credentials to use when sending the requests.
- ratelimiter
The object to use to track ratelimits and such
- relativeTime
Sets if the ratelimit reset should be calculated using relative time instead of absolute time. Might help with out of sync time on your device, but can also lead to slightly slower processing of requests.
- parallelism
How many requests to try to process at once.
- maxRetryCount
How many times to retry requests if an error occurs on retry flows
- bufferSize
The size of the internal buffer used before messages are sent.
- overflowStrategy
The strategy to use if the buffer overflows.
- case class Requests(settings: RequestSettings, alsoProcessRequests: Sink[(Request[Data], RequestAnswer[Data]) forSome {type Data}, NotUsed] = Sink.ignore.mapMaterializedValue(_ => NotUsed))(implicit system: ActorSystem[Nothing]) extends Product with Serializable
A class holding all the relevant information to create a request stream.
A class holding all the relevant information to create a request stream. Also contains some convenience methods for common operations with requests.
This should be instantiated once per bot, and shared between shards.
- class RequestsHelper extends AnyRef
A small layer on top of Requests for use in high level code.
- final class Retry-After extends ModeledCustomHeader[Retry-After]
- case class SearchGuildMembers(guildId: GuildId, params: SearchGuildMembersData) extends RESTRequest[SearchGuildMembersData, Seq[RawGuildMember], Seq[GuildMember]] with Product with Serializable
- case class SearchGuildMembersData(query: String, limit: util.JsonOption[Int] = JsonUndefined) extends Product with Serializable
- case class StartThreadWithMessage(channelId: TextGuildChannelId, messageId: MessageId, params: StartThreadWithMessageData, reason: Option[String] = None) extends ReasonRequest[StartThreadWithMessage, StartThreadWithMessageData, RawChannel, Option[ThreadGuildChannel]] with Product with Serializable
Create a new public thread from an existing message.
- case class StartThreadWithMessageData(name: String, autoArchiveDuration: Option[Int] = None, rateLimitPerUser: Option[Int] = None) extends Product with Serializable
- case class StartThreadWithoutMessage(channelId: TextGuildChannelId, params: StartThreadWithoutMessageData, reason: Option[String] = None) extends ReasonRequest[StartThreadWithoutMessage, StartThreadWithoutMessageData, RawChannel, Option[ThreadGuildChannel]] with Product with Serializable
Create a new public thread from an existing message.
- case class StartThreadWithoutMessageData(name: String, type: ThreadChannelType, autoArchiveDuration: Option[Int] = None, invitable: Option[Boolean] = None, rateLimitPerUser: Option[Int] = None) extends Product with Serializable
- case class SyncGuildTemplate(guildId: GuildId, code: String) extends NoParamsNiceResponseRequest[GuildTemplate] with Product with Serializable
Syncs the template and the guild.
- case class TriggerTypingIndicator(channelId: TextChannelId) extends NoParamsResponseRequest with Product with Serializable
Triggers a typing indicator in a channel.
- case class UnpinMessage(channelId: TextChannelId, messageId: MessageId, reason: Option[String] = None) extends NoParamsResponseReasonRequest[UnpinMessage] with Product with Serializable
Unpin a message in a channel..
- case class UpdateCurrentUserVoiceState(guildId: GuildId, params: UpdateCurrentUserVoiceStateData) extends NoResponseRequest[UpdateCurrentUserVoiceStateData] with Product with Serializable
- case class UpdateCurrentUserVoiceStateData(channelId: StageGuildChannelId, suppress: util.JsonOption[Boolean], requestToSpeakTimestamp: util.JsonOption[OffsetDateTime]) extends Product with Serializable
- case class UpdateStageInstance(channelId: StageGuildChannelId, params: UpdateStageInstanceData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[UpdateStageInstance, UpdateStageInstanceData, StageInstance] with Product with Serializable
- case class UpdateStageInstanceData(topic: util.JsonOption[String] = JsonUndefined, privacyLevel: util.JsonOption[StageInstancePrivacyLevel] = JsonUndefined) extends Product with Serializable
- case class UpdateUserVoiceState(guildId: GuildId, userId: UserId, params: UpdateUserVoiceStateData) extends NoResponseRequest[UpdateUserVoiceStateData] with Product with Serializable
- case class UpdateUserVoiceStateData(channelId: StageGuildChannelId, suppress: util.JsonOption[Boolean]) extends Product with Serializable
- case class VanityUrlResponse(code: String) extends Product with Serializable
- final class X-Audit-Log-Reason extends ModeledCustomHeader[X-Audit-Log-Reason]
- final class X-RateLimit-Bucket extends ModeledCustomHeader[X-RateLimit-Bucket]
- final class X-RateLimit-Limit extends ModeledCustomHeader[X-RateLimit-Limit]
- final class X-RateLimit-Remaining extends ModeledCustomHeader[X-RateLimit-Remaining]
- final class X-RateLimit-Reset extends ModeledCustomHeader[X-RateLimit-Reset]
- final class X-RateLimit-Reset-After extends ModeledCustomHeader[X-RateLimit-Reset-After]
- final class X-Ratelimit-Global extends ModeledCustomHeader[X-Ratelimit-Global]
Deprecated Type Members
- case class CreateGroupDm(params: CreateGroupDMData) extends RESTRequest[CreateGroupDMData, RawChannel, Option[GroupDMChannel]] with Product with Serializable
Create a group DM.
Create a group DM. By default the client is limited to 10 active group DMs.
- Annotations
- @deprecated
- Deprecated
(Since version 0.13) Deprecated by Discord
- case class ListActiveChannelThreads(channelId: TextGuildChannelId) extends NoParamsNiceResponseRequest[GetThreadsResponse] with Product with Serializable
Lists all the active threads in a channel.
Lists all the active threads in a channel. Threads are ordered in descending order by their id.
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.0) Deprecated by Discord
- case class ModifyBotUsersNick(guildId: GuildId, params: ModifyBotUsersNickData, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyBotUsersNick, ModifyBotUsersNickData, String] with Product with Serializable
Modify the clients nickname.
Modify the clients nickname.
- Annotations
- @deprecated
- Deprecated
- case class ModifyBotUsersNickData(nick: util.JsonOption[String] = JsonUndefined) extends Product with Serializable
- Annotations
- @deprecated
- Deprecated
Value Members
- def hasPermissionsChannel(channelId: ChannelId, permissions: Permission)(implicit c: CacheSnapshot): Boolean
Check if a client has the needed permissions in a channel
Check if a client has the needed permissions in a channel
- channelId
The channel to check for
- permissions
The needed permissions
- c
The cache
- def hasPermissionsGuild(guildId: GuildId, permissions: Permission)(implicit c: CacheSnapshot): Boolean
Check if a client has the needed permissions in a guild
Check if a client has the needed permissions in a guild
- guildId
The guild to check for
- permissions
The needed permissions
- c
The cache
- object BeginGuildPrune extends Serializable
- object BotAuthentication
- object BulkDeleteMessages extends Serializable
- object CreateChannelInvite extends Serializable
- object CreateChannelInviteData extends Serializable
- object CreateDm extends Serializable
- object CreateGuildBan extends Serializable
- object CreateGuildChannelData extends Serializable
- object CreateGuildEmoji extends Serializable
- object CreateMessage extends Serializable
- object CreateMessageData extends Serializable
- object CreateMessageFile
- object EditChannelPermissions extends Serializable
- object EditMessage extends Serializable
- object EditMessageData extends Serializable
- object EditWebhookMessageData extends Serializable
- object ExecuteWebhookData extends Serializable
- object FlattenUnflatten extends LowPriorityFlatten
- object GetChannelMessages extends Serializable
- case object GetCurrentUser extends NoParamsNiceResponseRequest[User] with Product with Serializable
Fetch the client user.
- object GetCurrentUserGuilds extends Serializable
- object GetGuildPruneCount extends Serializable
- object GetReactions extends Serializable
- object GetThreadsResponse extends Serializable
- case object GetUserConnections extends NoParamsNiceResponseRequest[Seq[Connection]] with Product with Serializable
Get a list of connection objects.
Get a list of connection objects. Requires the
connection
OAuth2 scope. - object ImageRequest
- object ListGuildMembers extends Serializable
- case object ListNitroStickerPacks extends NoParamsNiceResponseRequest[ListNitroStickerPacksResponse] with Product with Serializable
- case object ListVoiceRegions extends NoParamsNiceResponseRequest[Seq[VoiceRegion]] with Product with Serializable
List all the voice regions that can be used when setting a voice of stage channel's ackcord.data.VoiceGuildChannel.rtcRegion.
- object ModifyChannelData extends Serializable
- object ModifyCurrentMemberData extends Serializable
- object ModifyCurrentUserData extends Serializable
- object ModifyGuildChannelPositionsData extends Serializable
- object ModifyGuildData extends Serializable
- object ModifyGuildEmoji extends Serializable
- object ModifyGuildEmojiData extends Serializable
- object ModifyGuildMemberData extends Serializable
- object ModifyGuildRoleData extends Serializable
- object ModifyGuildScheduledEventData extends Serializable
- object ModifyGuildStickerData extends Serializable
- object ModifyGuildWelcomeScreenData extends Serializable
- object ModifyWebhookData extends Serializable
- object OAuth
- object Ratelimiter
- object RatelimiterActor
- object RequestRoute extends Serializable
- object RequestStreams
- object Requests extends Serializable
- object Retry-After extends ModeledCustomHeaderCompanion[Retry-After]
- object Routes
All the routes used by AckCord
- object SearchGuildMembersData extends Serializable
- object SupervisionStreams
- object UpdateCurrentUserVoiceStateData extends Serializable
- object UpdateStageInstanceData extends Serializable
- object UpdateUserVoiceStateData extends Serializable
- object X-Audit-Log-Reason extends ModeledCustomHeaderCompanion[X-Audit-Log-Reason]
- object X-RateLimit-Bucket extends ModeledCustomHeaderCompanion[X-RateLimit-Bucket]
- object X-RateLimit-Limit extends ModeledCustomHeaderCompanion[X-RateLimit-Limit]
- object X-RateLimit-Remaining extends ModeledCustomHeaderCompanion[X-RateLimit-Remaining]
- object X-RateLimit-Reset extends ModeledCustomHeaderCompanion[X-RateLimit-Reset]
- object X-RateLimit-Reset-After extends ModeledCustomHeaderCompanion[X-RateLimit-Reset-After]
- object X-Ratelimit-Global extends ModeledCustomHeaderCompanion[X-Ratelimit-Global]
Deprecated Value Members
- object ModifyBotUsersNick extends Serializable
- Annotations
- @deprecated
- Deprecated
- object ModifyBotUsersNickData extends Serializable
- Annotations
- @deprecated
- Deprecated