object APIMessage

Source
APIMessage.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. APIMessage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ChannelCreate(channel: GuildChannel, cache: CacheState) extends 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.

  2. case class ChannelDelete(channel: GuildChannel, cache: CacheState) extends 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.

  3. sealed trait ChannelMessage extends APIMessage

    Trait that covers all channel messages

  4. case class ChannelPinsUpdate(channel: TChannel, mostRecent: Option[OffsetDateTime], cache: CacheState) extends ChannelMessage with Product with Serializable

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

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

    channel

    The channel where the change happened

    mostRecent

    The time the most recent pinned message was pinned

  5. case class ChannelUpdate(channel: GuildChannel, cache: CacheState) extends 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. This will always be a guild channel

  6. case class GuildBanAdd(guild: Guild, user: User, cache: CacheState) 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.

  7. case class GuildBanRemove(guild: Guild, user: User, cache: CacheState) 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.

  8. case class GuildCreate(guild: Guild, cache: CacheState) 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

  9. case class GuildDelete(guild: Guild, unavailable: Boolean, cache: CacheState) 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

  10. case class GuildEmojiUpdate(guild: Guild, emojis: Seq[Emoji], cache: CacheState) 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.

  11. case class GuildIntegrationsUpdate(guild: Guild, cache: CacheState) 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.

  12. case class GuildMemberAdd(member: GuildMember, guild: Guild, cache: CacheState) 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

  13. case class GuildMemberRemove(user: User, guild: Guild, cache: CacheState) 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

  14. case class GuildMemberUpdate(guild: Guild, roles: Seq[Role], user: User, nick: Option[String], cache: CacheState) 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. Looking at the users ackcord.data.GuildMember for changes is pointless.

    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

  15. case class GuildMembersChunk(guild: Guild, members: Seq[GuildMember], cache: CacheState) 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.

  16. sealed trait GuildMessage extends APIMessage

    Trait that covers all guild messages.

  17. case class GuildRoleCreate(guild: Guild, role: Role, cache: CacheState) 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

  18. case class GuildRoleDelete(guild: Guild, roleId: Role, cache: CacheState) 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.

  19. case class GuildRoleUpdate(guild: Guild, role: Role, cache: CacheState) 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

  20. case class GuildUpdate(guild: Guild, cache: CacheState) 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.

  21. case class MessageCreate(message: Message, cache: CacheState) extends 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

  22. case class MessageDelete(message: Message, channel: TChannel, cache: CacheState) extends MessageMessage with ChannelMessage with Product with Serializable

    Sent to the client when a message is deleted.

    Sent to the client when a message is deleted.

    message

    The deleted message.

    channel

    The channel of the message.

  23. case class MessageDeleteBulk(messages: Seq[Message], channel: TChannel, cache: CacheState) extends ChannelMessage 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.

    messages

    The deleted messages

    channel

    The channel of the deleted messages

  24. sealed trait MessageMessage extends APIMessage

    Trait that covers all message messages.

  25. case class MessageReactionAdd(user: User, channel: TChannel, message: Message, emoji: PartialEmoji, cache: CacheState) extends MessageMessage with ChannelMessage 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.

    user

    The user that added the reaction.

    channel

    The channel of the message.

    message

    The message the user added an reaction to.

    emoji

    The emoji the user reacted with

  26. case class MessageReactionRemove(user: User, channel: TChannel, message: Message, emoji: PartialEmoji, cache: CacheState) extends MessageMessage with ChannelMessage 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.

    user

    The user that removed the reaction.

    channel

    The channel of the message.

    message

    The message the user removed an reaction from.

    emoji

    The emoji the user reacted with

  27. case class MessageReactionRemoveAll(channel: TChannel, message: Message, cache: CacheState) extends MessageMessage with ChannelMessage 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.

    channel

    The channel of the message.

    message

    The message the user removed the reactions from.

  28. case class MessageUpdate(message: Message, cache: CacheState) extends MessageMessage with Product with Serializable

    Sent to the client when a message is updated.

    Sent to the client when a message is updated.

    message

    The new message. The check changes, the old message can be found in cache.previous.

  29. case class PresenceUpdate(guild: Guild, user: User, roleIds: Seq[RoleId], presence: Presence, cache: CacheState) 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

    roleIds

    The roles of the user

    presence

    The new presence

  30. case class Ready(cache: CacheState) 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.

  31. case class Resumed(cache: CacheState) extends APIMessage with Product with Serializable

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

  32. case class TypingStart(channel: TChannel, user: User, timestamp: Instant, cache: CacheState) extends ChannelMessage 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

    channel

    The channel where the typing happened

    user

    The user that began typing

    timestamp

    When user started typing

  33. case class UserUpdate(user: User, cache: CacheState) 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.

  34. case class VoiceServerUpdate(token: String, guild: Guild, endpoint: String, cache: CacheState) 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

  35. case class VoiceStateUpdate(voiceState: VoiceState, cache: CacheState) 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

  36. case class WebhookUpdate(guild: Guild, channel: GuildChannel, cache: CacheState) 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped