Class Context

Hierarchy

Context
- ContextInfo

Index

Constructors

constructor

new Context(client: Client, rawMessage: IWebMessageInfo, groupSync?: null | boolean): Context
Parameters
- client: Client
  
  Gampang Client
- rawMessage: IWebMessageInfo
  
  Baileys proto.IWebMessageInfo
- groupSync: null | boolean = false
  
  Sync group mode
Returns Context
- Defined in src/structures/context.ts:39

Properties

client

client: Client

Gampang Client

lexer

lexer: Lexer

parser

parser: Parser

`Private` rawMessage

rawMessage: IWebMessageInfo

Baileys proto.IWebMessageInfo

Accessors

`Private` #data

get #data(): ParserResult
Get lexure raw data

Returns ParserResult
- Defined in src/structures/context.ts:723

args

get args(): string[]
Command's arguments (e.g. "000789xxx")

Returns string[]
- Defined in src/structures/context.ts:741

authorNumber

get authorNumber(): string
Get author phone number of this message.

Returns

Returns string
- Defined in src/structures/context.ts:336

clickedButtons

get clickedButtons(): undefined | IListResponseMessage | ITemplateButtonReplyMessage | IButtonsResponseMessage
Get detail from clicked button

Returns

Returns undefined | IListResponseMessage | ITemplateButtonReplyMessage | IButtonsResponseMessage
- Defined in src/structures/context.ts:145

document

get document(): undefined | Document
Get a document from this message

Returns

Returns undefined | Document
- Defined in src/structures/context.ts:313

flags

get flags(): string[]
Command's flags (e.g. --flag1, --flag2, /flag3)

Returns string[]
- Defined in src/structures/context.ts:748

id

get id(): string
Get Message ID

Returns

Returns string
- Defined in src/structures/context.ts:67

image

get image(): undefined | Image
Get an image from this message

Returns

Returns undefined | Image
- Defined in src/structures/context.ts:302

isFromMe

get isFromMe(): boolean
Is this message from me?

Returns

Returns boolean
- Defined in src/structures/context.ts:87

isGroup

get isGroup(): boolean
Is it in a group?

Returns boolean
- Defined in src/structures/context.ts:347

isPM

get isPM(): boolean
Is it in private-message?

Returns boolean
- Defined in src/structures/context.ts:354

participant

get participant(): undefined | GroupParticipant
Get GroupParticipant class.

Returns

Returns undefined | GroupParticipant
- Defined in src/structures/context.ts:115

pollEncKey

get pollEncKey(): undefined | Uint8Array
Get Poll Enc Key

Returns

Returns undefined | Uint8Array
- Defined in src/structures/context.ts:75

raw

get raw(): IWebMessageInfo
Get raw message.

Returns IWebMessageInfo
- Defined in src/structures/context.ts:716

sticker

get sticker(): undefined | Sticker
Get sticker from this message

Returns

Returns undefined | Sticker
- Defined in src/structures/context.ts:134

text

get text(): string
Get message text.

Returns

Returns string
- Defined in src/structures/context.ts:362

timestamp

get timestamp(): number
Get the timestamp message

Returns

Returns number
- Defined in src/structures/context.ts:397

video

get video(): undefined | Video
Get a video from this message

Returns

Returns undefined | Video
- Defined in src/structures/context.ts:326

Methods

createPoll

createPoll(name: string, values: string[], selectableOptionsCount?: number): Promise<undefined | Context>
Create whatsapp poll/vote

Returns
Parameters
- name: string
  
  Poll name
- values: string[]
  
  Poll values (options)
- selectableOptionsCount: number = values.length
  
  Selectable options count
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:649

delete

delete(): Promise<undefined | Context>
Delete this message

Returns

Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:602

edit

edit(text: string, options?: IMessage): Promise<void>
[EXPERIMENTAL] Edit the message text

Returns
Parameters
- text: string
  
  Newer text
- Optional options: IMessage
  
  IMessage options
Returns Promise<void>
- Defined in src/structures/context.ts:678

getCollector

getCollector(options?: CollectorOptions): MessageCollector
Get collector instance.

Returns
Parameters
- Optional options: CollectorOptions
  
  Message Collector options.
Returns MessageCollector
- Defined in src/structures/context.ts:709

getCommand

getCommand(): undefined | Command
Get command details.

Returns

Returns undefined | Command
- Defined in src/structures/context.ts:161

getCommandName

getCommandName(): string
Get the command name from message

Returns

Returns string
- Defined in src/structures/context.ts:267

getCurrentJid

getCurrentJid(): string
Get current JID

Returns

Returns string
- Defined in src/structures/context.ts:104

getGroup

getGroup(): undefined | GroupContext
Get group context data (if any)

Returns

Returns undefined | GroupContext
- Defined in src/structures/context.ts:96

getIdButton

getIdButton(): undefined | null | string
Get the id button from message

Returns

Returns undefined | null | string
- Defined in src/structures/context.ts:286

getOption

getOption(name: string): string[]
Get option value

Returns
Parameters
- name: string
  
  Option name
Returns string[]
- Defined in src/structures/context.ts:277

getPrefix

getPrefix(): string
Get the prefix from the message

Returns

Returns string
- Defined in src/structures/context.ts:253

getReply

getReply(): undefined | ContextInfo
Get replied message from this message

Returns

Returns undefined | ContextInfo
- Defined in src/structures/context.ts:379

isCommand

isCommand(): boolean
Knows the message is command.

Returns

Returns boolean
- Defined in src/structures/context.ts:243

reply

reply(text: string, options?: AnyMessageContent): Promise<undefined | Context>
Reply the message
Parameters
- text: string
  
  Text Content
- Optional options: AnyMessageContent
  
  Send message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:409

replyWithAudio

replyWithAudio(audio: string | Buffer, isVN?: boolean, options?: AnyMessageContent): Promise<undefined | Context>
Reply a message with audio
Parameters
- audio: string | Buffer
  
  URL/Buffer audio
- isVN: boolean = false
  
  Is it voice note?
- Optional options: AnyMessageContent
  
  Send message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:427

replyWithButton

replyWithButton<T>(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>
- Defined in src/structures/context.ts:589

replyWithPhoto

replyWithPhoto(photo: string | Buffer, caption?: string, options?: AnyMessageContent): Promise<undefined | Context>
Reply a message with photo
Parameters
- photo: string | Buffer
  
  A Photo
- Optional caption: string
  
  A Photo caption
- Optional options: AnyMessageContent
  
  Send message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:532

replyWithSticker

replyWithSticker(sticker: string | Buffer, options?: AnyMessageContent): Promise<undefined | Context>
Reply a message using sticker
Parameters
- sticker: string | Buffer
  
  Sticker URL or Buffer
- Optional options: AnyMessageContent
  
  Reply message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:564

replyWithVideo

replyWithVideo(video: string | Buffer, caption?: string, options?: AnyMessageContent): Promise<undefined | Context>
Reply a message with video
Parameters
- video: string | Buffer
  
  Video source want to send.
- Optional caption: string
  
  Video caption
- Optional options: AnyMessageContent
  
  Send message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:456

send

send(text: string, options?: AnyMessageContent): Promise<undefined | Context>
Only send a message without reply.
Parameters
- text: string
  
  Send a text
- Optional options: AnyMessageContent
  
  Send message options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:491

sendRaw

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

Returns
Parameters
- raw: AnyMessageContent
  
  AnyMessageContent message options
- Optional miscOpt: MiscMessageGenerationOptions
  
  Misc message generation options
Returns Promise<undefined | Context>
- Defined in src/structures/context.ts:504

syncGroup

syncGroup(): Promise<boolean>
If the chat is in a group, add it to cache.

Returns

Returns Promise<boolean>
- Defined in src/structures/context.ts:189

Generated using TypeDoc