crux_rest v0.1.7 Crux.Rest.Endpoints View Source
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 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 fetch channel webhooks
Used to obtain the gateway address
Used to obtain the gateway address along the recommended shard count
Used for guild related functions
Used for guild audit logs fetching
Used for ban related functions
Used for guild emoji related functions
Used for integration related functions
Used for role related functions
Used for guild members related functions
Discord being special
Used for role related functions
Used to fetch guild webhooks
Used for invite related functions
Used for functions related to the current user
Used for functions related to the current user’s guilds
Used for reactions related functions
Used for functions related to users
Used for webhook related functions
Used to send github formatted webhooks
Used to send slack formatted webhooks
Link to this section Functions
Base API address.
Deprecated, use base_url/0
instead.
Base API address.
Base CDN address.
Deprecated, use Crux.Rest.CDN.cdn/0
instead.
channel(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for channel related functions.
channel_messages( channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil ) :: String.t()
Used for channel messages related functions.
channel_permissions( channel_id :: Crux.Rest.snowflake(), target_id :: Crux.Rest.snowflake() ) :: String.t()
Used for channel permissions related functions.
channel_pins(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for pin related functions.
channel_webhooks(channel_id :: Crux.Rest.snowflake()) :: String.t()
Used to fetch channel webhooks.
Used to obtain the gateway address.
Used to obtain the gateway address along the recommended shard count.
guild(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for guild related functions.
guild_audit_logs(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild audit logs fetching.
guild_bans(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for ban related functions.
guild_emojis(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for guild emoji related functions.
guild_integrations( guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil ) :: String.t()
Used for integration related functions.
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.
guild_members(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for guild members related functions.
guild_own_nick(guild_id :: Crux.Rest.snowflake()) :: String.t()
Discord being special.
guild_roles(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for role related functions.
guild_webhooks(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used to fetch guild webhooks.
Used for invite related functions.
Used for functions related to the current user.
Used for functions related to the current user’s guilds.
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.
Used for functions related to users.
webhook(guild_id :: Crux.Rest.snowflake(), token :: String.t() | nil) :: String.t()
Used for webhook related functions.
webhook_github(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) :: String.t()
Used to send github formatted webhooks.
webhook_slack(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) :: String.t()
Used to send slack formatted webhooks.