talkomatic.py 0.1.2
An easy-to-use Python versatile wrapper for the Talkomatic Bot interface ensuring best practices for making bots, and handling the REST API.
 
Loading...
Searching...
No Matches
talkomatic.dataclasses.room.Room Class Reference

Public Member Functions

"Room" from_raw_json (cls, dict data)
 
bool __eq__ (self, "Room" other)
 
bool __ne__ (self, "Room" other)
 
str __str__ (self)
 

Public Attributes

 room_id = other.room_id
 

Static Public Attributes

RoomLayoutType layout | None
 
list users [User]
 
dict votes [User, list[User]] | None
 
list banned_users [User] | None
 
int last_time_active | None
 
bool is_full | None
 

Protected Member Functions

dict[User, list[User]] _parse_votes (cls, dict data)
 

Detailed Description

A class representing room information.

Composed of:
- room_id (int): The ID of the room.
- name (str): The name of the room.
- room_type (RoomType): The type of the room.
- layout (RoomLayoutType): The layout of the room.
- users (list[User]): The users in the room.
- votes (dict[User, list[User]]): The votes in the room.
- banned_users (list[User]): The banned users in the room.
- last_time_active (int): The last time the room was active.
- is_full (bool): Whether the room is full.

Definition at line 34 of file room.py.

Member Function Documentation

◆ __eq__()

bool talkomatic.dataclasses.room.Room.__eq__ ( self,
"Room" other )

Definition at line 86 of file room.py.

◆ __ne__()

bool talkomatic.dataclasses.room.Room.__ne__ ( self,
"Room" other )

Definition at line 92 of file room.py.

◆ __str__()

str talkomatic.dataclasses.room.Room.__str__ ( self)

Definition at line 95 of file room.py.

◆ _parse_votes()

dict[User, list[User]] talkomatic.dataclasses.room.Room._parse_votes ( cls,
dict data )
protected

Definition at line 61 of file room.py.

◆ from_raw_json()

"Room" talkomatic.dataclasses.room.Room.from_raw_json ( cls,
dict data )

Definition at line 73 of file room.py.

Member Data Documentation

◆ banned_users

list talkomatic.dataclasses.room.Room.banned_users [User] | None
static

Definition at line 56 of file room.py.

◆ is_full

bool talkomatic.dataclasses.room.Room.is_full | None
static

Definition at line 58 of file room.py.

◆ last_time_active

int talkomatic.dataclasses.room.Room.last_time_active | None
static

Definition at line 57 of file room.py.

◆ layout

RoomLayoutType talkomatic.dataclasses.room.Room.layout | None
static

Definition at line 53 of file room.py.

◆ room_id

talkomatic.dataclasses.room.Room.room_id = other.room_id

Definition at line 90 of file room.py.

◆ users

list talkomatic.dataclasses.room.Room.users [User]
static

Definition at line 54 of file room.py.

◆ votes

dict talkomatic.dataclasses.room.Room.votes [User, list[User]] | None
static

Definition at line 55 of file room.py.


The documentation for this class was generated from the following file: