TextChannel | yuuko

Hierarchy

GuildChannel
- TextChannel
  - NewsChannel

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextChannel(data: BaseData, client: Client, messageLimit: number): TextChannel

Overrides GuildChannel.constructor
- Defined in node_modules/eris/index.d.ts:3482
Parameters
- data: BaseData
- client: Client
- messageLimit: number
Returns TextChannel

Properties

client

client: Client

createdAt

createdAt: number

defaultAutoArchiveDuration

defaultAutoArchiveDuration: AutoArchiveDuration

guild

guild: Guild

id

id: string

lastMessageID

lastMessageID: string

lastPinTimestamp

lastPinTimestamp: null | number

mention

mention: string

messages

messages: Collection<Message<TextChannel>>

name

name: string

nsfw

nsfw: boolean

parentID

parentID: null | string

permissionOverwrites

permissionOverwrites: Collection<PermissionOverwrite>

position

position: number

rateLimitPerUser

rateLimitPerUser: number

Optional topic

topic: null | string

type

type: GuildTextChannelTypes

Methods

addMessageReaction

addMessageReaction(messageID: string, reaction: string): Promise<void>
addMessageReaction(messageID: string, reaction: string, userID: string): Promise<void>

Implementation of GuildTextable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:3483
Parameters
- messageID: string
- reaction: string
Returns Promise<void>
Implementation of GuildTextable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:3485
deprecated

Parameters
- messageID: string
- reaction: string
- userID: string
Returns Promise<void>

createInvite

createInvite(options?: CreateInviteOptions, reason?: string): Promise<Invite<"withMetadata", TextChannel>>

Implementation of Invitable.createInvite
- Defined in node_modules/eris/index.d.ts:3486
Parameters
- Optional options: CreateInviteOptions
- Optional reason: string
Returns Promise<Invite<"withMetadata", TextChannel>>

createMessage

createMessage(content: MessageContent, file?: FileContent | FileContent[]): Promise<Message<TextChannel>>

Implementation of GuildTextable.createMessage
- Defined in node_modules/eris/index.d.ts:3487
Parameters
- content: MessageContent
- Optional file: FileContent | FileContent[]
Returns Promise<Message<TextChannel>>

createThreadWithMessage

createThreadWithMessage(messageID: string, options: CreateThreadOptions): Promise<PublicThreadChannel>

- Defined in node_modules/eris/index.d.ts:3488
Parameters
- messageID: string
- options: CreateThreadOptions
Returns Promise<PublicThreadChannel>

createThreadWithoutMessage

createThreadWithoutMessage(options: CreateThreadWithoutMessageOptions<10 | 11 | 12>): Promise<PrivateThreadChannel>

- Defined in node_modules/eris/index.d.ts:3489
Parameters
- options: CreateThreadWithoutMessageOptions<10 | 11 | 12>
Returns Promise<PrivateThreadChannel>

createWebhook

createWebhook(options: { avatar?: null | string; name: string }, reason?: string): Promise<Webhook>

Implementation of GuildTextable.createWebhook
- Defined in node_modules/eris/index.d.ts:3490
Parameters
- options: { avatar?: null | string; name: string }
  - Optional avatar?: null | string
  - name: string
- Optional reason: string
Returns Promise<Webhook>

delete

delete(reason?: string): Promise<void>

Inherited from GuildChannel.delete
- Defined in node_modules/eris/index.d.ts:2837
Parameters
- Optional reason: string
Returns Promise<void>

deleteMessage

deleteMessage(messageID: string, reason?: string): Promise<void>

Implementation of GuildTextable.deleteMessage
- Defined in node_modules/eris/index.d.ts:3491
Parameters
- messageID: string
- Optional reason: string
Returns Promise<void>

deleteMessages

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

Implementation of GuildTextable.deleteMessages
- Defined in node_modules/eris/index.d.ts:3492
Parameters
- messageIDs: string[]
- Optional reason: string
Returns Promise<void>

deletePermission

deletePermission(overwriteID: string, reason?: string): Promise<void>

Inherited from GuildChannel.deletePermission
- Defined in node_modules/eris/index.d.ts:2838
Parameters
- overwriteID: string
- Optional reason: string
Returns Promise<void>

edit

edit(options: Omit<EditChannelOptions, "icon" | "ownerID">, reason?: string): Promise<TextChannel>

Overrides GuildChannel.edit
- Defined in node_modules/eris/index.d.ts:3493
Parameters
- options: Omit<EditChannelOptions, "icon" | "ownerID">
- Optional reason: string
Returns Promise<TextChannel>

editMessage

editMessage(messageID: string, content: MessageContentEdit): Promise<Message<TextChannel>>

Implementation of GuildTextable.editMessage
- Defined in node_modules/eris/index.d.ts:3494
Parameters
- messageID: string
- content: MessageContentEdit
Returns Promise<Message<TextChannel>>

editPermission

editPermission(overwriteID: string, allow: number | bigint, deny: number | bigint, type: PermissionType, reason?: string): Promise<PermissionOverwrite>

Inherited from GuildChannel.editPermission
- Defined in node_modules/eris/index.d.ts:2840
Parameters
- overwriteID: string
- allow: number | bigint
- deny: number | bigint
- type: PermissionType
- Optional reason: string
Returns Promise<PermissionOverwrite>

editPosition

editPosition(position: number, options?: EditChannelPositionOptions): Promise<void>

Inherited from GuildChannel.editPosition
- Defined in node_modules/eris/index.d.ts:2847
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getActiveThreads

getActiveThreads(): Promise<ListedChannelThreads<AnyThreadChannel>>

- Defined in node_modules/eris/index.d.ts:3496
deprecated

Returns Promise<ListedChannelThreads<AnyThreadChannel>>

getArchivedThreads

getArchivedThreads(type: "private", options?: GetArchivedThreadsOptions): Promise<ListedChannelThreads<PrivateThreadChannel>>
getArchivedThreads(type: "public", options?: GetArchivedThreadsOptions): Promise<ListedChannelThreads<PublicThreadChannel>>

- Defined in node_modules/eris/index.d.ts:3497
Parameters
- type: "private"
- Optional options: GetArchivedThreadsOptions
Returns Promise<ListedChannelThreads<PrivateThreadChannel>>
- Defined in node_modules/eris/index.d.ts:3498
Parameters
- type: "public"
- Optional options: GetArchivedThreadsOptions
Returns Promise<ListedChannelThreads<PublicThreadChannel>>

getInvites

getInvites(): Promise<Invite<"withMetadata", TextChannel>[]>

Implementation of Invitable.getInvites

Overrides GuildChannel.getInvites
- Defined in node_modules/eris/index.d.ts:3499
Returns Promise<Invite<"withMetadata", TextChannel>[]>

getJoinedPrivateArchivedThreads

getJoinedPrivateArchivedThreads(options: GetArchivedThreadsOptions): Promise<ListedChannelThreads<PrivateThreadChannel>>

- Defined in node_modules/eris/index.d.ts:3500
Parameters
- options: GetArchivedThreadsOptions
Returns Promise<ListedChannelThreads<PrivateThreadChannel>>

getMessage

getMessage(messageID: string): Promise<Message<TextChannel>>

Implementation of GuildTextable.getMessage
- Defined in node_modules/eris/index.d.ts:3501
Parameters
- messageID: string
Returns Promise<Message<TextChannel>>

getMessageReaction

getMessageReaction(messageID: string, reaction: string, options?: GetMessageReactionOptions): Promise<User[]>
getMessageReaction(messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>

Implementation of GuildTextable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:3502
Parameters
- messageID: string
- reaction: string
- Optional options: GetMessageReactionOptions
Returns Promise<User[]>
Implementation of GuildTextable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:3504
deprecated

Parameters
- messageID: string
- reaction: string
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<User[]>

getMessages

getMessages(options?: GetMessagesOptions): Promise<Message<TextChannel>[]>
getMessages(limit?: number, before?: string, after?: string, around?: string): Promise<Message<TextChannel>[]>

Implementation of GuildTextable.getMessages
- Defined in node_modules/eris/index.d.ts:3505
Parameters
- Optional options: GetMessagesOptions
Returns Promise<Message<TextChannel>[]>
Implementation of GuildTextable.getMessages
- Defined in node_modules/eris/index.d.ts:3507
deprecated

Parameters
- Optional limit: number
- Optional before: string
- Optional after: string
- Optional around: string
Returns Promise<Message<TextChannel>[]>

getPins

getPins(): Promise<Message<TextChannel>[]>

Implementation of GuildPinnable.getPins
- Defined in node_modules/eris/index.d.ts:3508
Returns Promise<Message<TextChannel>[]>

getWebhooks

getWebhooks(): Promise<Webhook[]>

Implementation of GuildTextable.getWebhooks
- Defined in node_modules/eris/index.d.ts:3509
Returns Promise<Webhook[]>

inspect

inspect(): TextChannel

Inherited from GuildChannel.inspect
- Defined in node_modules/eris/index.d.ts:2038
Returns TextChannel

permissionsOf

permissionsOf(memberID: string | Member | MemberRoles): Permission

Inherited from GuildChannel.permissionsOf
- Defined in node_modules/eris/index.d.ts:2849
Parameters
- memberID: string | Member | MemberRoles
Returns Permission

pinMessage

pinMessage(messageID: string): Promise<void>

Implementation of GuildPinnable.pinMessage
- Defined in node_modules/eris/index.d.ts:3510
Parameters
- messageID: string
Returns Promise<void>

purge

purge(options: PurgeChannelOptions): Promise<number>
purge(limit: number, filter?: (message: Message<TextChannel>) => boolean, before?: string, after?: string, reason?: string): Promise<number>

Implementation of GuildTextable.purge
- Defined in node_modules/eris/index.d.ts:3511
Parameters
- options: PurgeChannelOptions
Returns Promise<number>
Implementation of GuildTextable.purge
- Defined in node_modules/eris/index.d.ts:3513
deprecated

Parameters
- limit: number
- Optional filter: (message: Message<TextChannel>) => boolean
  - - (message: Message<TextChannel>): boolean
    - Parameters
      - message: Message<TextChannel>
      Returns boolean
- Optional before: string
- Optional after: string
- Optional reason: string
Returns Promise<number>

removeMessageReaction

removeMessageReaction(messageID: string, reaction: string, userID?: string): Promise<void>

Implementation of GuildTextable.removeMessageReaction
- Defined in node_modules/eris/index.d.ts:3514
Parameters
- messageID: string
- reaction: string
- Optional userID: string
Returns Promise<void>

removeMessageReactionEmoji

removeMessageReactionEmoji(messageID: string, reaction: string): Promise<void>

Implementation of GuildTextable.removeMessageReactionEmoji
- Defined in node_modules/eris/index.d.ts:3515
Parameters
- messageID: string
- reaction: string
Returns Promise<void>

removeMessageReactions

removeMessageReactions(messageID: string): Promise<void>

Implementation of GuildTextable.removeMessageReactions
- Defined in node_modules/eris/index.d.ts:3516
Parameters
- messageID: string
Returns Promise<void>

sendTyping

sendTyping(): Promise<void>

Implementation of GuildTextable.sendTyping
- Defined in node_modules/eris/index.d.ts:3517
Returns Promise<void>

toJSON

toJSON(props?: string[]): JSONCache

Inherited from GuildChannel.toJSON
- Defined in node_modules/eris/index.d.ts:2040
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from GuildChannel.toString
- Defined in node_modules/eris/index.d.ts:2039
Returns string

unpinMessage

unpinMessage(messageID: string): Promise<void>

Implementation of GuildPinnable.unpinMessage
- Defined in node_modules/eris/index.d.ts:3518
Parameters
- messageID: string
Returns Promise<void>

unsendMessage

unsendMessage(messageID: string): Promise<void>

Implementation of GuildTextable.unsendMessage
- Defined in node_modules/eris/index.d.ts:3519
Parameters
- messageID: string
Returns Promise<void>

Static from

from(data: BaseData, client: Client): AnyChannel

Inherited from GuildChannel.from
- Defined in node_modules/eris/index.d.ts:2101
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Static getCreatedAt

getCreatedAt(id: string): number

Inherited from GuildChannel.getCreatedAt
- Defined in node_modules/eris/index.d.ts:2036
Parameters
- id: string
Returns number

Static getDiscordEpoch

getDiscordEpoch(id: string): number

Inherited from GuildChannel.getDiscordEpoch
- Defined in node_modules/eris/index.d.ts:2037
Parameters
- id: string
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: BaseData

client: Client

messageLimit: number

Returns TextChannel

Properties

client

createdAt

defaultAutoArchiveDuration

guild

id

lastMessageID

lastPinTimestamp

mention

messages

name

nsfw

parentID

permissionOverwrites

position

rateLimitPerUser

Optional topic

type

Methods

addMessageReaction

Parameters

messageID: string

reaction: string

Returns Promise<void>

Parameters

messageID: string

reaction: string

userID: string

Returns Promise<void>

createInvite

Parameters

Optional options: CreateInviteOptions

Optional reason: string

Returns Promise<Invite<"withMetadata", TextChannel>>

createMessage

Parameters

content: MessageContent

Optional file: FileContent | FileContent[]

Returns Promise<Message<TextChannel>>

createThreadWithMessage

Parameters

messageID: string

options: CreateThreadOptions

Returns Promise<PublicThreadChannel>

createThreadWithoutMessage

Parameters

options: CreateThreadWithoutMessageOptions<10 | 11 | 12>

Returns Promise<PrivateThreadChannel>

createWebhook

Parameters

options: { avatar?: null | string; name: string }

Optional avatar?: null | string

name: string

Optional reason: string

Returns Promise<Webhook>

delete

Parameters

Optional reason: string

Returns Promise<void>

deleteMessage

Parameters

messageID: string

Optional reason: string

Returns Promise<void>

deleteMessages

Parameters

messageIDs: string[]