Add API Docs for 'default_forum_layout' channel data attribute #5745
Conversation
|
Duplicate of #5693 |
|
|
||
| | Flag | Value | Description | | ||
| | --------------- | ----- | -------------------------------------------------------------- | | ||
| | NOT_SET | 0 | No default has been set for forum channel | |
There was a problem hiding this comment.
if it has no default value, how does it display for users by default? list view still?
There was a problem hiding this comment.
Yes, on the UI it shows as "List" when it's NOT_SET. Because "List" is the current default value.
There was a problem hiding this comment.
Not necessary, but it could be helpful to include that posts will display as list in this scenario as well
Co-authored-by: shay <swdewael@gmail.com>
Co-authored-by: shay <swdewael@gmail.com>
Co-authored-by: shay <swdewael@gmail.com>
docs/resources/Channel.md
Outdated
| @@ -41,6 +41,7 @@ Represents a guild or DM channel within Discord. | |||
| | default_reaction_emoji? | ?[default reaction](#DOCS_RESOURCES_CHANNEL/default-reaction-object) object | the emoji to show in the add reaction button on a thread in a `GUILD_FORUM` channel | | |||
| | default_thread_rate_limit_per_user? | integer | the initial `rate_limit_per_user` to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. | | |||
| | default_sort_order? | ?integer | the [default sort order type](#DOCS_RESOURCES_CHANNEL/channel-object-sort-order-types) used to order posts in `GUILD_FORUM` channels. Defaults to `null`, which indicates a preferred sort order hasn't been set by a channel admin | | |||
| | default_forum_layout? | ?integer | the [default forum layout view](#DOCS_RESOURCES_CHANNEL/channel-object-forum-layout-types) used to display posts in `GUILD_FORUM` channels. Defaults to `0`, which indicates a layout view has not been set by a channel admin | | |||
There was a problem hiding this comment.
When is this null? I thought when it's unset it is 0 and not null
There was a problem hiding this comment.
I duped the row above, it's not null, you're correct that it's 0 when a value isn't set. Updated
docs/resources/Channel.md
Outdated
| @@ -874,6 +883,7 @@ Requires the `MANAGE_CHANNELS` permission for the guild. Fires a [Channel Update | |||
| | default_reaction_emoji? | ?[default reaction](#DOCS_RESOURCES_CHANNEL/default-reaction-object) object | the emoji to show in the add reaction button on a thread in a `GUILD_FORUM` channel | Forum | | |||
| | default_thread_rate_limit_per_user? | integer | the initial `rate_limit_per_user` to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. | Text, Forum | | |||
| | default_sort_order? | ?integer | the [default sort order type](#DOCS_RESOURCES_CHANNEL/channel-object-sort-order-types) used to order posts in `GUILD_FORUM` channels | Forum | | |||
| | default_forum_layout? | ?integer | the [default forum layout type](#DOCS_RESOURCES_CHANNEL/channel-object-forum-layout-types) used to display posts in `GUILD_FORUM` channels | Forum | | |||
There was a problem hiding this comment.
What happens when you set this to null here?
There was a problem hiding this comment.
it's not nullable- nice catch, updated
|
GitHub doesn't let me approve review, but since you requested it. LGTM 👍🏼 |
|
Is it not possible to set this on creation with |
|
@ooliver1 Thanks for the report. It's a bug. A fix is coming soon. |
|
@Tin A fix? It is not documented. |
Add 'default_forum_layout' field to Channel object api docs