Class MessageReadEvent

Represents a message read event.

Hierarchy

EventCommon
- MessageReadEvent

Index

Accessors

chat chatId client contents inbox inputChat isChannel isGroup isPrivate isRead maxId messageIds outbox

Constructors

Methods

initChatClass _refetchChat _setClient getChat getInputChat getMessages

Properties

_broadcast? _chat? _chatPeer? _client? _entities _eventName _inputChat? _messageId? originalUpdate

Accessors

chat

get chat(): Entity | undefined
Returns Entity | undefined
Inherited from EventCommon.chat
- Defined in teleproto/tl/custom/chatGetter.ts:32

chatId

get chatId(): BigInteger | undefined
Returns BigInteger | undefined
Inherited from EventCommon.chatId
- Defined in teleproto/tl/custom/chatGetter.ts:91

client

get client(): TelegramClient<Session> | undefined
Returns TelegramClient<Session> | undefined
Inherited from EventCommon.client
- Defined in teleproto/events/common.ts:183

contents

get contents(): boolean
True if this is a content read (e.g., voice message played).

Returns boolean
- Defined in teleproto/events/MessageRead.ts:189

inbox

get inbox(): boolean
True if YOU read someone else's messages (inbox read).

Returns boolean
- Defined in teleproto/events/MessageRead.ts:182

inputChat

get inputChat(): EntityLike | undefined
Returns EntityLike | undefined
Inherited from EventCommon.inputChat
- Defined in teleproto/tl/custom/chatGetter.ts:52

isChannel

get isChannel(): boolean
Returns boolean
Inherited from EventCommon.isChannel
- Defined in teleproto/tl/custom/chatGetter.ts:117

isGroup

get isGroup(): boolean | undefined
Returns boolean | undefined
Inherited from EventCommon.isGroup
- Defined in teleproto/tl/custom/chatGetter.ts:103

isPrivate

get isPrivate(): boolean | undefined
Returns boolean | undefined
Inherited from EventCommon.isPrivate
- Defined in teleproto/tl/custom/chatGetter.ts:97

isRead

get isRead(): boolean
Whether any message IDs are available.

Returns boolean
- Defined in teleproto/events/MessageRead.ts:204

maxId

get maxId(): number
Up to which message ID has been read. Every message with ID <= maxId has been read.

Returns number
- Defined in teleproto/events/MessageRead.ts:168

messageIds

get messageIds(): number[]
The IDs of messages whose contents were read. Only set when contents is True.

Returns number[]
- Defined in teleproto/events/MessageRead.ts:197

outbox

get outbox(): boolean
True if someone else read YOUR messages (outbox read).

Returns boolean
- Defined in teleproto/events/MessageRead.ts:175

Constructors

constructor

new MessageReadEvent(update: ReadUpdateType): MessageReadEvent
Parameters
- update: ReadUpdateType
Returns MessageReadEvent
Overrides EventCommon.constructor
- Defined in teleproto/events/MessageRead.ts:121

Methods

`Static`initChatClass

initChatClass(c: any, __namedParameters: ChatGetterConstructorParams): void
Parameters
- c: any
- __namedParameters: ChatGetterConstructorParams
Returns void
Inherited from EventCommon.initChatClass
- Defined in teleproto/tl/custom/chatGetter.ts:21

_refetchChat

_refetchChat(): Promise<void>
Returns Promise<void>
Inherited from EventCommon._refetchChat
- Defined in teleproto/tl/custom/chatGetter.ts:121

_setClient

_setClient(client: TelegramClient): void
Parameters
- client: TelegramClient
Returns void
Inherited from EventCommon._setClient
- Defined in teleproto/events/common.ts:179

getChat

getChat(): Promise<Entity | undefined>
Returns Promise<Entity | undefined>
Inherited from EventCommon.getChat
- Defined in teleproto/tl/custom/chatGetter.ts:36

getInputChat

getInputChat(): Promise<EntityLike | undefined>
Returns Promise<EntityLike | undefined>
Inherited from EventCommon.getInputChat
- Defined in teleproto/tl/custom/chatGetter.ts:63

getMessages

getMessages(): Promise<Message[] | undefined>
Gets messages that were read (if message IDs are available). Only works for content reads.

Returns Promise<Message[] | undefined>
- Defined in teleproto/events/MessageRead.ts:212

Properties

`Optional`_broadcast

_broadcast?: boolean

`Optional`_chat

_chat?: Entity

`Optional`_chatPeer

_chatPeer?: EntityLike

`Optional`_client

_client?: TelegramClient<Session>

_entities

_entities: Map<string, Entity>

_eventName

_eventName: string = "MessageRead"

`Optional`_inputChat

_inputChat?: EntityLike

`Optional`_messageId

_messageId?: number

originalUpdate

originalUpdate: ReadUpdateType & { _entities?: Map<string, Entity> }