Class Message<ChannelType>

Type parameters

ChannelType: TextChannel = TextChannel

Hierarchy

BaseStructure<APIMessage>
- Message

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Message<ChannelType>(client: Client, data?: APIMessage): Message<ChannelType>

Inherited from BaseStructure.constructor
- Defined in src/structures/templates/BaseStructure.ts:16
Type parameters
- ChannelType: TextChannel = TextChannel
Parameters
- client: Client
- Optional data: APIMessage
Returns Message<ChannelType>

Properties

attachments

attachments: MessageAttachment[] = []

author

author: ExtendedUser | User

channelId

channelId: string

client

client: Client

content

content: string

editedTimestamp

editedTimestamp: null | number = null

embeds

embeds: MessageEmbed[] = []

flags

flags: MessageFlags = ...

guildId

guildId: null | string = null

id

id: string

nonce

nonce: null | string | number = null

pinned

pinned: boolean = false

reference

reference: null | MessageReference = null

timestamp

timestamp: number

tts

tts: boolean = false

type

type: MessageType = MessageType.Default

Accessors

channel

get channel(): ChannelType

- Defined in src/structures/Message.ts:33
Returns ChannelType

createdAt

get createdAt(): Date

Overrides BaseStructure.createdAt
- Defined in src/structures/Message.ts:51
Returns Date

createdTimestamp

get createdTimestamp(): number

Overrides BaseStructure.createdTimestamp
- Defined in src/structures/Message.ts:48
Returns number

editedAt

get editedAt(): null | Date

- Defined in src/structures/Message.ts:57
Returns null | Date

guild

get guild(): null | Guild

- Defined in src/structures/Message.ts:29
Returns null | Guild

member

get member(): null | GuildMember

- Defined in src/structures/Message.ts:43
Returns null | GuildMember

referencedMessage

get referencedMessage(): null | Message<TextChannel>

- Defined in src/structures/Message.ts:64
Returns null | Message<TextChannel>

Methods

_deserialise

_deserialise(data: APIMessage): Message<ChannelType>

Overrides BaseStructure._deserialise
- Defined in src/structures/Message.ts:73
Parameters
- data: APIMessage
Returns Message<ChannelType>

_modify

_modify(data: Partial<APIMessage>, files?: File[]): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:118
Parameters
- data: Partial<APIMessage>
- Optional files: File[]
Returns Promise<Message<ChannelType>>

attach

attach(...files: (FileResolvable | MessagePayloadAttachment)[]): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:165
Parameters
- Rest ...files: (FileResolvable | MessagePayloadAttachment)[]
Returns Promise<Message<ChannelType>>

delete

delete(): Promise<void>

- Defined in src/structures/Message.ts:135
Returns Promise<void>

edit

edit(content: string | MessagePayload | MessagePayloadData): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:129
Parameters
- content: string | MessagePayload | MessagePayloadData
Returns Promise<Message<ChannelType>>

fetchMember

fetchMember(): Promise<GuildMember> | Promise<null>

- Defined in src/structures/Message.ts:125
Returns Promise<GuildMember> | Promise<null>

removeAttachments

removeAttachments(): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:159
Returns Promise<Message<ChannelType>>

reply

reply(content: string | MessagePayload | MessagePayloadData, cache?: boolean): Promise<Message<TextChannel>>

- Defined in src/structures/Message.ts:175
Parameters
- content: string | MessagePayload | MessagePayloadData
- cache: boolean = false
Returns Promise<Message<TextChannel>>

setFlags

setFlags(flags: number | MessageFlags): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:142
Parameters
- flags: number | MessageFlags
Returns Promise<Message<ChannelType>>

suppressEmbeds

suppressEmbeds(suppress: boolean): Promise<Message<ChannelType>>

- Defined in src/structures/Message.ts:151
alias
Message.setFlags

Parameters
- suppress: boolean
Returns Promise<Message<ChannelType>>

toJSON

toJSON(): APIMessage

Overrides BaseStructure.toJSON
- Defined in src/structures/Message.ts:190
Returns APIMessage

Static toJSON

toJSON(data: any): any

Inherited from BaseStructure.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc