Class ChannelPayload

Represents the payload for creating or updating a Discord channel. This class encapsulates all the parameters needed to create or update a channel in Discord.

Constructors

constructor

new ChannelPayload(data?): ChannelPayload
Creates a new ChannelPayload instance.
Parameters
- Optionaldata: {
      available_tags?: any[];
      bitrate?: number;
      default_auto_archive_duration?: number;
      default_forum_layout?: number;
      default_reaction_emoji?: any;
      default_sort_order?: number;
      default_thread_rate_limit_per_user?: number;
      name?: string;
      nsfw?: boolean;
      parent_id?: string;
      permission_overwrites?: any[];
      position?: number;
      rate_limit_per_user?: number;
      rtc_region?: string;
      topic?: string;
      type?: number;
      user_limit?: number;
      video_quality_mode?: number;
  }
  Optional initial data to set in the payload.
  - Optionalavailable_tags?: any[]
  - Optionalbitrate?: number
  - Optionaldefault_auto_archive_duration?: number
  - Optionaldefault_forum_layout?: number
  - Optionaldefault_reaction_emoji?: any
  - Optionaldefault_sort_order?: number
  - Optionaldefault_thread_rate_limit_per_user?: number
  - Optionalname?: string
  - Optionalnsfw?: boolean
  - Optionalparent_id?: string
  - Optionalpermission_overwrites?: any[]
  - Optionalposition?: number
  - Optionalrate_limit_per_user?: number
  - Optionalrtc_region?: string
  - Optionaltopic?: string
  - Optionaltype?: number
  - Optionaluser_limit?: number
  - Optionalvideo_quality_mode?: number
Returns ChannelPayload
- Defined in structures/channelPayload.ts:29

Accessors

availableTags

get availableTags(): any[]
Gets the available tags for the channel.

Returns any[]
An array of tags.
- Defined in structures/channelPayload.ts:311
set availableTags(value): void
Sets the available tags for the channel.
Parameters
- value: any[]
  An array of tags.
Returns void
- Defined in structures/channelPayload.ts:319

bitrate

get bitrate(): number
Gets the bitrate of the voice channel.

Returns number
The bitrate value.
- Defined in structures/channelPayload.ts:131
set bitrate(value): void
Sets the bitrate of the voice channel.
Parameters
- value: number
  The bitrate value.
Returns void
- Defined in structures/channelPayload.ts:139

defaultAutoArchiveDuration

get defaultAutoArchiveDuration(): number
Gets the default auto-archive duration for threads in the channel.

Returns number
The default auto-archive duration in minutes.
- Defined in structures/channelPayload.ts:279
set defaultAutoArchiveDuration(value): void
Sets the default auto-archive duration for threads in the channel.
Parameters
- value: number
  The auto-archive duration in minutes.
Returns void
- Defined in structures/channelPayload.ts:287

defaultForumLayout

get defaultForumLayout(): number
Gets the default forum layout for the channel.

Returns number
The default forum layout.
- Defined in structures/channelPayload.ts:343
set defaultForumLayout(value): void
Sets the default forum layout for the channel.
Parameters
- value: number
  The default forum layout.
Returns void
- Defined in structures/channelPayload.ts:351

defaultReactionEmoji

get defaultReactionEmoji(): any
Gets the default reaction emoji for messages in the channel.

Returns any
The default reaction emoji object.
- Defined in structures/channelPayload.ts:295
set defaultReactionEmoji(value): void
Sets the default reaction emoji for messages in the channel.
Parameters
- value: any
  The default reaction emoji object.
Returns void
- Defined in structures/channelPayload.ts:303

defaultSortOrder

get defaultSortOrder(): number
Gets the default sort order for forum posts.

Returns number
The default sort order.
- Defined in structures/channelPayload.ts:327
set defaultSortOrder(value): void
Sets the default sort order for forum posts.
Parameters
- value: number
  The default sort order.
Returns void
- Defined in structures/channelPayload.ts:335

defaultThreadRateLimitPerUser

get defaultThreadRateLimitPerUser(): number
Gets the default rate limit for threads in the channel.

Returns number
The rate limit in seconds.
- Defined in structures/channelPayload.ts:359
set defaultThreadRateLimitPerUser(value): void
Sets the default rate limit for threads in the channel.
Parameters
- value: number
  The rate limit in seconds.
Returns void
- Defined in structures/channelPayload.ts:367

name

get name(): string
Gets the name of the channel.

Returns string
The channel name.
- Defined in structures/channelPayload.ts:75
set name(value): void
Sets the name of the channel.
Parameters
- value: string
  The name of the channel. Must be between 1 and 100 characters.
Returns void
Throws
Error if the name is not between 1 and 100 characters.
- Defined in structures/channelPayload.ts:84

nsfw

get nsfw(): boolean
Gets the NSFW status of the channel.

Returns boolean
True if the channel is NSFW.
- Defined in structures/channelPayload.ts:231
set nsfw(value): void
Sets the NSFW status of the channel.
Parameters
- value: boolean
  True if the channel should be marked NSFW.
Returns void
- Defined in structures/channelPayload.ts:239

parentId

get parentId(): string
Gets the parent ID of the channel (for categories).

Returns string
The parent channel ID.
- Defined in structures/channelPayload.ts:215
set parentId(value): void
Sets the parent ID of the channel (for categories).
Parameters
- value: string
  The parent channel ID.
Returns void
- Defined in structures/channelPayload.ts:223

permissionOverwrites

get permissionOverwrites(): any[]
Gets the permission overwrites for the channel.

Returns any[]
An array of permission overwrites.
- Defined in structures/channelPayload.ts:199
set permissionOverwrites(value): void
Sets the permission overwrites for the channel.
Parameters
- value: any[]
  An array of permission overwrites.
Returns void
- Defined in structures/channelPayload.ts:207

position

get position(): number
Gets the position of the channel.

Returns number
The channel position.
- Defined in structures/channelPayload.ts:183
set position(value): void
Sets the position of the channel.
Parameters
- value: number
  The channel position.
Returns void
- Defined in structures/channelPayload.ts:191

rateLimitPerUser

get rateLimitPerUser(): number
Gets the rate limit per user for a text channel.

Returns number
The rate limit in seconds.
- Defined in structures/channelPayload.ts:163
set rateLimitPerUser(value): void
Sets the rate limit per user for a text channel.
Parameters
- value: number
  The rate limit in seconds (0 to 21600).
Returns void
Throws
Error if the value is out of range.
- Defined in structures/channelPayload.ts:172

rtcRegion

get rtcRegion(): string
Gets the RTC region for a voice channel.

Returns string
The RTC region value.
- Defined in structures/channelPayload.ts:247
set rtcRegion(value): void
Sets the RTC region for a voice channel.
Parameters
- value: string
  The RTC region value.
Returns void
- Defined in structures/channelPayload.ts:255

topic

get topic(): string
Gets the topic of the channel.

Returns string
The channel topic.
- Defined in structures/channelPayload.ts:111
set topic(value): void
Sets the topic of the channel.
Parameters
- value: string
  The topic of the channel. Must be up to 1024 characters.
Returns void
Throws
Error if the topic exceeds 1024 characters.
- Defined in structures/channelPayload.ts:120

type

get type(): number
Gets the type of the channel.

Returns number
The channel type.
- Defined in structures/channelPayload.ts:95
set type(value): void
Sets the type of the channel.
Parameters
- value: number
  The type of the channel.
Returns void
- Defined in structures/channelPayload.ts:103

userLimit

get userLimit(): number
Gets the user limit for a voice channel.

Returns number
The user limit value.
- Defined in structures/channelPayload.ts:147
set userLimit(value): void
Sets the user limit for a voice channel.
Parameters
- value: number
  The user limit.
Returns void
- Defined in structures/channelPayload.ts:155

videoQualityMode

get videoQualityMode(): number
Gets the video quality mode for a voice channel.

Returns number
The video quality mode.
- Defined in structures/channelPayload.ts:263
set videoQualityMode(value): void
Sets the video quality mode for a voice channel.
Parameters
- value: number
  The video quality mode.
Returns void
- Defined in structures/channelPayload.ts:271

Methods

toJSON

toJSON(): any
Converts the payload to a JSON-serializable object.

Returns any
A JSON-serializable representation of the payload.
- Defined in structures/channelPayload.ts:375

Class ChannelPayload

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optionalavailable_tags?: any[]

Optionalbitrate?: number

Optionaldefault_auto_archive_duration?: number

Optionaldefault_forum_layout?: number

Optionaldefault_reaction_emoji?: any

Optionaldefault_sort_order?: number

Optionaldefault_thread_rate_limit_per_user?: number

Optionalname?: string

Optionalnsfw?: boolean

Optionalparent_id?: string

Optionalpermission_overwrites?: any[]

Optionalposition?: number

Optionalrate_limit_per_user?: number

Optionalrtc_region?: string

Optionaltopic?: string

Optionaltype?: number

Optionaluser_limit?: number

Optionalvideo_quality_mode?: number

Returns ChannelPayload

Accessors

availableTags

Returns any[]

Parameters

Returns void

bitrate

Returns number

Parameters

Returns void

defaultAutoArchiveDuration

Returns number

Parameters

Returns void

defaultForumLayout

Returns number

Parameters

Returns void

defaultReactionEmoji

Returns any

Parameters

Returns void

defaultSortOrder

Returns number

Parameters

Returns void

defaultThreadRateLimitPerUser

Returns number

Parameters

Returns void

name

Returns string

Parameters

Returns void

Throws

nsfw

Returns boolean

Parameters

Returns void

parentId

Returns string

Parameters

Returns void

permissionOverwrites

Returns any[]

Parameters

Returns void

position

Returns number

Parameters

Returns void

rateLimitPerUser

Returns number

Parameters

`Optional`available_tags?: any[]

`Optional`bitrate?: number

`Optional`default_auto_archive_duration?: number

`Optional`default_forum_layout?: number

`Optional`default_reaction_emoji?: any

`Optional`default_sort_order?: number

`Optional`default_thread_rate_limit_per_user?: number

`Optional`name?: string

`Optional`nsfw?: boolean

`Optional`parent_id?: string

`Optional`permission_overwrites?: any[]

`Optional`position?: number

`Optional`rate_limit_per_user?: number

`Optional`rtc_region?: string

`Optional`topic?: string

`Optional`type?: number

`Optional`user_limit?: number

`Optional`video_quality_mode?: number