Class PinnedMessagesManager

Client-side tracker for pinned messages. Listen to messages.update for pinInChatMessage protocol messages and call manager.pin(jid, msgId, pinnedBy) / manager.unpin(jid, msgId) accordingly.

Index

Constructors

Accessors

Methods

clearExpired clearPins getPinned isPinned pin unpin

Constructors

constructor

new PinnedMessagesManager(): PinnedMessagesManager

Returns PinnedMessagesManager

Accessors

totalPins

get totalPins(): number
Total pin count across all chats.

Returns number
- Defined in lib/Utils/chat-control.d.ts:113

Methods

clearExpired

clearExpired(): number
Evict pins whose expiresAt is in the past.

Returns number
Number of expired pins removed
- Defined in lib/Utils/chat-control.d.ts:111

clearPins

clearPins(jid: string): void
Remove all pins for a chat.
Parameters
- jid: string
Returns void
- Defined in lib/Utils/chat-control.d.ts:106

getPinned

getPinned(jid: string): PinnedMessage[]
Get all pinned messages for a chat.
Parameters
- jid: string
Returns PinnedMessage[]
- Defined in lib/Utils/chat-control.d.ts:102

isPinned

isPinned(jid: string, messageId: string): boolean
Check if a message is pinned in a chat.
Parameters
- jid: string
- messageId: string
Returns boolean
- Defined in lib/Utils/chat-control.d.ts:104

pin

pin(
    jid: string,
    messageId: string,
    pinnedBy?: string,
    expiresAt?: Date,
): PinnedMessage
Record a newly pinned message.
Parameters
- jid: string
- messageId: string
- OptionalpinnedBy: string
- OptionalexpiresAt: Date
Returns PinnedMessage
The created pin entry
- Defined in lib/Utils/chat-control.d.ts:95

unpin

unpin(jid: string, messageId: string): boolean
Remove a pinned message.
Parameters
- jid: string
- messageId: string
Returns boolean
true if the pin was found and removed, false otherwise
- Defined in lib/Utils/chat-control.d.ts:100