Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs and Channel Additions #637

Merged
merged 4 commits into from
Nov 1, 2024
Merged

Docs and Channel Additions #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d439b9
Update Message type typedoc from latest API docs
kyleboe Oct 20, 2024
9c97daf
Update buttons guide image from API docs
kyleboe Oct 20, 2024
d32e178
Update `Struct.Channel` with default_sort_order and default_forum_layout
kyleboe Oct 20, 2024
4150681
Remove id callout to match rest of typedocs
kyleboe Oct 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified guides/assets/buttons.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 18 additions & 2 deletions lib/nostrum/struct/channel.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,9 @@ defmodule Nostrum.Struct.Channel do
:available_tags,
:applied_tags,
:default_reaction_emoji,
:default_thread_rate_limit_per_user
:default_thread_rate_limit_per_user,
:default_sort_order,
:default_forum_layout
]

@typedoc """
Expand Down Expand Up @@ -219,6 +221,18 @@ defmodule Nostrum.Struct.Channel do
@typedoc since: "0.7.0"
@type default_thread_rate_limit_per_user :: integer() | nil

@typedoc """
The default sort order for posts in a `GUILD_FORUM` channel.
"""
@typedoc since: "0.11.0"
@type default_sort_order :: integer() | nil

@typedoc """
The default layout for posts in a `GUILD_FORUM` channel.
"""
@typedoc since: "0.11.0"
@type default_forum_layout :: integer() | nil

@typedoc """
The user limit of a voice channel.
"""
Expand Down Expand Up @@ -620,7 +634,9 @@ defmodule Nostrum.Struct.Channel do
available_tags: [forum_tag],
rate_limit_per_user: rate_limit_per_user,
default_reaction_emoji: default_reaction_emoji,
default_thread_rate_limit_per_user: default_thread_rate_limit_per_user
default_thread_rate_limit_per_user: default_thread_rate_limit_per_user,
default_sort_order: default_sort_order,
default_forum_layout: default_forum_layout
}

@typedoc """
Expand Down
25 changes: 20 additions & 5 deletions lib/nostrum/struct/message.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,20 +145,35 @@ defmodule Nostrum.Struct.Message do
- `5` - `CHANNEL_ICON_CHANGE`
- `6` - `CHANNEL_PINNED_MESSAGE`
- `7` - `GUILD_MEMBER_JOIN`
- `8` - `USER_PREMIUM_GUILD_SUBSCRIPTION`
- `9` - `USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1`
- `10` - `USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2`
- `11` - `USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3`
- `8` - `GUILD_BOOST`
- `9` - `GUILD_BOOST_TIER_1`
- `10` - `GUILD_BOOST_TIER_2`
- `11` - `GUILD_BOOST_TIER_3`
- `12` - `CHANNEL_FOLLOW_ADD`
- `14` - `GUILD_DISCOVERY_DISQUALIFIED`
- `15` - `GUILD_DISCOVERY_REQUALIFIED`
- `16` - `GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING`
- `17` - `GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING`
- `18` - `THREAD_CREATED`
- `19` - `REPLY`
- `20` - `APPLICATION_COMMAND`
- `20` - `CHAT_INPUT_COMMAND`
- `21` - `THREAD_STARTER_MESSAGE`
- `22` - `GUILD_INVITE_REMINDER`
- `23` - `CONTEXT_MENU_COMMAND`
- `24` - `AUTO_MODERATION_ACTION`
- `25` - `ROLE_SUBSCRIPTION_PURCHASE`
- `26` - `INTERACTION_PREMIUM_UPSELL`
- `27` - `STAGE_START`
- `28` - `STAGE_END`
- `29` - `STAGE_SPEAKER`
- `31` - `STAGE_TOPIC`
- `32` - `GUILD_APPLICATION_PREMIUM_SUBSCRIPTION`
- `36` - `GUILD_INCIDENT_ALERT_MODE_ENABLED`
- `37` - `GUILD_INCIDENT_ALERT_MODE_DISABLED`
- `38` - `GUILD_INCIDENT_REPORT_RAID`
- `39` - `GUILD_INCIDENT_REPORT_FALSE_ALARM`
- `44` - `PURCHASE_NOTIFICATION`
- `46` - `POLL_RESULT`
"""
@type type :: integer()

Expand Down
Loading