TelegramEx.Types.Message (TelegramEx v1.3.0)

Copy Markdown View Source

Struct representing a Telegram Message object.

Contains incoming message fields used by handlers.

Fields

  • :message_id - Unique message identifier
  • :from - Sender information (map with string keys)
  • :chat - Chat information (map with string keys)
  • :date - Message date as Unix timestamp
  • :text - Message text content (nil if not a text message)
  • :photo - List of photo sizes (nil if no photo)
  • :document - Document attachment (nil if no document)
  • :sticker - Sticker (nil if no sticker)
  • :video - Video (nil if no video)
  • :voice - Voice message (nil if no voice)
  • :caption - Caption for media (nil if no caption)
  • :message_thread_id - Thread ID for forum chats (nil if not in a thread)

Summary

Types

t()

Message struct type.

Functions

Converts a raw Telegram API message map to a Message struct.

Types

t()

@type t() :: %TelegramEx.Types.Message{
  audio: map() | nil,
  caption: String.t() | nil,
  chat: map(),
  date: integer(),
  document: map() | nil,
  from: map(),
  message_id: integer(),
  message_thread_id: integer() | nil,
  photo: [map()] | nil,
  reply_to_message: t() | nil,
  sticker: map() | nil,
  text: String.t() | nil,
  video: map() | nil,
  voice: map() | nil
}

Message struct type.

Contains all fields from a Telegram message update.

Functions

from_map(map)

@spec from_map(nil) :: nil
@spec from_map(map()) :: t()

Converts a raw Telegram API message map to a Message struct.