Class Chat

constructor

• new Chat(client, IncomingMessage, logger, limitter, contact): Chat

• Chat class constructor

  Parameters

  • client: Client

    Open whatsaapp client instance

  • IncomingMessage: Message

    Open whatsapp .onMessage message instance

  • logger: Logger

    Pino logger instance

  • limitter: Limit

    p-limit instance for limitting message

  • contact: Contact

    Current chatter contact instance

  Returns Chat

args

client

Optional gameProperty

logger

message

Optional user

isDMChat

• get isDMChat(): boolean

• Is current chatter sending message via DM chat

  Returns boolean

isGroupChat

• get isGroupChat(): boolean

• Is current chatter sending message via Group chat

  Returns boolean

isJoiningGame

• get isJoiningGame(): undefined | boolean

• Is current chatter joinin a game session

  Returns undefined | boolean

getContactProfilePicture

• getContactProfilePicture(): Promise<string>

• Get current contact profile picture string

  Returns Promise<string>

hasMediaInCurrentChat

• hasMediaInCurrentChat(): Promise<{
      currentChat: Message;
      currentMedia: MessageMedia;
      hasMedia: true;
  } | {
      currentChat: undefined;
      currentMedia: undefined;
      hasMedia: false;
  }>

• Current chatter have message media in it

  Returns Promise<{
      currentChat: Message;
      currentMedia: MessageMedia;
      hasMedia: true;
  } | {
      currentChat: undefined;
      currentMedia: undefined;
      hasMedia: false;
  }>

hasQuotedMessageMedia

• hasQuotedMessageMedia(): Promise<{
      hasQuotedMessage: true;
      quotedMessage: Message;
      quotedMessageMedia: MessageMedia;
  } | {
      hasQuotedMessage: false;
      quotedMessage: undefined;
      quotedMessageMedia: undefined;
  }>

• Current chatter have quoted message that have media in it

  Returns Promise<{
      hasQuotedMessage: true;
      quotedMessage: Message;
      quotedMessageMedia: MessageMedia;
  } | {
      hasQuotedMessage: false;
      quotedMessage: undefined;
      quotedMessageMedia: undefined;
  }>

reactToCurrentPerson

• reactToCurrentPerson(emoji): Promise<void>

• Send reaction to current person chatter

  Parameters

  • emoji: string

    Emoji that will sended

  Returns Promise<void>

replyToCurrentPerson

• replyToCurrentPerson(content, image?): Promise<void>

• Reply current chatter using text or image with caption to current person chatter

  Parameters

  • content: MessageContent | MessageSendOptions

    The text that will sended

  • Optional image: MessageMedia

    Image that will sended in base64 data URL (Optional)

  Returns Promise<void>

sendToCurrentPerson

• sendToCurrentPerson(content, image?): Promise<void>

• Send text or image with caption to current person chatter

  Parameters

  • content: MessageContent | MessageSendOptions

    The text that will sended

  • Optional image: MessageMedia

    Image that will sended in base64 data URL (Optional)

  Returns Promise<void>

sendToOtherPerson

• sendToOtherPerson(to, content, image?): Promise<void>

• Send text or image with caption to someone

  Parameters

  • to: string

  • content: MessageContent | MessageSendOptions

    The text that will sended

  • Optional image: MessageMedia

    Image that will sended in base64 data URL (Optional)

  Returns Promise<void>

setUserAndGameProperty

• setUserAndGameProperty(user, gameProperty): void

• User property setter

  Parameters

  • user: {}

    An user document by phone number

  • gameProperty: {}

  Returns void