Class TextChannel

Hierarchy

GuildChannel
- TextChannel
  - NewsChannel

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

new TextChannel(data: BaseData, guild: Guild, messageLimit: number): TextChannel

Inherited from GuildChannel.constructor
- Defined in node_modules/eris/index.d.ts:2376
Parameters
- data: BaseData
- guild: Guild
- messageLimit: number
Returns TextChannel

Properties

client

client: Client

createdAt

createdAt: number

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

topic

topic: null | string

type

type: 0 | 5

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:2378
Parameters
- messageID: string
- reaction: string
Returns Promise<void>
Implementation of GuildTextable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:2380
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:2381
Parameters
- Optional options: CreateInviteOptions
- Optional reason: string
Returns Promise<Invite<"withMetadata", TextChannel>>

createMessage

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

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

createWebhook

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

- Defined in node_modules/eris/index.d.ts:2383
Parameters
- options: { avatar?: undefined | null | string; name: string }
  - Optional avatar?: undefined | 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:1961
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:2384
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:2385
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:1962
Parameters
- overwriteID: string
- Optional reason: string
Returns Promise<void>

edit

edit(options: Pick<EditChannelOptions, "bitrate" | "nsfw" | "parentID" | "rateLimitPerUser" | "topic" | "userLimit" | "name" | "rtcRegion" | "videoQualityMode">, reason?: string): Promise<TextChannel>

Overrides GuildChannel.edit
- Defined in node_modules/eris/index.d.ts:2386
Parameters
- options: Pick<EditChannelOptions, "bitrate" | "nsfw" | "parentID" | "rateLimitPerUser" | "topic" | "userLimit" | "name" | "rtcRegion" | "videoQualityMode">
- Optional reason: string
Returns Promise<TextChannel>

editMessage

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

Implementation of GuildTextable.editMessage
- Defined in node_modules/eris/index.d.ts:2387
Parameters
- messageID: string
- content: MessageContent
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:1964
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:1971
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getInvites

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

Implementation of Invitable.getInvites

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

getMessage

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

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

getMessageReaction

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:2390
Parameters
- messageID: string
- reaction: string
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<User[]>

getMessages

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

Implementation of GuildTextable.getMessages
- Defined in node_modules/eris/index.d.ts:2397
Parameters
- Optional limit: number
- Optional before: string
- Optional after: string
- Optional around: string
Returns Promise<Message<TextChannel>[]>

getPins

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

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

getWebhooks

getWebhooks(): Promise<Webhook[]>

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

inspect

inspect(): TextChannel

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

permissionsOf

permissionsOf(memberID: string | Member): Permission

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

pinMessage

pinMessage(messageID: string): Promise<void>

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

purge

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

- Defined in node_modules/eris/index.d.ts:2401
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:2402
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:2403
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:2404
Parameters
- messageID: string
Returns Promise<void>

sendTyping

sendTyping(): Promise<void>

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

toJSON

toJSON(props?: string[]): JSONCache

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

toString

toString(): string

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

unpinMessage

unpinMessage(messageID: string): Promise<void>

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

unsendMessage

unsendMessage(messageID: string): Promise<void>

Implementation of GuildTextable.unsendMessage
- Defined in node_modules/eris/index.d.ts:2407
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:1325
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Generated using TypeDoc