Thread Models

Classes for representing conversations.

Thread

class fbchat_muqit.Thread

Bases: Struct

A Thread could be either User, Group, Community

all_participants: Tuple[User]

A Tuple of User object contains Thread participant’s information.

approval_mode: int

Thread’s approval mode. when value is 1 approval mode is on else off

description: str | None

Thread’s description

folder: ThreadFolder

The Thread folder’s location (Inbox, Archaive e.g.)

group_approval_queue: Tuple[Dict]

A tuple of dict containing the id of the requested and inviter users id.

image: str | None

Thread Cover photo

is_joined: bool

Wether the Client is a participant of the Thread.

is_pinned: bool

True if the Thread has a message pinned.

Invite link of the Thread to join.

joinable_mode: int

Wether join through Link is enabled in Thread

message_count: int

Total messages sent to the Thread

name: str

The name of the Thread

participants_nickname: Dict[str, str] | None

A dict containing Thread participant’s user Id as key and nickname as value.

pinned_messages: List | None

Pinned messages Id in the Thread

privacy_mode: int

Thread Privacy

thread_admins: Tuple[str]

A tuple of Thread admins Id

thread_id: str

The `Thread`s Id

thread_theme: Dict | None

Thread’s theme data

thread_type: ThreadType

Type of the Thread (User, Group, Page e.g.)

ThreadType

class fbchat_muqit.ThreadType

Bases: Enum

Messenger Chat Thread Type

COMMUNITY = 2
GROUP = 2
PAGE = 3
UNKNOWN = 3
USER = 1

ThreadFolder

class fbchat_muqit.ThreadFolder

Bases: Enum

Folder Location

ARCHIVE = 'ARCHIVE'
COMMUNITY = 'COMMUNITY'
E2EE = 'E2EE_CUTOVER'
INBOX = 'INBOX'
OTHER = 'OTHER'
PENDING = 'PENDING'
SPAM = 'SPAM'