GatewayEvent

Type Members

1. case class ChannelCreate(data: Later[Result[RawChannel]]) extends OptGuildEvent[RawChannel] with ChannelEvent[RawChannel] with Product with Serializable

   

   Sent to the shard when a new channel is created.

   Sent to the shard when a new channel is created.

   data

   The channel that was created.

2. case class ChannelDelete(data: Later[Result[RawChannel]]) extends OptGuildEvent[RawChannel] with ChannelEvent[RawChannel] with Product with Serializable

   

   Sent to the shard when a channel is deleted.

   Sent to the shard when a channel is deleted. The current snapshot will not contain the channel.

   data

   The channel that was deleted.

3. sealed trait ChannelEvent[D] extends SimpleGatewayEvent[D]

   

   Base trait for an event that includes a channel.

4. case class ChannelPinsUpdate(data: Later[Result[ChannelPinsUpdateData]]) extends ChannelEvent[ChannelPinsUpdateData] with Product with Serializable

   

   Sent to the shard when a message is pinned or unpinned in a text channel.

   Sent to the shard when a message is pinned or unpinned in a text channel. This is not sent when a pinned message is deleted.

5. case class ChannelPinsUpdateData(channelId: ChannelId, timestamp: JsonOption[OffsetDateTime]) extends Product with Serializable

   
   channelId

   The channel where the change happened.

   timestamp

   The time the most recent pinned message was pinned.

6. case class ChannelUpdate(data: Later[Result[RawChannel]]) extends OptGuildEvent[RawChannel] with ChannelEvent[RawChannel] with Product with Serializable

   

   Sent to the shard when a channel is edited or updated.

   Sent to the shard when a channel is edited or updated.

   data

   The channel that was edited. This will always be a guild channel.

7. sealed trait ComplexGuildEvent[D, HandlerType] extends ComplexGatewayEvent[D, HandlerType]

   

   Base trait for all complex events that include an optional guild.

8. case class GuildBanAdd(data: Later[Result[UserWithGuildId]]) extends ComplexGuildEvent[UserWithGuildId, (GuildId, RawBan)] with Product with Serializable

   

   Sent to the shard when an user is banned from a guild.

   Sent to the shard when an user is banned from a guild.

   data

   The banned user with a guildId of what guild the user was banned from.

9. case class GuildBanRemove(data: Later[Result[UserWithGuildId]]) extends ComplexGuildEvent[UserWithGuildId, (GuildId, User)] with Product with Serializable

   

   Sent to the shard when an user is unbanned from a guild.

   Sent to the shard when an user is unbanned from a guild.

   data

   The unbanned user with a guildId of what guild the user was unbanned from.

10. case class GuildCreate(data: Later[Result[RawGuild]]) extends GuildEvent[RawGuild] with Product with Serializable

    

    Sent to the shard after the shard connects to the gateway, when a previously unavailable guild becomes available, and when the client joins a new guild.

    Sent to the shard after the shard connects to the gateway, when a previously unavailable guild becomes available, and when the client joins a new guild.

    data

    The created guild object.

11. case class GuildDelete(data: Later[Result[UnavailableGuild]]) extends GuildEvent[UnavailableGuild] with Product with Serializable

    

    Sent to the shard either if a guild becomes unavailable due to and outage, or if the client leaves or is kicked from a guild.

    Sent to the shard either if a guild becomes unavailable due to and outage, or if the client leaves or is kicked from a guild.

    data

    The deleted or unavailable guild.

12. case class GuildEmojisUpdate(data: Later[Result[GuildEmojisUpdateData]]) extends GuildEvent[GuildEmojisUpdateData] with Product with Serializable

    

    Sent to the shard when the emojis of a guild have been updated.

13. case class GuildEmojisUpdateData(guildId: GuildId, emojis: Seq[RawEmoji]) extends Product with Serializable

    
    guildId

    The guild where the update occoured.

    emojis

    The new emojis.

14. sealed trait GuildEvent[D] extends SimpleGatewayEvent[D]

    

    Base trait for all simple events that include an optional guild.

15. case class GuildIntegrationsUpdate(data: Later[Result[GuildIntegrationsUpdateData]]) extends GuildEvent[GuildIntegrationsUpdateData] with Product with Serializable

    

    Sent to the shard when the integrations of a guild were updated.

    Sent to the shard when the integrations of a guild were updated. You have to fetch the integrations yourself.

16. case class GuildIntegrationsUpdateData(guildId: GuildId) extends Product with Serializable

    
    guildId

    The guild where the update occurred.

17. case class GuildMemberAdd(data: Later[Result[RawGuildMemberWithGuild]]) extends GuildEvent[RawGuildMemberWithGuild] with Product with Serializable

    

    Sent to the shard when a user joins the guild.

    Sent to the shard when a user joins the guild.

    data

    The new guild member, includes a guild id.

18. case class GuildMemberChunk(data: Later[Result[GuildMemberChunkData]]) extends GuildEvent[GuildMemberChunkData] with Product with Serializable

    

    Sent to the shard if the shard requests to get all members (even offline ones) for large guilds using RequestGuildMembers.

19. case class GuildMemberChunkData(guildId: GuildId, members: Seq[RawGuildMember]) extends Product with Serializable

    
    guildId

    The guild requested for.

    members

    The guild members in this chunk.

20. case class GuildMemberRemove(data: Later[Result[GuildMemberRemoveData]]) extends GuildEvent[GuildMemberRemoveData] with Product with Serializable

    

    Sent to the shard when a user leaves the guild (or is kicked or banned).

21. case class GuildMemberRemoveData(guildId: GuildId, user: User) extends Product with Serializable

    
    guildId

    The guild the user left from.

    user

    The user that left.

22. case class GuildMemberUpdate(data: Later[Result[GuildMemberUpdateData]]) extends GuildEvent[GuildMemberUpdateData] with Product with Serializable

    

    Sent to the shard when a guild member is updated.

23. case class GuildMemberUpdateData(guildId: GuildId, roles: Seq[RoleId], user: User, nick: Option[String]) extends Product with Serializable

    

    The fields seen here are all the fields that can change.

    The fields seen here are all the fields that can change. Looking at the users ackcord.data.raw.RawGuildMember for changes is pointless.

    guildId

    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.

24. case class GuildRoleCreate(data: Later[Result[GuildRoleModifyData]]) extends GuildEvent[GuildRoleModifyData] with Product with Serializable

    

    Sent to the shard when a new role is created.

25. case class GuildRoleDelete(data: Later[Result[GuildRoleDeleteData]]) extends GuildEvent[GuildRoleDeleteData] with Product with Serializable

    

    Sent to the shard when a role is deleted.

26. case class GuildRoleDeleteData(guildId: GuildId, roleId: RoleId) extends Product with Serializable

    
    guildId

    The guild of the deleted role.

    roleId

    The deleted role.

27. case class GuildRoleModifyData(guildId: GuildId, role: RawRole) extends Product with Serializable

    
    guildId

    The guild of the modified role.

    role

    The modified role.

28. case class GuildRoleUpdate(data: Later[Result[GuildRoleModifyData]]) extends GuildEvent[GuildRoleModifyData] with Product with Serializable

    

    Sent to the shard when a role is updated.

29. case class GuildUpdate(data: Later[Result[RawGuild]]) extends GuildEvent[RawGuild] with Product with Serializable

    

    Sent to the shard when a guild object is updated.

    Sent to the shard when a guild object is updated.

    data

    The updated guild.

30. case class MessageCreate(data: Later[Result[RawMessage]]) extends ChannelEvent[RawMessage] with Product with Serializable

    

    Sent to the shard when a message is created (posted).

    Sent to the shard when a message is created (posted).

    data

    The sent message.

31. case class MessageDelete(data: Later[Result[MessageDeleteData]]) extends ChannelEvent[MessageDeleteData] with OptGuildEvent[MessageDeleteData] with Product with Serializable

    

    Sent to the shard when a message is deleted.

32. case class MessageDeleteBulk(data: Later[Result[MessageDeleteBulkData]]) extends ChannelEvent[MessageDeleteBulkData] with OptGuildEvent[MessageDeleteBulkData] with Product with Serializable

    

    Sent to the shard when multiple messages are deleted at the same time.

    Sent to the shard when multiple messages are deleted at the same time. Often this is performed by a bot.

33. case class MessageDeleteBulkData(ids: Seq[MessageId], channelId: ChannelId, guildId: Option[GuildId]) extends Product with Serializable

    
    ids

    The deleted messages.

    channelId

    The channel of the deleted messages.

    guildId

    The guild this was done in. Can be missing.

34. case class MessageDeleteData(id: MessageId, channelId: ChannelId, guildId: Option[GuildId]) extends Product with Serializable

    
    id

    The deleted message.

    channelId

    The channel of the message.

    guildId

    The guild this was done in. Can be missing.

35. case class MessageReactionAdd(data: Later[Result[MessageReactionData]]) extends ChannelEvent[MessageReactionData] with OptGuildEvent[MessageReactionData] with Product with Serializable

    

    Sent to the shard when a user adds a reaction to a message.

36. case class MessageReactionData(userId: UserId, channelId: ChannelId, messageId: MessageId, guildId: Option[GuildId], emoji: PartialEmoji) extends Product with Serializable

    
    userId

    The user that caused the reaction change.

    channelId

    The channel of the message.

    messageId

    The message the reaction belonged to.

    guildId

    The guild this was done in. Can be missing.

    emoji

    The emoji the user reacted with.

37. case class MessageReactionRemove(data: Later[Result[MessageReactionData]]) extends ChannelEvent[MessageReactionData] with OptGuildEvent[MessageReactionData] with Product with Serializable

    

    Sent to the shard when a user removes a reaction from a message.

38. case class MessageReactionRemoveAll(data: Later[Result[MessageReactionRemoveAllData]]) extends ChannelEvent[MessageReactionRemoveAllData] with OptGuildEvent[MessageReactionRemoveAllData] with Product with Serializable

    

    Sent to the shard when a user removes all reactions from a message.

39. case class MessageReactionRemoveAllData(channelId: ChannelId, messageId: MessageId, guildId: Option[GuildId]) extends Product with Serializable

    
    channelId

    The channel of the message.

    messageId

    The message the user removed the reactions from.

    guildId

    The guild this was done in. Can be missing.

40. case class MessageUpdate(data: Later[Result[RawPartialMessage]]) extends ChannelEvent[RawPartialMessage] with Product with Serializable

    

    Sent to the shard when a message is updated.

    Sent to the shard when a message is updated.

    data

    The new message.

41. sealed trait OptGuildEvent[D] extends SimpleGatewayEvent[D]

    

    Base trait for all events that include an optional guild.

42. case class PresenceUpdate(data: Later[Result[PresenceUpdateData]]) extends GuildEvent[PresenceUpdateData] with Product with Serializable

    

    Sent to the shard when the presence of a user updates.

43. case class PresenceUpdateData(user: PartialUser, roles: Seq[RoleId], game: Option[RawActivity], guildId: GuildId, status: PresenceStatus, activities: Seq[RawActivity], clientStatus: ClientStatus) extends Product with Serializable

    
    user

    The user of the presence.

    roles

    The roles of the user.

    game

    The new presence message.

    guildId

    The guild where the update took place.

    status

    The new status.

    activities

    The current activites of the user.

44. case class RawGuildMemberWithGuild(guildId: GuildId, user: User, nick: Option[String], roles: Seq[RoleId], joinedAt: OffsetDateTime, deaf: Boolean, mute: Boolean) extends Product with Serializable

    

45. case class RawPartialMessage(id: MessageId, channelId: ChannelId, author: JsonOption[Author[_]], content: JsonOption[String], timestamp: JsonOption[OffsetDateTime], editedTimestamp: JsonOption[OffsetDateTime], tts: JsonOption[Boolean], mentionEveryone: JsonOption[Boolean], mentions: JsonOption[Seq[User]], mentionRoles: JsonOption[Seq[RoleId]], attachment: JsonOption[Seq[Attachment]], embeds: JsonOption[Seq[ReceivedEmbed]], reactions: JsonOption[Seq[Reaction]], nonce: JsonOption[RawSnowflake], pinned: JsonOption[Boolean], webhookId: JsonOption[String]) extends Product with Serializable

    

46. case class Ready(data: Later[Result[ReadyData]]) extends SimpleGatewayEvent[ReadyData] with Product with Serializable

    

    Sent to the shard when Discord is ready to serve requests.

    Sent to the shard when Discord is ready to serve requests. No requests should be sent before this has been received.

47. case class ReadyData(v: Int, user: User, guilds: Seq[UnavailableGuild], sessionId: String, _trace: Seq[String], shard: Seq[Int]) extends Product with Serializable

    
    v

    The API version used.

    user

    The client user.

    guilds

    The guilds for this shard. Not available at first.

    sessionId

    The session id.

    shard

    The shard info, the first index is the shard id, while the second is the total amount of shards.

48. case class Resumed(data: Later[Result[ResumedData]]) extends SimpleGatewayEvent[ResumedData] with Product with Serializable

    

    Sent to the shard when a previously interrupted connection is resumed.

49. case class ResumedData(_trace: Seq[String]) extends Product with Serializable

    

50. case class TypingStart(data: Later[Result[TypingStartData]]) extends ChannelEvent[TypingStartData] with Product with Serializable

    

    Sent to the shard when a user starts typing in a channel.

51. case class TypingStartData(channelId: ChannelId, guildId: Option[GuildId], userId: UserId, timestamp: Instant) extends Product with Serializable

    
    channelId

    The channel where the typing happened.

    guildId

    The guild id of where the typing happened.

    userId

    The user that began typing.

    timestamp

    When user started typing.

52. case class UserUpdate(data: Later[Result[User]]) extends SimpleGatewayEvent[User] with Product with Serializable

    

    Sent to the shard when a user object is updated.

    Sent to the shard when a user object is updated.

    data

    The new user.

53. case class UserWithGuildId(guildId: GuildId, user: User) extends Product with Serializable

    

54. case class VoiceServerUpdate(data: Later[Result[VoiceServerUpdateData]]) extends GuildEvent[VoiceServerUpdateData] 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.

55. case class VoiceStateUpdate(data: Later[Result[VoiceState]]) extends OptGuildEvent[VoiceState] with Product with Serializable

    

    Sent to the shard when a user joins/leaves/moves voice channels.

    Sent to the shard when a user joins/leaves/moves voice channels.

    data

    New voice states.

56. case class WebhookUpdate(data: Later[Result[WebhookUpdateData]]) extends GuildEvent[WebhookUpdateData] with Product with Serializable

    

    Sent to the shard when guilds webhooks are updated.

57. case class WebhookUpdateData(guildId: GuildId, channelId: ChannelId) extends Product with Serializable

    
    guildId

    The guild of the updated webhook.

    channelId

    The channel for the webhook.