Class ContextInfo

client

lexer

parser

queue

args

• get args(): string[]

  Command's arguments (e.g. "000789xxx")

  Returns string[]

authorNumber

• get authorNumber(): string

  Get author phone number of this message.

  Returns string

clickedButtons

• get clickedButtons(): | undefined
  | IListResponseMessage
  | IButtonsResponseMessage
  | ITemplateButtonReplyMessage

  Get detail from clicked button

  Returns
      | undefined
      | IListResponseMessage
      | IButtonsResponseMessage
      | ITemplateButtonReplyMessage

document

• get document(): undefined | Document

  Get a document from this message

  Returns undefined | Document

flags

• get flags(): string[]

  Command's flags (e.g. --flag1, --flag2, /flag3)

  Returns string[]

id

• get id(): string

  Get Message ID

  Returns string

image

• get image(): undefined | Image

  Get an image from this message

  Returns undefined | Image

isFromMe

• get isFromMe(): boolean

  Is this message from me?

  Returns boolean

isGroup

• get isGroup(): boolean

  Is it in a group?

  Returns boolean

isPM

• get isPM(): boolean

  Is it in private-message?

  Returns boolean

participant

• get participant(): undefined | GroupParticipant

  Get GroupParticipant class.

  Returns undefined | GroupParticipant

pollEncKey

• get pollEncKey(): undefined | Uint8Array<ArrayBufferLike>

  Get Poll Enc Key

  Returns undefined | Uint8Array<ArrayBufferLike>

raw

• get raw(): IWebMessageInfo

  Get raw message.

  Returns IWebMessageInfo

sticker

• get sticker(): undefined | Sticker

  Get sticker from this message

  Returns undefined | Sticker

text

• get text(): string

  Get message text.

  Returns string

timestamp

• get timestamp(): number

  Get the timestamp message

  Returns number

video

• get video(): undefined | Video

  Get a video from this message

  Returns undefined | Video

createPoll

• createPoll(
      name: string,
      values: string[],
      selectableOptionsCount?: number,
  ): Promise<undefined | Context>

  Create whatsapp poll/vote

  Parameters

  • name: string

    Poll name
  • values: string[]

    Poll values (options)
  • selectableOptionsCount: number = values.length

    Selectable options count

  Returns Promise<undefined | Context>

delete

• delete(): Promise<undefined | Context>

  Delete this message

  Returns Promise<undefined | Context>

edit

• edit(text: string, options?: IMessage): Promise<void>

  Edit the message text

  Parameters

  • text: string

    Newer text
  • Optionaloptions: IMessage

    IMessage options

  Returns Promise<void>

getCollector

• getCollector(options?: CollectorOptions): MessageCollector

  Get collector instance.

  Parameters

  • Optionaloptions: CollectorOptions

    Message Collector options.

  Returns MessageCollector

getCommand

• getCommand(): undefined | Command

  Get command details.

  Returns undefined | Command

getCommandName

• getCommandName(): string

  Get the command name from message

  Returns string

getCurrentJid

• getCurrentJid(): string

  Get current JID

  Returns string

getGroup

• getGroup(): undefined | GroupContext

  Get group context data (if any)

  Returns undefined | GroupContext

getIdButton

• getIdButton(): undefined | null | string

  Get the id button from message

  Returns undefined | null | string

getOption

• getOption(name: string): string[]

  Get option value

  Parameters

  • name: string

    Option name

  Returns string[]

getPrefix

• getPrefix(): string

  Get the prefix from the message

  Returns string

getReply

• getReply(): undefined | ContextInfo

  Get replied message from this message

  Returns undefined | ContextInfo

isCommand

• isCommand(): boolean

  Knows the message is command.

  Returns boolean

reply

• reply(text: string, options?: AnyMessageContent): Promise<undefined | Context>

  Reply the message

  Parameters

  • text: string

    Text Content
  • Optionaloptions: AnyMessageContent

    Send message options

  Returns Promise<undefined | Context>

replyWithAudio

• replyWithAudio(
      audio: string | Buffer<ArrayBufferLike>,
      isVN?: boolean,
      options?: AnyMessageContent,
  ): Promise<undefined | Context>

  Reply a message with audio

  Parameters

  • audio: string | Buffer<ArrayBufferLike>

    URL/Buffer audio
  • isVN: boolean = false

    Is it voice note?
  • Optionaloptions: AnyMessageContent

    Send message options

  Returns Promise<undefined | Context>

replyWithButton

• replyWithButton<T extends ButtonType>(
      content: AnyMessageContent | ButtonBuilder<T>,
  ): Promise<undefined | Context>

  Reply a message using button template

  Type Parameters

  • T extends ButtonType

  Parameters

  • content: AnyMessageContent | ButtonBuilder<T>

    Reply message options

  Returns Promise<undefined | Context>

replyWithPhoto

• replyWithPhoto(
      photo: string | Buffer<ArrayBufferLike>,
      caption?: string,
      options?: AnyMessageContent,
  ): Promise<undefined | Context>

  Reply a message with photo

  Parameters

  • photo: string | Buffer<ArrayBufferLike>

    A Photo
  • Optionalcaption: string

    A Photo caption
  • Optionaloptions: AnyMessageContent

    Send message options

  Returns Promise<undefined | Context>

replyWithSticker

• replyWithSticker(
      sticker: string | Buffer<ArrayBufferLike>,
      options?: AnyMessageContent,
  ): Promise<undefined | Context>

  Reply a message using sticker

  Parameters

  • sticker: string | Buffer<ArrayBufferLike>

    Sticker URL or Buffer
  • Optionaloptions: AnyMessageContent

    Reply message options

  Returns Promise<undefined | Context>

replyWithVideo

• replyWithVideo(
      video: string | Buffer<ArrayBufferLike>,
      caption?: string,
      options?: AnyMessageContent,
  ): Promise<undefined | Context>

  Reply a message with video

  Parameters

  • video: string | Buffer<ArrayBufferLike>

    Video source want to send.
  • Optionalcaption: string

    Video caption
  • Optionaloptions: AnyMessageContent

    Send message options

  Returns Promise<undefined | Context>

send

• send(text: string, options?: AnyMessageContent): Promise<undefined | Context>

  Only send a message without reply.

  Parameters

  • text: string

    Send a text
  • Optionaloptions: AnyMessageContent

    Send message options

  Returns Promise<undefined | Context>

sendRaw

• sendRaw(
      raw: AnyMessageContent,
      miscOpt?: MiscMessageGenerationOptions,
  ): Promise<undefined | Context>

  Send raw message

  Parameters

  • raw: AnyMessageContent

    AnyMessageContent message options
  • OptionalmiscOpt: MiscMessageGenerationOptions

    Misc message generation options

  Returns Promise<undefined | Context>

syncGroup

• syncGroup(): Promise<boolean>

  If the chat is in a group, add it to cache.

  Returns Promise<boolean>