Skip to content

Commit f55622d

Browse files
committed
PHPDocs
1 parent 1bcb1ee commit f55622d

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

src/Discord/Parts/Guild/NewMemberAction.php

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,22 @@
2424
*
2525
* @since 10.47.0 OpenAPI Preview
2626
*
27-
* @property string|null $channel_id The target channel id.
28-
* @property int $action_type The action type (0 = VIEW, 1 = TALK).
29-
* @property string $title The action title.
30-
* @property string $description The action description.
31-
* @property Emoji|null $emoji The partial emoji associated with the action.
32-
* @property string|null $icon The icon string, if present.
27+
* @property string|null $channel_id The ID of the channel where the action is located.
28+
* @property int $action_type The type of action the user should take in the channel (0 = VIEW, 1 = TALK).
29+
* @property string $title The title of the action (max 60 characters).
30+
* @property string $description The description of the action (max 200 characters).
31+
* @property Emoji|null $emoji The partial emoji representing the action.
32+
* @property string|null $icon The icon hash representing the action.
3333
*
3434
* @property-read string|null $guild_id The guild id associated with this action.
3535
* @property-read Guild|null $guild The guild associated with this action.
3636
* @property-read Channel|null $channel The channel associated with this action.
3737
*/
3838
class NewMemberAction extends Part
3939
{
40+
/** View the channel. */
4041
public const ACTION_TYPE_VIEW = 0;
42+
/** Send a message in the channel. */
4143
public const ACTION_TYPE_TALK = 1;
4244

4345
/**

src/Discord/Parts/Guild/ServerGuide.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@
2020
/**
2121
* Server Guide for a guild.
2222
*
23+
* Previously known as GuildHome.
24+
*
2325
* @link https://github.com/discord/discord-api-spec/blob/7cba79e03a393456fc904cff470097d3be383bec/specs/openapi_preview.json#L25369
2426
*
2527
* @since 10.47.0 OpenAPI Preview
2628
*
27-
* @property string $guild_id The guild (server) id.
28-
* @property bool $enabled Whether Home is enabled for the guild.
29-
* @property WelcomeMessage|null $welcome_message The welcome message settings.
30-
* @property ExCollectionInterface<NewMemberAction>|NewMemberAction[] $new_member_actions The new member actions.
31-
* @property ExCollectionInterface<ResourceChannel>|ResourceChannel[] $resource_channels The resource channels.
29+
* @property string $guild_id The ID of the guild this new member welcome is for.
30+
* @property bool $enabled Whether the new member welcome experience is enabled.
31+
* @property WelcomeMessage|null $welcome_message Welcome message shown to new members of the guild.
32+
* @property ExCollectionInterface<NewMemberAction>|NewMemberAction[] $new_member_actions Actions shown to new members of the guild (max 5).
33+
* @property ExCollectionInterface<ResourceChannel>|ResourceChannel[] $resource_channels Read-only channels that provide resources for new members (max 7).
3234
*
3335
* @property-read Guild|null $guild The guild associated with the server guide.
3436
*/

src/Discord/Parts/Guild/WelcomeMessage.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
*
2424
* @since 10.47.0 OpenAPI Preview
2525
*
26-
* @property string[] $author_ids The author IDs for the message.
27-
* @property string $message The welcome message content.
26+
* @property string[] $author_ids The IDs of the users who authored the welcome message (max 10).
27+
* @property string $message The welcome message shown to new members (max 300 characters).
2828
*/
2929
class WelcomeMessage extends Part
3030
{

0 commit comments

Comments
 (0)