object APIMessage
- Source
- APIMessage.scala
- Alphabetic
- By Inheritance
- APIMessage
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class ChannelCreate(guild: Option[GatewayGuild], channel: GuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with ChannelMessage with Product with Serializable
Sent to the client when a new channel is created.
Sent to the client when a new channel is created.
- channel
The channel that was created.
- case class ChannelDelete(guild: Option[GatewayGuild], channel: GuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with ChannelMessage with Product with Serializable
Sent to the client when a channel is deleted.
Sent to the client when a channel is deleted. The current snapshot will not contain the channel.
- channel
The channel that was deleted.
- sealed trait ChannelMessage extends APIMessage
Trait that covers all channel messages
- case class ChannelPinsUpdate(guild: Option[GatewayGuild], channelId: TextChannelId, mostRecent: Option[OffsetDateTime], cache: CacheState, gatewayInfo: GatewayInfo) extends TextChannelIdMessage with Product with Serializable
Sent to the client when a message is pinned or unpinned in a text channel where guild information is not available.
Sent to the client when a message is pinned or unpinned in a text channel where guild information is not available. This is not sent when a pinned message is deleted.
- guild
The guild where the change happened
- channelId
The channel where the change happened
- mostRecent
The time the most recent pinned message was pinned
- case class ChannelUpdate(guild: Option[GatewayGuild], channel: Channel, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with ChannelMessage with Product with Serializable
Sent to the client when a channel is edited or updated.
Sent to the client when a channel is edited or updated.
- channel
The channel that was edited.
- case class ClientAddedToThread(guild: GatewayGuild, channel: ThreadGuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Sent to the client is added to a thread.
Sent to the client is added to a thread.
- channel
The thread that the client was added to.
- case class GuildBanAdd(guild: GatewayGuild, user: User, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when an user is banned from a guild.
Sent to the client when an user is banned from a guild. If you need the ackcord.data.GuildMember object of the user, you can find it in cache.previous.
- guild
The guild the user was banned from.
- user
The banned user.
- case class GuildBanRemove(guild: GatewayGuild, user: User, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when an user is unbanned from a guild.
Sent to the client when an user is unbanned from a guild.
- guild
The guild where the user was previously banned.
- user
The previously banned user.
- case class GuildCreate(guild: GatewayGuild, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client after the client connects to the gateway, when a previously unavailable guild becomes available, and when the client joins a new guild.
Sent to the client after the client connects to the gateway, when a previously unavailable guild becomes available, and when the client joins a new guild.
- guild
The created guild object
- case class GuildDelete(guild: GatewayGuild, unavailable: Option[Boolean], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client either if a guild becomes unavailable due to and outage, or if the client leaves or is kicked from a guild.
Sent to the client either if a guild becomes unavailable due to and outage, or if the client leaves or is kicked from a guild.
- guild
The deleted guild
- unavailable
If an outage caused this event
- case class GuildEmojiUpdate(guild: GatewayGuild, emojis: Seq[Emoji], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when the emojis of a guild have been updated.
Sent to the client when the emojis of a guild have been updated. If you need the old emojis, you can find them in cache.previous.
- guild
The guild where the update occurred.
- emojis
The new emojis.
- case class GuildIntegrationsUpdate(guild: GatewayGuild, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when the integrations of a guild were updated.
Sent to the client when the integrations of a guild were updated. You have to fetch the integrations yourself.
- guild
The guild where the update occurred.
- case class GuildMemberAdd(member: GuildMember, guild: GatewayGuild, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a user joins the guild.
Sent to the client when a user joins the guild.
- member
The new member
- guild
The joined guild
- case class GuildMemberRemove(user: User, guild: GatewayGuild, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a user leaves the guild (or is kicked or banned).
Sent to the client when a user leaves the guild (or is kicked or banned). If you need the ackcord.data.GuildMember, you can find it in cache.previous.
- user
The user that left
- guild
The guild the user left
- case class GuildMemberUpdate(guild: GatewayGuild, roles: Seq[Role], user: User, nick: Option[String], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Boolean, communicationDisabledUntil: Option[OffsetDateTime], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a guild member is updated.
Sent to the client when a guild member is updated. The fields seen here are all the fields that can change.
- guild
The guild of the guild member.
- roles
Thew new roles for the guild member.
- user
The user of the updated guild member.
- nick
Nick of the user if one was set.
- joinedAt
When the user joined the guild.
- premiumSince
When the user started boosting the guild.
- deaf
If the user is deafened in the guild.
- mute
If the user is muted in the guild.
- pending
If the user has not yet passed the guild's membership screening.
- case class GuildMembersChunk(guild: GatewayGuild, members: Seq[GuildMember], chunkIndex: Int, chunkCount: Int, notFound: Option[Seq[UserId]], nonce: Option[String], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client if the client requests to get all members (even offline ones) for large guilds using ackcord.gateway.RequestGuildMembers.
Sent to the client if the client requests to get all members (even offline ones) for large guilds using ackcord.gateway.RequestGuildMembers.
- guild
The guild requested for.
- members
The guild members in this chunk.
- sealed trait GuildMessage extends APIMessage
Trait that covers all guild messages.
- case class GuildRoleCreate(guild: GatewayGuild, role: Role, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a new role is created.
Sent to the client when a new role is created.
- guild
The guild of the new role
- role
The new role
- case class GuildRoleDelete(guild: GatewayGuild, roleId: Role, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a role is deleted
Sent to the client when a role is deleted
- guild
The guild of the deleted role
- roleId
The deleted role.
- case class GuildRoleUpdate(guild: GatewayGuild, role: Role, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a role is updated.
Sent to the client when a role is updated.
- guild
The guild of the updated role
- role
The updated role
- case class GuildScheduledEventCreate(guild: GatewayGuild, scheduledEvent: GuildScheduledEvent, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a guild scheduled event has been created.
Sent to the client when a guild scheduled event has been created.
- guild
The guild of the scheduled event.
- scheduledEvent
The scheduled event itself.
- case class GuildScheduledEventDelete(guild: GatewayGuild, scheduledEvent: GuildScheduledEvent, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a guild scheduled event has been deleted.
Sent to the client when a guild scheduled event has been deleted.
- guild
The guild of the scheduled event.
- scheduledEvent
The scheduled event itself.
- case class GuildScheduledEventUpdate(guild: GatewayGuild, scheduledEvent: GuildScheduledEvent, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a guild scheduled event has been updated.
Sent to the client when a guild scheduled event has been updated.
- guild
The guild of the scheduled event.
- scheduledEvent
The scheduled event itself.
- case class GuildStickerUpdate(guild: GatewayGuild, stickers: Seq[Sticker], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when the stickers of a guild have been updated.
Sent to the client when the stickers of a guild have been updated. If you need the old stickers, you can find them in cache.previous.
- guild
The guild where the update occurred.
- stickers
The new stickers.
- case class GuildUpdate(guild: GatewayGuild, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when the guild object is updated.
Sent to the client when the guild object is updated.
- guild
The updated guild.
- case class IntegrationCreate(guild: GatewayGuild, integration: Integration, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an integration is created.
- case class IntegrationDelete(guild: GatewayGuild, id: IntegrationId, applicationId: Option[ApplicationId], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an integration is deleted.
Sent when an integration is deleted.
- applicationId
Id of the bot/OAuth2 application for the integration.
- case class IntegrationUpdate(guild: GatewayGuild, integration: Integration, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an integration is updated.
- case class InteractionCreate(rawInteraction: RawInteraction, cache: CacheState, gatewayInfo: GatewayInfo) extends APIMessage with OptGuildMessage with Product with Serializable
- case class InviteCreate(guild: Option[GatewayGuild], channel: TextChannel, invite: CreatedInvite, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with ChannelMessage with Product with Serializable
Sent when an invite is created.
Sent when an invite is created.
- guild
The guild the invite is for.
- channel
The channel the invite directs to.
- case class InviteDelete(guild: Option[GatewayGuild], channel: TextChannel, code: String, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with ChannelMessage with Product with Serializable
Sent when an invite is deleted.
Sent when an invite is deleted.
- guild
The guild the invite was for.
- channel
The channel the invite directed to.
- case class MessageCreate(guild: Option[GatewayGuild], message: Message, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with MessageMessage with Product with Serializable
Sent to the client when a message is created (posted).
Sent to the client when a message is created (posted).
- message
The sent message
- case class MessageDelete(messageId: MessageId, guild: Option[GatewayGuild], channelId: TextChannelId, cache: CacheState, gatewayInfo: GatewayInfo) extends MessageIdMessage with TextChannelIdMessage with Product with Serializable
Sent to the client when a message is deleted.
Sent to the client when a message is deleted.
- messageId
The deleted message.
- channelId
The channel of the message.
- case class MessageDeleteBulk(messageIds: Seq[MessageId], guild: Option[GatewayGuild], channelId: TextChannelId, cache: CacheState, gatewayInfo: GatewayInfo) extends TextChannelIdMessage with Product with Serializable
Sent to the client when multiple messages are deleted at the same time.
Sent to the client when multiple messages are deleted at the same time. Often this is performed by a bot.
- messageIds
The deleted messages
- channelId
The channel of the deleted messages
- sealed trait MessageIdMessage extends TextChannelIdMessage
Trait that covers all message id messages
- sealed trait MessageMessage extends APIMessage
Trait that covers all message messages.
- case class MessageReactionAdd(userId: UserId, guild: Option[GatewayGuild], channelId: TextChannelId, messageId: MessageId, emoji: PartialEmoji, user: Option[User], member: Option[GuildMember], cache: CacheState, gatewayInfo: GatewayInfo) extends MessageIdMessage with TextChannelIdMessage with Product with Serializable
Sent to the client when a user adds a reaction to a message.
Sent to the client when a user adds a reaction to a message.
- userId
The id of the user that added the reaction.
- guild
The guild the message was sent in.
- channelId
The channel the message was sent in.
- messageId
The id of the message the user added an reaction to.
- emoji
The emoji the user reacted with.
- user
The user that added the reaction.
- member
The guild member that added the reaction.
- case class MessageReactionRemove(userId: UserId, guild: Option[GatewayGuild], channelId: TextChannelId, messageId: MessageId, emoji: PartialEmoji, user: Option[User], member: Option[GuildMember], cache: CacheState, gatewayInfo: GatewayInfo) extends MessageIdMessage with TextChannelIdMessage with Product with Serializable
Sent to the client when a user removes a reaction from a message.
Sent to the client when a user removes a reaction from a message.
- userId
The id of the user that added the reaction.
- guild
The guild the message was sent in.
- channelId
The channel the message was sent in.
- messageId
The id of the message the user added an reaction to.
- emoji
The emoji the user removed.
- user
The user that added the reaction.
- member
The guild member that added the reaction.
- case class MessageReactionRemoveAll(guild: Option[GatewayGuild], channelId: TextChannelId, messageId: MessageId, cache: CacheState, gatewayInfo: GatewayInfo) extends MessageIdMessage with TextChannelIdMessage with Product with Serializable
Sent to the client when a user removes all reactions from a message.
Sent to the client when a user removes all reactions from a message. The emojis of the message can be found in cache.previous.
- guild
The guild of the message.
- channelId
The id of the channel the message was sent it.
- messageId
The id of the message the user removed the reactions from.
- case class MessageReactionRemoveEmoji(guild: Option[GatewayGuild], channelId: TextChannelId, messageId: MessageId, emoji: PartialEmoji, cache: CacheState, gatewayInfo: GatewayInfo) extends MessageIdMessage with TextChannelIdMessage with Product with Serializable
Sent to the client when a user removes all reactions of a specific emoji from a message.
Sent to the client when a user removes all reactions of a specific emoji from a message.
- guild
The guild of the message.
- channelId
The id of the channel the message was sent it.
- messageId
The id of the message the user removed the reactions from.
- emoji
The removed emoji.
- case class MessageUpdate(guild: Option[GatewayGuild], messageId: MessageId, channelId: TextChannelId, cache: CacheState, gatewayInfo: GatewayInfo) extends OptGuildMessage with MessageIdMessage with Product with Serializable
Sent to the client when a message is updated.
Sent to the client when a message is updated.
- messageId
The id of the message that changed.
- sealed trait OptGuildMessage extends APIMessage
A trait that covers all messages that might have an guild associated with them
- case class PresenceUpdate(guild: GatewayGuild, user: User, presence: Presence, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when the presence of a user updates.
Sent to the client when the presence of a user updates.
- guild
The guild where the update took place
- user
The user of the presence
- presence
The new presence
- case class Ready(applicationId: ApplicationId, cache: CacheState, gatewayInfo: GatewayInfo) extends APIMessage with Product with Serializable
Sent to the client when Discord is ready to serve requests.
Sent to the client when Discord is ready to serve requests. No requests should be sent before this has been received.
- case class Resumed(cache: CacheState, gatewayInfo: GatewayInfo) extends APIMessage with Product with Serializable
Sent to the client when a previously interrupted connection is resumed.
- case class StageInstanceCreate(guild: GatewayGuild, stageInstance: StageInstance, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an stage instance is created.
- case class StageInstanceDelete(guild: GatewayGuild, stageInstance: StageInstance, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an stage instance is created.
- case class StageInstanceUpdate(guild: GatewayGuild, stageInstance: StageInstance, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when an stage instance is deleted.
- sealed trait TextChannelIdMessage extends OptGuildMessage
Trait that covers all channel id messages
- case class ThreadCreate(guild: GatewayGuild, channel: ThreadGuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Sent to the client when a new thread is created.
Sent to the client when a new thread is created.
- channel
The thread that was created.
- case class ThreadDelete(guild: GatewayGuild, threadId: ThreadGuildChannelId, parentId: TextGuildChannelId, tpe: ChannelType, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent to the client when a thread is deleted.
Sent to the client when a thread is deleted. The current snapshot will not contain the channel.
- threadId
The id of the thread that was deleted.
- case class ThreadListSync(guild: GatewayGuild, updatedChannelsIds: Seq[TextGuildChannelId], threads: Seq[ThreadGuildChannel], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent when the client gains access to a channel.
Sent when the client gains access to a channel.
- updatedChannelsIds
The ids of the channels where threads were updated.
- threads
The new updated threads.
- case class ThreadMemberUpdate(guild: GatewayGuild, channel: ThreadGuildChannel, member: ThreadMember, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Sent when the thread member object for the current user is updated.
Sent when the thread member object for the current user is updated.
- channel
The channel where the update took place.
- member
An updated thread member for the current user.
- case class ThreadMembersUpdate(guild: GatewayGuild, channel: ThreadGuildChannel, addedMembers: Seq[ThreadMember], removedMembers: Seq[UserId], cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Send when anyone is added or removed from a thread.
Send when anyone is added or removed from a thread. If the current user does not have the
GUILD_MEMBERSintent, then this will only be sent for the current user.- channel
The channel that had users added or removed.
- addedMembers
The members that were added to the channel.
- removedMembers
The members that were removed from the channel.
- case class ThreadUpdate(guild: GatewayGuild, channel: ThreadGuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Sent to the client when a thread is edited or updated.
Sent to the client when a thread is edited or updated.
- channel
The thread that was edited.
- case class TypingStart(guild: Option[GatewayGuild], channelId: TextChannelId, userId: UserId, timestamp: Instant, user: Option[User], member: Option[GuildMember], cache: CacheState, gatewayInfo: GatewayInfo) extends TextChannelIdMessage with Product with Serializable
Sent to the client when a user starts typing in a channel
Sent to the client when a user starts typing in a channel
- guild
The guild where the typing happened
- channelId
The id of the channel where the typing happened
- userId
The id of the user that began typing
- timestamp
When user started typing
- user
The user that began typing
- member
The member that began typing
- case class UserUpdate(user: User, cache: CacheState, gatewayInfo: GatewayInfo) extends APIMessage with Product with Serializable
Sent to the client when a user object is updated.
Sent to the client when a user object is updated.
- user
The new user.
- case class VoiceServerUpdate(token: String, guild: GatewayGuild, endpoint: String, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with Product with Serializable
Sent a guilds voice server is updated.
Sent a guilds voice server is updated. Also used when connecting to a voice channel.
- token
The voice connection token
- guild
The guild of the update
- endpoint
The voice server
- case class VoiceStateUpdate(voiceState: VoiceState, cache: CacheState, gatewayInfo: GatewayInfo) extends APIMessage with Product with Serializable
Sent to the client when a user joins/leaves/moves voice channels
Sent to the client when a user joins/leaves/moves voice channels
- voiceState
New voice states
- case class WebhookUpdate(guild: GatewayGuild, channel: GuildChannel, cache: CacheState, gatewayInfo: GatewayInfo) extends GuildMessage with ChannelMessage with Product with Serializable
Sent to the client when guilds webhooks are updated.
Sent to the client when guilds webhooks are updated.
- guild
The guild of the updated webhook
- channel
The channel for the webhook
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])