Class ChatActionEvent

actionMessage

• get actionMessage(): MessageService | undefined

  The service message that triggered this event (if any).

  Returns MessageService | undefined

addedBy

• get addedBy(): BigInteger | undefined

  The user ID who added someone (if applicable).

  Returns BigInteger | undefined

created

• get created(): boolean

  True if this is a new chat/channel creation.

  Returns boolean

kickedBy

• get kickedBy(): BigInteger | undefined

  The user ID who kicked someone (if applicable).

  Returns BigInteger | undefined

newPhoto

• get newPhoto(): boolean

  True if the chat photo was changed.

  Returns boolean

newPin

• get newPin(): boolean

  True if a message was pinned.

  Returns boolean

newTitle

• get newTitle(): string | undefined

  The new chat title (if changed).

  Returns string | undefined

photo

• get photo(): Api.TypePhoto | undefined

  The new photo object (if available).

  Returns Api.TypePhoto | undefined

photoDeleted

• get photoDeleted(): boolean

  True if the chat photo was deleted.

  Returns boolean

pinnedMessageId

• get pinnedMessageId(): number | undefined

  The first pinned message ID.

  Returns number | undefined

pinnedMessageIds

• get pinnedMessageIds(): number[]

  The IDs of pinned/unpinned messages.

  Returns number[]

unpin

• get unpin(): boolean

  True if a message was unpinned.

  Returns boolean

userAdded

• get userAdded(): boolean

  True if a user was added by someone else.

  Returns boolean

userId

• get userId(): BigInteger | undefined

  The first user ID (convenience getter).

  Returns BigInteger | undefined

userIds

• get userIds(): BigInteger[]

  The user IDs affected by this action.

  Returns BigInteger[]

userJoined

• get userJoined(): boolean

  True if a user joined the chat.

  Returns boolean

userKicked

• get userKicked(): boolean

  True if a user was kicked/banned.

  Returns boolean

userLeft

• get userLeft(): boolean

  True if a user left the chat.

  Returns boolean

constructor

• new ChatActionEvent(
      update: ChatActionUpdate,
      actionMessage?: MessageService,
  ): ChatActionEvent

  Parameters

  • update: ChatActionUpdate
  • OptionalactionMessage: MessageService

  Returns ChatActionEvent

getPinnedMessage

• getPinnedMessage(): Promise<Message | undefined>

  Get the first pinned message.

  Returns Promise<Message | undefined>

getPinnedMessages

• getPinnedMessages(): Promise<Message[] | undefined>

  Get the pinned message(s).

  Returns Promise<Message[] | undefined>

getUser

• getUser(): Promise<User | undefined>

  Get the first affected user.

  Returns Promise<User | undefined>

getUsers

• getUsers(): Promise<User[] | undefined>

  Get the user(s) affected by this action.

  Returns Promise<User[] | undefined>

respond

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

  Respond to the action in the same chat.

  Parameters

  • params: { file?: any; message?: string; parseMode?: any; silent?: boolean }

  Returns Promise<Message | undefined>

_eventName

originalUpdate