Class CommandMessage

Represents CommandInteraction or Message which contains command.

Hierarchy

CommandMessage

Constructors

Protected constructor

new CommandMessage(): CommandMessage

- Defined in CommandMessage.ts:17
Returns CommandMessage

Properties

Protected _client

_client: Client<boolean> = ...

Protected _command

_command: string = ...

Protected _interaction

_interaction: CommandInteraction<CacheType> = ...

Protected _interactionReplied

_interactionReplied: boolean = false

Protected _message

_message: Message<boolean> = ...

Protected _options

_options: string[] = ...

Protected _rawOptions

_rawOptions: string = ...

Protected _responseMessage

_responseMessage: ResponseMessage = ...

Protected isMessage

isMessage: boolean = false

Accessors

attachments

get attachments(): Collection<string, MessageAttachment>

- Defined in CommandMessage.ts:211
the attatchment of this command message. If this was created from CommandInteraction, this will always return empty collection.

Returns Collection<string, MessageAttachment>

author

get author(): User

- Defined in CommandMessage.ts:138
the author of this command message

Returns User

channel

get channel(): TextBasedChannel

- Defined in CommandMessage.ts:152
the channel of this command message

Returns TextBasedChannel

channelId

get channelId(): string

- Defined in CommandMessage.ts:203
the channel id of this command message

Returns string

command

get command(): string

- Defined in CommandMessage.ts:218
Command name which was resolved

Returns string

content

get content(): string

- Defined in CommandMessage.ts:127
the content of this command message

Returns string

createdAt

get createdAt(): Date

- Defined in CommandMessage.ts:189
the date time of this command message

Returns Date

createdTimestamp

get createdTimestamp(): number

- Defined in CommandMessage.ts:182
the timestamp of this command message

Returns number

guild

get guild(): Guild

- Defined in CommandMessage.ts:159
the guild of this command message

Returns Guild

id

get id(): string

- Defined in CommandMessage.ts:196
the id of this command message

Returns string

member

get member(): GuildMember

- Defined in CommandMessage.ts:145
the memeber of this command message

Returns GuildMember

options

get options(): string[]

- Defined in CommandMessage.ts:225
Command arguments which was resolved

Returns string[]

rawOptions

get rawOptions(): string

- Defined in CommandMessage.ts:232
Raw command arguments

Returns string

reactions

get reactions(): ReactionManager

- Defined in CommandMessage.ts:167
the reactions of this command message If this was created from CommandInteraction, this will always return null.

Returns ReactionManager

response

get response(): ResponseMessage

- Defined in CommandMessage.ts:108
Response message bound to this command message

remarks
Response message may be stale (if you edited it).

Returns ResponseMessage

url

get url(): string

- Defined in CommandMessage.ts:175
the url of this command message If this was created from CommandInteraction, this will always return null.

Returns string

Methods

reply

reply(options: string | MessageOptions): Promise<ResponseMessage>

- Defined in CommandMessage.ts:68
Respond to the command You can call this once

Parameters
- options: string | MessageOptions
  
  message content
Returns Promise<ResponseMessage>
response message bound to this command message

suppressEmbeds

suppressEmbeds(suppress: boolean): Promise<CommandMessage>

- Defined in CommandMessage.ts:116
Set suppress of the embed of command message

Parameters
- suppress: boolean
  
  if true suppressed, otherwise false
Returns Promise<CommandMessage>

Static createFromInteraction

createFromInteraction(interaction: CommandInteraction<CacheType>): CommandMessage

- Defined in CommandMessage.ts:50
Initialize this from interaction

Parameters
- interaction: CommandInteraction<CacheType>
  
  Interaction that contains command
Returns CommandMessage
new CommandMessage instance

Static createFromMessage

createFromMessage(message: Message<boolean>, prefixLength?: number): CommandMessage

- Defined in CommandMessage.ts:24
Initialize this from Message

Parameters
- message: Message<boolean>
  
  Message an user sent that contains command
- prefixLength: number = 1
Returns CommandMessage
new CommandMessage instance

Static Protected createFromMessageWithParsed

createFromMessageWithParsed(message: Message<boolean>, command: string, options: string[], rawOptions: string): CommandMessage

- Defined in CommandMessage.ts:35
Parameters
- message: Message<boolean>
- command: string
- options: string[]
- rawOptions: string
Returns CommandMessage

Static Protected parseCommand

parseCommand(cmd: string, prefixLength: number, textNormalizer: (text: string) => string): { command: string; options: string[]; rawOptions: string }

- Defined in CommandMessage.ts:236
Parameters
- cmd: string
- prefixLength: number
- textNormalizer: (text: string) => string
  - - (text: string): string
    - Parameters
      - text: string
      Returns string
Returns { command: string; options: string[]; rawOptions: string }
- command: string
- options: string[]
- rawOptions: string

Static resolveCommandMessage

resolveCommandMessage(content: string, prefixLength: number, textNormalizer?: (text: string) => string): { command: string; options: string[]; rawOptions: string }

- Defined in CommandMessage.ts:249
Reslolve command and arguments from message content

Parameters
- content: string
  
  message content
- prefixLength: number
  
  prefix length
- textNormalizer: (text: string) => string = ...
  - - (text: string): string
    - Parameters
      - text: string
      Returns string
Returns { command: string; options: string[]; rawOptions: string }
object contains resolved command, parsed arguments and raw argument.
- command: string
- options: string[]
- rawOptions: string

Generated using TypeDoc