Crux

v2020-03-17 17:55:51Z

Crux v2020-03-17 17:55:51Z Crux.Base.Processor View Source

Module processing gateway packets into event/0s making necessary cache lookups / insertions.

Link to this section Summary

Types

channel_create_event()

Emitted whenever a channel was created.

channel_delete_event()

Emitted whenever a channel was deleted.

channel_id()

The id of a channel.

channel_pins_update_event()

Emitted whenever a message was pinned or unpinned.

channel_update_event()

Emitted whenever a channel was updated.

event()

Union type of all available events.

guild_ban_add_event()

Emitted whenever a user was banned from a guild.

guild_ban_remove_event()

Emitted whenever a user was unbanned from a guild.

guild_create_event()

Emitted whenever the client joined a guild.

guild_delete_event()

Emitted whenever the client left a guild or a guild became unavailable.

guild_emojis_update_event()

Emitted whenever a guild's emojis updated.

guild_id()

The id of a guild.

guild_integrations_update_event()

Emitted whenever one of a guild's integration was updated.

guild_member_add_event()

Emitted whenever a user joined a guild.

guild_member_remove_event()

Emitted whenever a user left a guild.
This includes kicks and bans.

guild_member_update_event()

Emitted whenever a guild member was updated.

guild_members_chunk_event()

Emitted whenever a chunk of guild members was received.

guild_role_create_event()

Emitted whenever a role was created.

guild_role_delete_event()

Emitted whenever a role was deleted.

guild_role_update_event()

Emitted whenever a role was updated.

guild_update_event()

Emitted whenever a guild updated.

message_create_event()

Emitted whenever a message was created. (Sent to a channel)

message_delete_bulk_event()

Emitted whenever a bulk of messages was deleted.

message_delete_event()

Emitted whenever a channel was deleted.

message_id()

The id of a message.

message_reaction_add_event()

Emitted whenever a reaction was added to a message.

message_reaction_remove_all_event()

Emitted whenever a user explicitly removed all reactions from a message.

message_reaction_remove_event()

Emitted whenever a reaction was removed from a message.

message_update_event()

Emitted whenever a message was updated.

presence_update_event()

Emitted whenever a user's presence or any of the user's properties updated.

ready_event()

Emitted when a gateway connection completed the initial handshake with the gateway.
The guilds are not yet sent, those are partial unavailable guilds!

resumed_event()

Emitted whenever a gateway connection resumed after unexpectedly disconnecting.

role_id()

The id of a role.

shard_id()

The id of a shard.

snowflake()

A discord snowflake.
See t:Crux.Rest.Snowflake/0 for more information.

typing_start_event()

Emitted whenever a user started typing in a channel.

user_id()

The id of a user.

user_update_event()

Emitted whenever properties about the current user changed.

voice_server_update_event()

Emitted whenever guild's voice server was updated.

voice_state_update_event()

Emitted whenever the voice state of a member changed.

webhooks_update_event()

Emitted whenever a channel's webhook was created, updated, or deleted.

Functions

process_event(guild_event, data, shard_id, cache_provider)

Processes the type (t value of a packet) along its data (d portion of a packet).
This will do necessary transformation, cache lookups, and cache insertions.

Link to this section Types

Link to this type

channel_create_event() View Source 
channel_create_event() ::
  {:CHANNEL_CREATE, Crux.Structs.Channel.t(), shard_id()}

Emitted whenever a channel was created.

For more information see Discord Docs.

Link to this type

channel_delete_event() View Source 
channel_delete_event() ::
  {:CHANNEL_DELETE, Crux.Structs.Channel.t(), shard_id()}

Emitted whenever a channel was deleted.

For more information see Discord Docs.

Link to this type

channel_id() View Source 
channel_id() :: snowflake()

The id of a channel.

Link to this type

channel_pins_update_event() View Source 
channel_pins_update_event() ::
  {:CHANNEL_PINS_UPDATE, {Crux.Structs.Channel.t() | channel_id(), String.t()},
   shard_id()}

Emitted whenever a message was pinned or unpinned.

Emits the channel id if the channel was uncached.

> The second element of the tuple is the timestamp of when the last pinned message was pinned.
> The timestamp will be the Unix Epoch if last pinned message was removed.

For more information see Discord Docs.

Link to this type

channel_update_event() View Source 
channel_update_event() ::
  {:CHANNEL_UPDATE, {Crux.Structs.Channel.t() | nil, Crux.Structs.Channel.t()},
   shard_id()}

Emitted whenever a channel was updated.

Emits nil if the channel was uncached previously.

For more information see Discord Docs.

Link to this type

event() View Source 
event() ::
  ready_event()
  | resumed_event()
  | channel_create_event()
  | channel_update_event()
  | channel_update_event()
  | channel_delete_event()
  | channel_pins_update_event()
  | guild_create_event()
  | guild_update_event()
  | guild_delete_event()
  | guild_ban_add_event()
  | guild_ban_remove_event()
  | guild_emojis_update_event()
  | guild_integrations_update_event()
  | guild_member_add_event()
  | guild_member_remove_event()
  | guild_member_update_event()
  | guild_members_chunk_event()
  | guild_role_create_event()
  | guild_role_update_event()
  | guild_role_delete_event()
  | message_create_event()
  | message_update_event()
  | message_delete_event()
  | message_delete_bulk_event()
  | message_reaction_add_event()
  | message_reaction_remove_event()
  | message_reaction_remove_all_event()
  | presence_update_event()
  | typing_start_event()
  | user_update_event()
  | voice_state_update_event()
  | voice_server_update_event()
  | webhooks_update_event()

Union type of all available events.

Link to this type

guild_ban_add_event() View Source 
guild_ban_add_event() ::
  {:GUILD_BAN_ADD,
   {Crux.Structs.User.t() | Crux.Structs.Member.t(),
    Crux.Structs.Guild.t() | guild_id()}, shard_id()}

Emitted whenever a user was banned from a guild.

Emits a user if the member was not cached.
Emits the guild id if the guild was not cached.

For more information see Discord Docs.

Link to this type

guild_ban_remove_event() View Source 
guild_ban_remove_event() ::
  {:GUILD_BAN_REMOVE,
   {Crux.Structs.User.t(), Crux.Structs.Guild.t() | guild_id()}, shard_id()}

Emitted whenever a user was unbanned from a guild.

Emits the guild id if the guild was not cached.

For more information see Discord Docs.

Link to this type

guild_create_event() View Source 
guild_create_event() :: {:GUILD_CREATE, Crux.Structs.Guild.t(), shard_id()}

Emitted whenever the client joined a guild.

For more information see Discord Docs.

Link to this type

guild_delete_event() View Source 
guild_delete_event() :: {:GUILD_DELETE, Crux.Structs.Guild.t(), shard_id()}

Emitted whenever the client left a guild or a guild became unavailable.

For more information see Discord Docs.

Link to this type

guild_emojis_update_event() View Source 
guild_emojis_update_event() ::
  {:GUILD_EMOJIS_UPDATE, {[Crux.Structs.Emoji.t()], [Crux.Structs.Emoji.t()]},
   shard_id()}

Emitted whenever a guild's emojis updated.

The first element is a list of the emojis before the update.
The second element is al ist of the emojis after the update.

For more information see Discord Docs.

Link to this type

guild_id() View Source 
guild_id() :: snowflake()

The id of a guild.

Link to this type

guild_integrations_update_event() View Source 
guild_integrations_update_event() ::
  {:GUILD_INTEGRATIONS_UPDATE, Crux.Structs.Guild.t() | guild_id(), shard_id()}

Emitted whenever one of a guild's integration was updated.

Emits the guild id if the guild was not cached.

For more information see Discord Docs.

Link to this type

guild_member_add_event() View Source 
guild_member_add_event() ::
  {:GUILD_MEMBER_ADD, Crux.Structs.Member.t(), shard_id()}

Emitted whenever a user joined a guild.

For more information see Discord Docs.

Link to this type

guild_member_remove_event() View Source 
guild_member_remove_event() ::
  {:GUILD_MEMBER_REMOVE,
   {Crux.Structs.User.t() | Crux.Structs.Member.t(),
    Crux.Structs.Guild.t() | guild_id()}, shard_id()}

Emitted whenever a user left a guild.
This includes kicks and bans.

Emits the user if the member was not cached.
Emits the guild id if the guild was not cached.

For more information see Discord Docs.

Link to this type

guild_member_update_event() View Source 
guild_member_update_event() ::
  {:GUILD_MEMBER_UPDATE,
   {Crux.Structs.Member.t() | nil, Crux.Structs.Member.t()}, shard_id()}

Emitted whenever a guild member was updated.

Emits nil as the member before the updated if it was uncached.

For more information see Discord Docs.

Link to this type

guild_members_chunk_event() View Source 
guild_members_chunk_event() ::
  {:GUILD_MEMBERS_CHUNK,
   %{
     members: [Crux.Structs.Member.t()],
     presences: [Crux.Structs.Presence.t()],
     not_found: [Crux.Structs.Snowflake.t()]
   }, shard_id()}

Emitted whenever a chunk of guild members was received.

For more information see Crux.Gateway.Command.request_guild_members/2 and Discord Docs.

Link to this type

guild_role_create_event() View Source 
guild_role_create_event() ::
  {:GUILD_ROLE_CREATE, Crux.Structs.Role.t(), shard_id()}

Emitted whenever a role was created.

For more information see Discord Docs.

Link to this type

guild_role_delete_event() View Source 
guild_role_delete_event() ::
  {:GUILD_ROLE_DELETE,
   Crux.Structs.Role.t() | {role_id(), Crux.Structs.Guild.t() | guild_id()},
   shard_id()}

Emitted whenever a role was deleted.

Emits a tuple of role and guild or guild id if uncached.

For more information see Discord Docs.

Link to this type

guild_role_update_event() View Source 
guild_role_update_event() ::
  {:GUILD_ROLE_UPDATE, {Crux.Structs.Role.t() | nil, Crux.Structs.Role.t()},
   shard_id()}

Emitted whenever a role was updated.

Emits nil as the role before the update if it was uncached previously.

For more information see Discord Docs.

Link to this type

guild_update_event() View Source 
guild_update_event() ::
  {:GUILD_UPDATE, {Crux.Structs.Guild.t() | nil, Crux.Structs.Guild.t()},
   shard_id()}

Emitted whenever a guild updated.

Emits nil as guild before the update if it was uncached previously.

Fore more information see Discord Docs.

Link to this type

message_create_event() View Source 
message_create_event() ::
  {:MESSAGE_CREATE, Crux.Structs.Message.t(), shard_id()}

Emitted whenever a message was created. (Sent to a channel)

For more information see Discord Docs.

Link to this type

message_delete_bulk_event() View Source 
message_delete_bulk_event() ::
  {:MESSAGE_DELETE_BULK,
   {[message_id()], Crux.Structs.Channel.t() | {channel_id(), guild_id()}},
   shard_id()}

Emitted whenever a bulk of messages was deleted.

Emits a tuple of channel and guild id if the channel was not cached.

For more information see Discord Docs.

Link to this type

message_delete_event() View Source 
message_delete_event() ::
  {:MESSAGE_DELETE,
   {message_id(), Crux.Structs.Channel.t() | {channel_id(), guild_id()}},
   shard_id()}

Emitted whenever a channel was deleted.

Emits a tuple of channel and guild id if the channel was not cached.

For more information see Discord Docs.

Link to this type

message_id() View Source 
message_id() :: snowflake()

The id of a message.

Link to this type

message_reaction_add_event() View Source 
message_reaction_add_event() ::
  {:MESSAGE_REACTION_ADD,
   {Crux.Structs.User.t() | user_id(),
    Crux.Structs.Channel.t() | {channel_id(), guild_id()}, message_id(),
    Crux.Structs.Emoji.t()}, shard_id()}

Emitted whenever a reaction was added to a message.

Emits the user id if the user was not cached.
Emits a tuple of channel and guild id if the channel was not cached.

For more information see Discord Docs.

Link to this type

message_reaction_remove_all_event() View Source 
message_reaction_remove_all_event() ::
  {:MESSAGE_REACTION_REMOVE_ALL,
   {message_id(), Crux.Structs.Channel.t() | {channel_id(), guild_id()}}}

Emitted whenever a user explicitly removed all reactions from a message.

For more information see Discord Docs.

Link to this type

message_reaction_remove_event() View Source 
message_reaction_remove_event() ::
  {:MESSAGE_REACTION_REMOVE,
   {Crux.Structs.User.t() | user_id(),
    Crux.Structs.Channel.t() | {channel_id(), guild_id() | nil}, message_id(),
    Crux.Structs.Emoji.t()}, shard_id()}

Emitted whenever a reaction was removed from a message.

Emits the user id if the user was not cached.
Emits a tuple of channel and guild id if the channel was not cached.

For more information see Discord Docs.

Link to this type

message_update_event() View Source 
message_update_event() ::
  {:MESSAGE_UPDATE,
   Crux.Structs.Message.t()
   | %{channel_id: channel_id(), id: message_id(), embeds: [term()]},
   shard_id()}

Emitted whenever a message was updated.

Emits a partial object for "embed update"s (discord auto embedding websites/images/videos)
Or the full new message for "actual" message updates.

For more information see Discord Docs.

Link to this type

presence_update_event() View Source 
presence_update_event() ::
  {:PRESENCE_UPDATE,
   {Crux.Structs.Presence.t() | nil, Crux.Structs.Presence.t()}, shard_id()}
  | {:PRESENCE_UPDATE, {Crux.Structs.User.t() | nil, Crux.Structs.User.t()},
     shard_id()}

Emitted whenever a user's presence or any of the user's properties updated.

Emits presences for presence updates.
Emits users for user updates.

For more information see Discord Docs.

Link to this type

ready_event() View Source 
ready_event() ::
  {:READY,
   %{
     v: integer(),
     user: Crux.Structs.User.t(),
     private_channels: [],
     guilds: [Crux.Structs.Guild.t()],
     session_id: String.t()
   }, shard_id()}

Emitted when a gateway connection completed the initial handshake with the gateway.
The guilds are not yet sent, those are partial unavailable guilds!

For more information see Discord Docs.

Link to this type

resumed_event() View Source 
resumed_event() :: {:RESUMED, map(), shard_id()}

Emitted whenever a gateway connection resumed after unexpectedly disconnecting.

For more information see Discord Docs.

Link to this type

role_id() View Source 
role_id() :: snowflake()

The id of a role.

Link to this type

shard_id() View Source 
shard_id() :: non_neg_integer()

The id of a shard.

Link to this type

snowflake() View Source 
snowflake() :: Crux.Rest.snowflake()

A discord snowflake.
See t:Crux.Rest.Snowflake/0 for more information.

Link to this type

typing_start_event() View Source 
typing_start_event() ::
  {:TYPING_START,
   {Crux.Structs.Channel.t() | {channel_id(), guild_id() | nil},
    Crux.Structs.User.t() | user_id(), String.t()}, shard_id()}

Emitted whenever a user started typing in a channel.

Emits a tuple of channel and guild id if the channel was not cached.
Emits the user id if the user was not cached.
The third element is the unix timestamp of when the user started typing.

For more information see Discord Docs.

Link to this type

user_id() View Source 
user_id() :: snowflake()

The id of a user.

Link to this type

user_update_event() View Source 
user_update_event() ::
  {:USER_UPDATE, {Crux.Structs.User.t() | nil, Crux.Structs.User.t()},
   shard_id()}

Emitted whenever properties about the current user changed.

Emits nil as the user before the update if uncached previously.

For more information see Discord Docs.

Link to this type

voice_server_update_event() View Source 
voice_server_update_event() ::
  {:VOICE_SERVER_UPDATE,
   %{token: String.t(), guild_id: String.t(), endpoint: String.t()}, shard_id()}

Emitted whenever guild's voice server was updated.

> This is the raw, but atomified, payload from discord, you can directly forward it to, for example, Lavalink.

For more information see Discord Docs.

Link to this type

voice_state_update_event() View Source 
voice_state_update_event() ::
  {:VOICE_STATE_UPDATE,
   {Crux.Structs.VoiceState.t() | nil, Crux.Structs.VoiceState.t()}, shard_id()}

Emitted whenever the voice state of a member changed.

Emits nil as the voice state before the update if uncached previously.

For more information see Discord Docs.

Link to this type

webhooks_update_event() View Source 
webhooks_update_event() ::
  {:WEBHOOKS_UPDATE,
   {Crux.Structs.Guild.t() | guild_id(),
    Crux.Structs.Channel.t() | channel_id()}, shard_id()}

Emitted whenever a channel's webhook was created, updated, or deleted.

Emits the guild id if the guild was not cached.
Emits the channel id if the channel was not cached.

For more information see Discord Docs.

Link to this section Functions

Link to this function

process_event(guild_event, data, shard_id, cache_provider) View Source 
process_event(
  type :: atom(),
  data :: term(),
  shard_id :: shard_id(),
  cache_provider :: term()
) :: event() | [event()]

Processes the type (t value of a packet) along its data (d portion of a packet).
This will do necessary transformation, cache lookups, and cache insertions.

Returns an event/0 or a list of them.