package rest
- Alphabetic
- By Inheritance
- rest
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
case class
AddGuildMember[Ctx](guildId: GuildId, userId: UserId, params: AddGuildMemberData, context: Ctx = NotUsed: NotUsed) extends GuildMemberRequest[AddGuildMemberData, Ctx] with Product with Serializable
Adds a user to a guild.
Adds a user to a guild. Requires the
guilds.joinOAuth2 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.
- mute
If the user should be muted.
- deaf
If the user should be deafened.
-
case class
AddGuildMemberRole[Ctx](guildId: GuildId, userId: UserId, roleId: RoleId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Add a role to a guild member.
-
case class
AddPinnedChannelMessages[Ctx](channelId: ChannelId, messageId: MessageId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Add a new pinned message to a channel.
-
trait
BaseRESTRequest[RawResponse, NiceResponse, Ctx] extends Request[RawResponse, Ctx]
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[Ctx](guildId: GuildId, params: GuildPruneData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends GuildPrune[Ctx] with NoNiceResponseReasonRequest[BeginGuildPrune[Ctx], GuildPruneData, GuildPruneResponse, Ctx] with Product with Serializable
Begin a guild prune.
-
case class
BulkDeleteMessages[Ctx](channelId: ChannelId, params: BulkDeleteMessagesData, context: Ctx = NotUsed: NotUsed) extends NoResponseRequest[BulkDeleteMessagesData, Ctx] 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[Ctx](channelId: ChannelId, params: CreateChannelInviteData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoNiceResponseReasonRequest[CreateChannelInvite[Ctx], CreateChannelInviteData, Invite, Ctx] 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: Int = 86400, maxUses: Int = 0, temporary: Boolean = false, unique: Boolean = false) 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.
-
case class
CreateDMData(recipientId: UserId) extends Product with Serializable
- recipientId
User to send a DM to.
-
case class
CreateDm[Ctx](params: CreateDMData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[CreateDMData, RawChannel, Option[DMChannel], Ctx] with Product with Serializable
Create a new DM channel.
-
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.joinscope.- nicks
A map specifying the nicknames for the users in this group DM.
-
case class
CreateGroupDm[Ctx](params: CreateGroupDMData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[CreateGroupDMData, RawChannel, Option[GroupDMChannel], Ctx] with Product with Serializable
Create a group DM.
Create a group DM. By default the client is limited to 10 active group DMs.
-
case class
CreateGuild[Ctx](params: CreateGuildData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[CreateGuildData, RawGuild, Option[Guild], Ctx] 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[Ctx](guildId: GuildId, userId: UserId, params: CreateGuildBanData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoResponseReasonRequest[CreateGuildBan[Ctx], CreateGuildBanData, Ctx] with Product with Serializable
Ban a user from a guild.
-
case class
CreateGuildBanData(delete-message-days: Int, reason: String) extends Product with Serializable
- reason
The reason for the ban.
-
case class
CreateGuildChannel[Ctx](guildId: GuildId, params: CreateGuildChannelData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[CreateGuildChannel[Ctx], CreateGuildChannelData, RawChannel, Option[GuildChannel], Ctx] with Product with Serializable
Create a channel in a guild.
-
case class
CreateGuildChannelData(name: String, type: JsonOption[ChannelType] = JsonUndefined, topic: JsonOption[String] = JsonUndefined, bitrate: JsonOption[Int] = JsonUndefined, userLimit: JsonOption[Int] = JsonUndefined, rateLimitPerUser: JsonOption[Int] = JsonUndefined, permissionOverwrites: JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, parentId: JsonOption[ChannelId] = JsonUndefined, nsfw: 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, region: String, icon: Option[ImageData], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: Seq[Role], channels: Seq[CreateGuildChannelData]) extends Product with Serializable
- name
The name of the guild
- region
The voice region for the guild
- icon
The icon to use for the guild. Must be 128x128 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.
-
case class
CreateGuildEmoji[Ctx](guildId: GuildId, params: CreateGuildEmojiData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[CreateGuildEmoji[Ctx], CreateGuildEmojiData, RawEmoji, Emoji, Ctx] 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
CreateGuildIntegration[Ctx](guildId: GuildId, params: CreateGuildIntegrationData, context: Ctx = NotUsed: NotUsed) extends NoResponseRequest[CreateGuildIntegrationData, Ctx] with Product with Serializable
Attach an integration to a guild.
-
case class
CreateGuildIntegrationData(type: String, id: IntegrationId) extends Product with Serializable
- id
The integration id
-
case class
CreateGuildRole[Ctx](guildId: GuildId, params: CreateGuildRoleData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[CreateGuildRole[Ctx], CreateGuildRoleData, RawRole, Role, Ctx] 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, 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.
- mentionable
If this role is mentionable.
-
case class
CreateMessage[Ctx](channelId: ChannelId, params: CreateMessageData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[CreateMessageData, RawMessage, Message, Ctx] with Product with Serializable
Create a message in a channel.
-
case class
CreateMessageData(content: String = "", nonce: Option[RawSnowflake] = None, tts: Boolean = false, files: Seq[Path] = Seq.empty, embed: Option[OutgoingEmbed] = None) extends Product with Serializable
- content
The content of the message.
- nonce
A nonce used for optimistic message sending.
- 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.- embed
An embed to send with this message.
-
case class
CreateReaction[Ctx](channelId: ChannelId, messageId: MessageId, emoji: String, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Create a reaction for a message.
Create a reaction for a message.
- emoji
The emoji to send, if this is a Unicode emoji, then you need to url encode it first.
-
case class
CreateWebhook[Ctx](channelId: ChannelId, params: CreateWebhookData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoNiceResponseReasonRequest[CreateWebhook[Ctx], CreateWebhookData, Webhook, Ctx] 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
DeleteAllReactions[Ctx](channelId: ChannelId, messageId: MessageId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Clear all reactions from a message.
-
case class
DeleteChannelPermission[Ctx](channelId: ChannelId, overwriteId: UserOrRoleId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteChannelPermission[Ctx], Ctx] with Product with Serializable
Delete a permission overwrite for a channel.
-
case class
DeleteCloseChannel[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsReasonRequest[DeleteCloseChannel[Ctx], RawChannel, Option[Channel], Ctx] with Product with Serializable
Delete a guild channel, or close a DM channel.
-
case class
DeleteGuild[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Delete a guild.
Delete a guild. Must be the owner.
-
case class
DeleteGuildEmoji[Ctx](emojiId: EmojiId, guildId: GuildId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildEmoji[Ctx], Ctx] with Product with Serializable
Delete an emoji from a guild.
-
case class
DeleteGuildIntegration[Ctx](guildId: GuildId, integrationId: IntegrationId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Delete an integration.
-
case class
DeleteGuildRole[Ctx](guildId: GuildId, roleId: RoleId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteGuildRole[Ctx], Ctx] with Product with Serializable
Delete a role in a guild.
-
case class
DeleteInvite[Ctx](inviteCode: String, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsNiceResponseReasonRequest[DeleteInvite[Ctx], Invite, Ctx] with Product with Serializable
Delete an invite.
-
case class
DeleteMessage[Ctx](channelId: ChannelId, messageId: MessageId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteMessage[Ctx], Ctx] with Product with Serializable
Delete a message
-
case class
DeleteOwnReaction[Ctx](channelId: ChannelId, messageId: MessageId, emoji: String, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Delete the clients reaction to a message.
-
case class
DeletePinnedChannelMessages[Ctx](channelId: ChannelId, messageId: MessageId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Delete a pinned message in a channel.
-
case class
DeleteUserReaction[Ctx](channelId: ChannelId, messageId: MessageId, emoji: String, userId: UserId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Delete the reaction of another user to a message.
-
case class
DeleteWebhook[Ctx](id: SnowflakeType[Webhook], context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteWebhook[Ctx], Ctx] with Product with Serializable
Delete a webhook.
-
case class
DeleteWebhookWithToken[Ctx](id: SnowflakeType[Webhook], token: String, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[DeleteWebhookWithToken[Ctx], Ctx] with Product with Serializable
Delete a webhook with a token.
Delete a webhook with a token. Doesn't require authentication
-
case class
EditChannelPermissions[Ctx](channelId: ChannelId, overwriteId: UserOrRoleId, params: EditChannelPermissionsData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoResponseReasonRequest[EditChannelPermissions[Ctx], EditChannelPermissionsData, Ctx] 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[Ctx](channelId: ChannelId, messageId: MessageId, params: EditMessageData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[EditMessageData, RawMessage, Message, Ctx] with Product with Serializable
Edit an existing message
-
case class
EditMessageData(content: JsonOption[String] = JsonUndefined, embed: JsonOption[OutgoingEmbed] = JsonUndefined) extends Product with Serializable
- content
The content of the new message
- embed
The embed of the new message
-
case class
GetChannel[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[RawChannel, Option[Channel], Ctx] with Product with Serializable
Get a channel by id.
-
case class
GetChannelInvites[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[InviteWithMetadata], Ctx] 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[Ctx](channelId: ChannelId, messageId: MessageId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[RawMessage, Message, Ctx] with Product with Serializable
Get a specific message in a channel.
-
case class
GetChannelMessages[Ctx](channelId: ChannelId, query: GetChannelMessagesData, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[Seq[RawMessage], Seq[Message], Ctx] 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[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[Webhook], Ctx] with Product with Serializable
Get the webhooks in a channel.
-
case class
GetCurrentUser[Ctx](context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[User, Ctx] with Product with Serializable
Fetch the client user.
-
case class
GetCurrentUserGuilds[Ctx](params: GetCurrentUserGuildsData, context: Ctx = NotUsed: NotUsed) extends NoNiceResponseRequest[GetCurrentUserGuildsData, Seq[GetUserGuildsGuild], Ctx] 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
GetGuild[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[RawGuild, Option[Guild], Ctx] with Product with Serializable
Get a guild by id.
-
case class
GetGuildAuditLog[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[AuditLog, Ctx] with Product with Serializable
Get an audit log for a given guild.
-
case class
GetGuildBan[Ctx](guildId: GuildId, userId: UserId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[RawBan, Ban, Ctx] with Product with Serializable
Get the ban object for a specific member in a guild.
-
case class
GetGuildBans[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[Seq[RawBan], Seq[Ban], Ctx] with Product with Serializable
Get all the bans for this guild.
-
case class
GetGuildChannels[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[Seq[RawChannel], Seq[Option[GuildChannel]], Ctx] with Product with Serializable
Get all the channels for a guild.
-
case class
GetGuildEmbed[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[GuildEmbed, Ctx] with Product with Serializable
Get the guild embed for a guild.
-
case class
GetGuildEmoji[Ctx](emojiId: EmojiId, guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[RawEmoji, Emoji, Ctx] with Product with Serializable
Get an emoji in a guild by id.
-
case class
GetGuildIntegrations[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[Integration], Ctx] with Product with Serializable
Get the integrations for this guild.
-
case class
GetGuildInvites[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[InviteWithMetadata], Ctx] with Product with Serializable
Get the invites for this guild.
-
case class
GetGuildMember[Ctx](guildId: GuildId, userId: UserId, context: Ctx = NotUsed: NotUsed) extends GuildMemberRequest[NotUsed, Ctx] with Product with Serializable
Get a guild member by id.
-
case class
GetGuildPruneCount[Ctx](guildId: GuildId, params: GuildPruneData, context: Ctx = NotUsed: NotUsed) extends GuildPrune[Ctx] with Product with Serializable
Check how many members would be removed if a prune was started now.
-
case class
GetGuildRoles[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends RESTRequest[NotUsed, Seq[RawRole], Seq[Role], Ctx] with Product with Serializable
Get all the roles in a guild.
-
case class
GetGuildVanityUrl[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[VanityUrlResponse, Ctx] with Product with Serializable
Get a partial invite object for guilds with that feature enabled.
-
case class
GetGuildVoiceRegions[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[VoiceRegion], Ctx] with Product with Serializable
Get the voice regions for this guild.
-
case class
GetGuildWebhooks[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[Webhook], Ctx] with Product with Serializable
Get the webhooks in a guild.
-
case class
GetInvite[Ctx](inviteCode: String, withCounts: Boolean = false, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Invite, Ctx] 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.
-
case class
GetPinnedMessages[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed) extends NoParamsRequest[Seq[RawMessage], Seq[Message], Ctx] with Product with Serializable
Get all the pinned messages in a channel.
-
case class
GetReactions[Ctx](channelId: ChannelId, messageId: MessageId, emoji: String, params: GetReactionsData, context: Ctx = NotUsed: NotUsed) extends NoNiceResponseRequest[GetReactionsData, Seq[User], Ctx] with Product with Serializable
Get all the users that have reacted with an emoji for a message.
-
case class
GetReactionsData(before: Option[UserId] = None, after: Option[UserId] = None, limit: Option[Int] = None) extends Product with Serializable
- before
Get users before this user.
- after
Get users after this user.
- limit
The max amount of users to return. Defaults to 25.
-
case class
GetUser[Ctx](userId: UserId, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[User, Ctx] with Product with Serializable
Get a user by id.
-
case class
GetUserConnections[Ctx](context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[Connection], Ctx] with Product with Serializable
Get a list of connection objects.
Get a list of connection objects. Requires the
connectionOAuth2 scope. - case class GetUserGuildsGuild(id: GuildId, name: String, icon: Option[String], owner: Boolean, permissions: Permission) extends Product with Serializable
-
case class
GetWebhook[Ctx](id: SnowflakeType[Webhook], context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Webhook, Ctx] with Product with Serializable
Get a webhook by id.
-
case class
GetWebhookWithToken[Ctx](id: SnowflakeType[Webhook], token: String, context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Webhook, Ctx] 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, Ctx] extends RESTRequest[Params, RawGuildMember, GuildMember, Ctx]
- trait GuildPrune[Ctx] extends NoNiceResponseRequest[GuildPruneData, GuildPruneResponse, Ctx]
-
case class
GuildPruneData(days: Int) extends Product with Serializable
- days
The amount of days to prune for.
-
case class
GuildPruneResponse(pruned: Int) extends Product with Serializable
- pruned
The number of members that would be removed.
-
case class
LeaveGuild[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Leave a guild.
-
case class
ListGuildEmojis[Ctx](guildId: GuildId, context: Ctx = NotUsed: NotUsed) extends RESTRequest[NotUsed, Seq[RawEmoji], Seq[Emoji], Ctx] with Product with Serializable
Get all the emojis for this guild.
-
case class
ListGuildMembers[Ctx](guildId: GuildId, params: ListGuildMembersData, context: Ctx = NotUsed: NotUsed) extends RESTRequest[ListGuildMembersData, Seq[RawGuildMember], Seq[GuildMember], Ctx] 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
ListVoiceRegions[Ctx](context: Ctx = NotUsed: NotUsed) extends NoParamsNiceResponseRequest[Seq[VoiceRegion], Ctx] with Product with Serializable
List all the voice regions that can be used when creating a guild.
-
case class
ModifyBotUsersNick[Ctx](guildId: GuildId, params: ModifyBotUsersNickData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyBotUsersNick[Ctx], ModifyBotUsersNickData, String, Ctx] with Product with Serializable
Modify the clients nickname.
- case class ModifyBotUsersNickData(nick: String) extends Product with Serializable
-
case class
ModifyChannel[Ctx](channelId: ChannelId, params: ModifyChannelData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyChannel[Ctx], ModifyChannelData, RawChannel, Option[Channel], Ctx] 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: JsonOption[String] = JsonUndefined, position: JsonOption[Int] = JsonUndefined, topic: JsonOption[String] = JsonUndefined, nsfw: JsonOption[Boolean] = JsonUndefined, rateLimitPerUser: JsonOption[Int] = JsonUndefined, bitrate: JsonOption[Int] = JsonUndefined, userLimit: JsonOption[Int] = JsonUndefined, permissionOverwrites: JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, parentId: JsonOption[ChannelId] = 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.
-
case class
ModifyGuild[Ctx](guildId: GuildId, params: ModifyGuildData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyGuild[Ctx], ModifyGuildData, RawGuild, Option[Guild], Ctx] with Product with Serializable
Modify an existing guild.
-
case class
ModifyGuildChannelPositions[Ctx](guildId: GuildId, params: Seq[ModifyGuildChannelPositionsData], context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyGuildChannelPositions[Ctx], Seq[ModifyGuildChannelPositionsData], Seq[RawChannel], Seq[Option[Channel]], Ctx] with Product with Serializable
Modify the positions of several channels.
-
case class
ModifyGuildChannelPositionsData(id: ChannelId, position: Int) extends Product with Serializable
- id
The channel id
- position
It's new position
-
case class
ModifyGuildData(name: Option[String] = None, region: Option[String] = None, verificationLevel: Option[VerificationLevel] = None, defaultMessageNotifications: Option[NotificationLevel] = None, explicitContentFilter: Option[FilterLevel] = None, afkChannelId: Option[ChannelId] = None, afkTimeout: Option[Int] = None, icon: Option[ImageData] = None, ownerId: Option[UserId] = None, splash: Option[ImageData] = None, systemChannelId: Option[ChannelId] = None) extends Product with Serializable
- name
The new name of the guild
- region
The new voice region for 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 128x128 jpeg.
- ownerId
Transfer ownership of this guild. Must be the owner.
- splash
The new splash for the guild. Must be 128x128 jpeg. VIP only.
- systemChannelId
The new channel which system messages will be sent to.
-
case class
ModifyGuildEmbed[Ctx](guildId: GuildId, params: GuildEmbed, context: Ctx = NotUsed: NotUsed) extends NoNiceResponseRequest[GuildEmbed, GuildEmbed, Ctx] with Product with Serializable
Modify a guild embed for a guild.
-
case class
ModifyGuildEmoji[Ctx](emojiId: EmojiId, guildId: GuildId, params: ModifyGuildEmojiData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyGuildEmoji[Ctx], ModifyGuildEmojiData, RawEmoji, Emoji, Ctx] with Product with Serializable
Modify an existing emoji.
-
case class
ModifyGuildEmojiData(name: String, roles: Seq[RoleId]) extends Product with Serializable
- name
The new emoji name.
- roles
Whitelist of roles that can use this emoji.
-
case class
ModifyGuildIntegration[Ctx](guildId: GuildId, integrationId: IntegrationId, params: ModifyGuildIntegrationData, context: Ctx = NotUsed: NotUsed) extends NoResponseRequest[ModifyGuildIntegrationData, Ctx] with Product with Serializable
Modify an existing integration for a guild.
-
case class
ModifyGuildIntegrationData(expireBehavior: Int, expireGracePeriod: Int, enableEmoticons: Boolean) extends Product with Serializable
- expireBehavior
The behavior of expiring subscribers.
- expireGracePeriod
The grace period before expiring subscribers.
- enableEmoticons
If emojis should be synced for this integration. (Twitch only)
-
case class
ModifyGuildMember[Ctx](guildId: GuildId, userId: UserId, params: ModifyGuildMemberData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoResponseReasonRequest[ModifyGuildMember[Ctx], ModifyGuildMemberData, Ctx] with Product with Serializable
Modify a guild member.
-
case class
ModifyGuildMemberData(nick: JsonOption[String] = JsonUndefined, roles: JsonOption[Seq[RoleId]] = JsonUndefined, mute: JsonOption[Boolean] = JsonUndefined, deaf: JsonOption[Boolean] = JsonUndefined, channelId: JsonOption[ChannelId] = 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.
- deaf
If the user should be deafened.
- channelId
The id of the channel to move the user to.
-
case class
ModifyGuildRole[Ctx](guildId: GuildId, roleId: RoleId, params: ModifyGuildRoleData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyGuildRole[Ctx], ModifyGuildRoleData, RawRole, Role, Ctx] with Product with Serializable
Modify a role.
-
case class
ModifyGuildRoleData(name: Option[String] = None, permissions: Option[Permission] = None, color: Option[Int] = None, hoist: Option[Boolean] = None, mentionable: Option[Boolean] = None) 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.
- mentionable
If this role is mentionable.
-
case class
ModifyGuildRolePositions[Ctx](guildId: GuildId, params: Seq[ModifyGuildRolePositionsData], context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends ReasonRequest[ModifyGuildRolePositions[Ctx], Seq[ModifyGuildRolePositionsData], Seq[RawRole], Seq[Role], Ctx] 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
ModifyWebhook[Ctx](id: SnowflakeType[Webhook], params: ModifyWebhookData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyWebhook[Ctx], ModifyWebhookData, Webhook, Ctx] with Product with Serializable
Modify a webhook.
-
case class
ModifyWebhookData(name: Option[String] = None, avatar: Option[ImageData] = None, channelId: Option[ChannelId] = None) 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[Ctx](id: SnowflakeType[Webhook], token: String, params: ModifyWebhookData, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoNiceResponseReasonRequest[ModifyWebhookWithToken[Ctx], ModifyWebhookData, Webhook, Ctx] 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, Ctx], Params, Response, Ctx] extends ReasonRequest[Self, Params, Response, Response, Ctx] with NoNiceResponseRequest[Params, Response, Ctx]
A request, with an audit log reason, where the response type and the nice response type are the same.
-
trait
NoNiceResponseRequest[Params, Response, Ctx] extends RESTRequest[Params, Response, Response, Ctx]
A request where the response type and the nice response type are the same.
-
trait
NoParamsNiceResponseReasonRequest[Self <: NoParamsNiceResponseReasonRequest[Self, Response, Ctx], Response, Ctx] extends NoParamsReasonRequest[Self, Response, Response, Ctx] with NoNiceResponseReasonRequest[Self, NotUsed, Response, Ctx]
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, Ctx] extends NoParamsRequest[Response, Response, Ctx] with NoNiceResponseRequest[NotUsed, Response, Ctx]
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, Ctx], RawResponse, NiceResponse, Ctx] extends ReasonRequest[Self, NotUsed, RawResponse, NiceResponse, Ctx] with NoParamsRequest[RawResponse, NiceResponse, Ctx]
A request that takes no params with an audit log reason.
-
trait
NoParamsRequest[RawResponse, NiceResponse, Ctx] extends RESTRequest[NotUsed, RawResponse, NiceResponse, Ctx]
A request that takes no params.
-
trait
NoParamsResponseReasonRequest[Self <: NoParamsResponseReasonRequest[Self, Ctx], Ctx] extends NoParamsReasonRequest[Self, NotUsed, NotUsed, Ctx] with NoResponseReasonRequest[Self, NotUsed, Ctx]
A request that has neither params nor a response with a reason.
-
trait
NoParamsResponseRequest[Ctx] extends NoParamsRequest[NotUsed, NotUsed, Ctx] with NoResponseRequest[NotUsed, Ctx]
A request that has neither params nor a response.
-
trait
NoResponseReasonRequest[Self <: NoResponseReasonRequest[Self, Params, Ctx], Params, Ctx] extends NoNiceResponseReasonRequest[Self, Params, NotUsed, Ctx] with NoResponseRequest[Params, Ctx]
A request, with an audit log reason, that doesn't have a response.
-
trait
NoResponseRequest[Params, Ctx] extends NoNiceResponseRequest[Params, NotUsed, Ctx]
A request that doesn't have a response.
-
trait
RESTRequest[Params, RawResponse, NiceResponse, Ctx] extends BaseRESTRequest[RawResponse, NiceResponse, Ctx]
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.
-
trait
ReasonRequest[Self <: ReasonRequest[Self, Params, RawResponse, NiceResponse, Ctx], Params, RawResponse, NiceResponse, Ctx] extends RESTRequest[Params, RawResponse, NiceResponse, Ctx]
A complex REST request with an audit log reason.
-
case class
RemoveGuildBan[Ctx](guildId: GuildId, userId: UserId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[RemoveGuildBan[Ctx], Ctx] with Product with Serializable
Unban a user from a guild.
-
case class
RemoveGuildMember[Ctx](guildId: GuildId, userId: UserId, context: Ctx = NotUsed: NotUsed, reason: Option[String] = None) extends NoParamsResponseReasonRequest[RemoveGuildMember[Ctx], Ctx] with Product with Serializable
Kicks a guild member.
-
case class
RemoveGuildMemberRole[Ctx](guildId: GuildId, userId: UserId, roleId: RoleId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Remove a role from a guild member.
-
case class
SyncGuildIntegration[Ctx](guildId: GuildId, integrationId: IntegrationId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Sync an integration.
-
case class
TriggerTypingIndicator[Ctx](channelId: ChannelId, context: Ctx = NotUsed: NotUsed) extends NoParamsResponseRequest[Ctx] with Product with Serializable
Triggers a typing indicator in a channel.
- case class VanityUrlResponse(code: String) extends Product with Serializable
Value Members
-
def
hasPermissionsChannel[F[_]](channelId: ChannelId, permissions: Permission)(implicit c: CacheSnapshot[F], F: Monad[F]): F[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[F[_]](guildId: GuildId, permissions: Permission)(implicit c: CacheSnapshot[F], F: Monad[F]): F[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 BulkDeleteMessages extends Serializable
- object CreateChannelInvite 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 CreateReaction extends Serializable
- object EditChannelPermissions extends Serializable
- object EditMessage extends Serializable
- object EditMessageData extends Serializable
- object GetChannelMessages extends Serializable
- object GetCurrentUserGuilds extends Serializable
- object GetGuildPruneCount extends Serializable
- object GetReactions extends Serializable
- object ListGuildMembers extends Serializable
- object ModifyBotUsersNick extends Serializable
- object ModifyChannelData extends Serializable
- object ModifyGuildEmoji extends Serializable
- object ModifyGuildMemberData extends Serializable