crux_rest v0.1.3 Crux.Rest.Endpoints View Source

The endpoints being used by the Crux.Rest module, you do not need to worry about it.

Link to this section Summary

Functions

Base API address

Base CDN address

Used for channel related functions

Used for channel messages related functions

Used for channel permissions related functions

Used for pin related functions

Used to obtain the gateway address

Used to obtain the gateway address along the recommended shard count

Used for guild related functions

Used for ban related functions

Used for guild emoji related functions

Used for integration related functions

Used for guild members related functions

Discord being special

Used for role related functions

Used for invite related functions

Link to this section Functions

Base API address.

Base CDN address.

Link to this function channel(channel_id, suffix \\ nil) View Source
channel(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for channel related functions.

Link to this function channel_messages(channel_id, suffix \\ nil) View Source
channel_messages(
  channel_id :: Crux.Rest.snowflake(),
  suffix :: String.t() | nil
) :: String.t()

Used for channel messages related functions.

Link to this function channel_permissions(channel_id, target_id) View Source
channel_permissions(
  channel_id :: Crux.Rest.snowflake(),
  target_id :: Crux.Rest.snowflake()
) :: String.t()

Used for channel permissions related functions.

Link to this function channel_pins(channel_id, suffix \\ nil) View Source
channel_pins(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for pin related functions.

Used to obtain the gateway address.

Link to this function gateway_bot() View Source
gateway_bot() :: String.t()

Used to obtain the gateway address along the recommended shard count.

Link to this function guild(guild_id \\ nil, suffix \\ nil) View Source
guild(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for guild related functions.

Link to this function guild_bans(guild_id, suffix \\ nil) View Source
guild_bans(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for ban related functions.

Link to this function guild_emojis(guild_id, suffix \\ nil) View Source
guild_emojis(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for guild emoji related functions.

Link to this function guild_integrations(guild_id, suffix \\ nil) View Source
guild_integrations(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: String.t() | nil
) :: String.t()

Used for integration related functions.

Link to this function guild_member_roles(guild_id, member_id, role_id \\ nil) View Source
guild_member_roles(
  guild_id :: Crux.Rest.snowflake(),
  member_id :: Crux.Rest.snowflake(),
  role_id :: Crux.Rest.snowflake()
) :: String.t()

Used for role related functions.

Link to this function guild_members(guild_id, suffix \\ nil) View Source
guild_members(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for guild members related functions.

Link to this function guild_own_nick(guild_id) View Source
guild_own_nick(guild_id :: Crux.Rest.snowflake()) :: String.t()

Discord being special.

Link to this function guild_roles(guild_id, suffix \\ nil) View Source
guild_roles(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for role related functions.

Link to this function invite(code \\ nil) View Source
invite(code :: String.t() | nil) :: String.t()

Used for invite related functions.

Link to this function message_reactions(channel_id, message_id, emoji, suffix \\ nil) View Source
message_reactions(
  channel_id :: Crux.Rest.snowflake(),
  message_id :: Crux.Rest.snowflake(),
  emoji :: String.t(),
  suffix :: String.t() | nil
) :: String.t()

Used for reactions related functions.