Class NewMessageEvent

patternMatch

• get patternMatch(): RegExpMatchArray | undefined

  The regex match object from the pattern filter (if any).

  Returns RegExpMatchArray | undefined

constructor

• new NewMessageEvent(
      message: Message,
      originalUpdate: TypeUpdates | TypeUpdate,
  ): NewMessageEvent

  Parameters

  • message: Message
  • originalUpdate: TypeUpdates | TypeUpdate

  Returns NewMessageEvent

_setClient

• _setClient(client: TelegramClient): void

  Parameters

  • client: TelegramClient

  Returns void

delete

• delete(params?: { revoke?: boolean }): Promise<AffectedMessages[] | undefined>

  Deletes the message.

  Parameters

  • params: { revoke?: boolean } = {}

  Returns Promise<AffectedMessages[] | undefined>

edit

• edit(
      params: {
          file?: any;
          formattingEntities?: TypeMessageEntity[];
          message?: string;
          parseMode?: any;
      },
  ): Promise<Message | undefined>

  Edits the message (only own messages can be edited).

  Parameters

  • params: {
        file?: any;
        formattingEntities?: TypeMessageEntity[];
        message?: string;
        parseMode?: any;
    }

  Returns Promise<Message | undefined>

forward

• forward(chat: EntityLike): Promise<Message[] | undefined>

  Forwards the message to another chat.

  Parameters

  • chat: EntityLike

  Returns Promise<Message[] | undefined>

markRead

• markRead(): Promise<boolean | undefined>

  Marks the message as read.

  Returns Promise<boolean | undefined>

pin

• pin(
      params?: { notify?: boolean; pmOneside?: boolean },
  ): Promise<Message | undefined>

  Pins the message.

  Parameters

  • Optionalparams: { notify?: boolean; pmOneside?: boolean }

  Returns Promise<Message | undefined>

reply

• reply(
      params: {
          file?: any;
          formattingEntities?: TypeMessageEntity[];
          linkPreview?: boolean;
          message?: string;
          parseMode?: any;
          silent?: boolean;
      },
  ): Promise<Message | undefined>

  Replies to the message (with a reply header).

  Parameters

  • params: {
        file?: any;
        formattingEntities?: TypeMessageEntity[];
        linkPreview?: boolean;
        message?: string;
        parseMode?: any;
        silent?: boolean;
    }

  Returns Promise<Message | undefined>

respond

• respond(
      params: {
          file?: any;
          formattingEntities?: TypeMessageEntity[];
          linkPreview?: boolean;
          message?: string;
          parseMode?: any;
          silent?: boolean;
      },
  ): Promise<Message | undefined>

  Responds to the message in the same chat (without reply header).

  Parameters

  • params: {
        file?: any;
        formattingEntities?: TypeMessageEntity[];
        linkPreview?: boolean;
        message?: string;
        parseMode?: any;
        silent?: boolean;
    }

  Returns Promise<Message | undefined>

unpin

• unpin(): Promise<void>

  Unpins the message.

  Returns Promise<void>

message

originalUpdate