TextableChannel

Hierarchy

BaseGuildChannel<APITextChannel>
- TextableChannel

Constructors

constructor

new TextableChannel(client: Client, data: APITextChannel, guild: Guild): TextableChannel

Inherited from BaseGuildChannel.constructor
- Defined in src/structures/BaseGuildChannel.ts:11
Parameters
- client: Client
- data: APITextChannel
- guild: Guild
Returns TextableChannel

Properties

client

client: Client

data

data: APITextChannel

guild

guild: Guild

Accessors

defaultAutoArchiveDuration

get defaultAutoArchiveDuration(): undefined | ThreadAutoArchiveDuration

- Defined in src/structures/channel/TextableChannel.ts:36
Returns undefined | ThreadAutoArchiveDuration

guildId

get guildId(): string

Inherited from BaseGuildChannel.guildId
- Defined in src/structures/BaseGuildChannel.ts:29
Returns string

id

get id(): string

Inherited from BaseGuildChannel.id
- Defined in src/structures/BaseGuildChannel.ts:21
Returns string

lastMessageId

get lastMessageId(): undefined | null | string

- Defined in src/structures/channel/TextableChannel.ts:12
Returns undefined | null | string

lastPinTimestamp

get lastPinTimestamp(): undefined | null | string

- Defined in src/structures/channel/TextableChannel.ts:32
Returns undefined | null | string

name

get name(): string

Inherited from BaseGuildChannel.name
- Defined in src/structures/BaseGuildChannel.ts:17
Returns string

nsfw

get nsfw(): undefined | boolean

- Defined in src/structures/channel/TextableChannel.ts:28
Returns undefined | boolean

parentId

get parentId(): undefined | null | string

- Defined in src/structures/channel/TextableChannel.ts:20
Returns undefined | null | string

permissionOverwrites

get permissionOverwrites(): undefined | APIOverwrite[]

- Defined in src/structures/channel/TextableChannel.ts:24
Returns undefined | APIOverwrite[]

rateLimitPerUser

get rateLimitPerUser(): undefined | number

- Defined in src/structures/channel/TextableChannel.ts:16
Returns undefined | number

topic

get topic(): undefined | null | string

- Defined in src/structures/channel/TextableChannel.ts:8
Returns undefined | null | string

type

get type(): GuildText | GuildVoice | GuildCategory | GuildNews | GuildNewsThread | GuildPublicThread | GuildPrivateThread | GuildStageVoice

Inherited from BaseGuildChannel.type
- Defined in src/structures/BaseGuildChannel.ts:25
Returns GuildText | GuildVoice | GuildCategory | GuildNews | GuildNewsThread | GuildPublicThread | GuildPrivateThread | GuildStageVoice

Methods

createInvite

createInvite(data: { max_age?: number; max_uses?: number; reason?: string; temporary?: boolean; unique?: boolean }): Promise<<internal>.Invite>

- Defined in src/structures/channel/TextableChannel.ts:53
Parameters
- data: { max_age?: number; max_uses?: number; reason?: string; temporary?: boolean; unique?: boolean }
  - Optional max_age?: number
  - Optional max_uses?: number
  - Optional reason?: string
  - Optional temporary?: boolean
  - Optional unique?: boolean
Returns Promise<<internal>.Invite>

createMessage

createMessage(data: <internal>.CreateMessageData, options?: { disableEveryone?: boolean }): Promise<<internal>.Message>

- Defined in src/structures/channel/TextableChannel.ts:97
Parameters
- data: <internal>.CreateMessageData
- Optional options: { disableEveryone?: boolean }
  - Optional disableEveryone?: boolean
Returns Promise<<internal>.Message>

createThread

createThread(options: { auto_archive_duration: 60 | 1440 | 4320 | 10080; invitable?: boolean; name: string; reason?: string; type: 10 | 12 | 11 }, message?: string): Promise<<internal>.NewsThread | <internal>.PublicThread | <internal>.PrivateThread>

- Defined in src/structures/channel/TextableChannel.ts:67
Parameters
- options: { auto_archive_duration: 60 | 1440 | 4320 | 10080; invitable?: boolean; name: string; reason?: string; type: 10 | 12 | 11 }
  - auto_archive_duration: 60 | 1440 | 4320 | 10080
  - Optional invitable?: boolean
  - name: string
  - Optional reason?: string
  - type: 10 | 12 | 11
- Optional message: string
Returns Promise<<internal>.NewsThread | <internal>.PublicThread | <internal>.PrivateThread>

delete

delete(reason?: string): Promise<<internal>.Channel>

Inherited from BaseGuildChannel.delete
- Defined in src/structures/BaseGuildChannel.ts:33
Parameters
- Optional reason: string
Returns Promise<<internal>.Channel>

deleteMessage

deleteMessage(id: string): Promise<void>

- Defined in src/structures/channel/TextableChannel.ts:103
Parameters
- id: string
Returns Promise<void>

deleteMessages

deleteMessages(ids: string[], reason?: string): Promise<void>

- Defined in src/structures/channel/TextableChannel.ts:107
Parameters
- ids: string[]
- Optional reason: string
Returns Promise<void>

edit

edit(data: <internal>.EditChannelData): Promise<<internal>.Channel>

Inherited from BaseGuildChannel.edit
- Defined in src/structures/BaseGuildChannel.ts:37
Parameters
- data: <internal>.EditChannelData
Returns Promise<<internal>.Channel>

fetchInvites

fetchInvites(): Promise<<internal>.Invite[]>

- Defined in src/structures/channel/TextableChannel.ts:63
Returns Promise<<internal>.Invite[]>

fetchMessage

fetchMessage(id: string): Promise<<internal>.Message>

- Defined in src/structures/channel/TextableChannel.ts:89
Parameters
- id: string
Returns Promise<<internal>.Message>

fetchMessages

fetchMessages(data: <internal>.GetMessageOptions): Promise<<internal>.Message[]>

- Defined in src/structures/channel/TextableChannel.ts:93
Parameters
- data: <internal>.GetMessageOptions
Returns Promise<<internal>.Message[]>

fetchPins

fetchPins(): Promise<<internal>.Message[]>

- Defined in src/structures/channel/TextableChannel.ts:44
Returns Promise<<internal>.Message[]>

fetchThread

fetchThread(id: string): Promise<<internal>.Channel>

- Defined in src/structures/channel/TextableChannel.ts:77
Parameters
- id: string
Returns Promise<<internal>.Channel>

getArchivedPrivateThreads

getArchivedPrivateThreads(): Promise<<internal>.PrivateThread[]>

- Defined in src/structures/channel/TextableChannel.ts:85
Returns Promise<<internal>.PrivateThread[]>

getArchivedPublicThreads

getArchivedPublicThreads(): Promise<(<internal>.NewsThread | <internal>.PublicThread)[]>

- Defined in src/structures/channel/TextableChannel.ts:81
Returns Promise<(<internal>.NewsThread | <internal>.PublicThread)[]>

setRateLimitPerUser

setRateLimitPerUser(rate_limit_per_user: number): Promise<<internal>.Channel>

- Defined in src/structures/channel/TextableChannel.ts:40
Parameters
- rate_limit_per_user: number
Returns Promise<<internal>.Channel>

syncPermissions

syncPermissions(): void

- Defined in src/structures/channel/TextableChannel.ts:49
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: APITextChannel

guild: Guild

Returns TextableChannel

Properties

client

data

guild

Accessors

defaultAutoArchiveDuration

Returns undefined | ThreadAutoArchiveDuration

guildId

Returns string

id

Returns string

lastMessageId

Returns undefined | null | string

lastPinTimestamp

Returns undefined | null | string

name

Returns string

nsfw

Returns undefined | boolean

parentId

Returns undefined | null | string

permissionOverwrites

Returns undefined | APIOverwrite[]

rateLimitPerUser

Returns undefined | number

topic

Returns undefined | null | string

type

Returns GuildText | GuildVoice | GuildCategory | GuildNews | GuildNewsThread | GuildPublicThread | GuildPrivateThread | GuildStageVoice

Methods

createInvite

Parameters

data: { max_age?: number; max_uses?: number; reason?: string; temporary?: boolean; unique?: boolean }

Optional max_age?: number

Optional max_uses?: number

Optional reason?: string

Optional temporary?: boolean

Optional unique?: boolean

Returns Promise<<internal>.Invite>

createMessage

Parameters

data: <internal>.CreateMessageData

Optional options: { disableEveryone?: boolean }

Optional disableEveryone?: boolean

Returns Promise<<internal>.Message>

createThread

Parameters

options: { auto_archive_duration: 60 | 1440 | 4320 | 10080; invitable?: boolean; name: string; reason?: string; type: 10 | 12 | 11 }

auto_archive_duration: 60 | 1440 | 4320 | 10080

Optional invitable?: boolean

name: string

Optional reason?: string

type: 10 | 12 | 11

Optional message: string

Returns Promise<<internal>.NewsThread | <internal>.PublicThread | <internal>.PrivateThread>

delete

Parameters

Optional reason: string

Returns Promise<<internal>.Channel>

deleteMessage

Parameters

id: string

Returns Promise<void>

deleteMessages

Parameters

ids: string[]

Optional reason: string