Interface APIGuildChannel<T>

This interface is used to allow easy extension for other channel types. While also allowing APIPartialChannel to be used without breaking.

interface APIGuildChannel<T extends ChannelType> {
    flags?: ChannelFlags;
    guild_id?: string;
    id: string;
    name: string;
    nsfw?: boolean;
    parent_id?: null | string;
    permission_overwrites?: APIOverwrite[];
    type: T;
}

Type Parameters

Hierarchy (View Summary)

Properties

flags? guild_id? id name nsfw? parent_id? permission_overwrites? type

Properties

Optionalflags

flags?: ChannelFlags

Optionalguild_id

guild_id?: string

The id of the guild (may be missing for some channel objects received over gateway guild dispatches)

id

id: string

The id of the channel

name

name: string

The name of the channel (1-100 characters)

Optionalnsfw

nsfw?: boolean

Whether the channel is nsfw

Optionalparent_id

parent_id?: null | string

ID of the parent category for a channel (each parent category can contain up to 50 channels)

OR

ID of the parent channel for a thread

Optionalpermission_overwrites

permission_overwrites?: APIOverwrite[]

Explicit permission overwrites for members and roles

See

https://discord.com/developers/docs/resources/channel#overwrite-object

type

type: T

The type of the channel

See

https://discord.com/developers/docs/resources/channel#channel-object-channel-types

Settings

Member Visibility

On This Page

Properties