talkomatic.api.v1.rooms Namespace Reference

Classes
class	RoomJoinStatus

Functions
list[Room]	get_rooms ()
Room	get_room (int room_id)
int	create_room (str room_name, RoomType room_type, RoomLayoutType layout)
RoomJoinStatus	can_join_room (int room_id, int|None access_code=None)

Function Documentation

can_join_room()

RoomJoinStatus talkomatic.api.v1.rooms.can_join_room	(	int	room_id,
		int | None	access_code = None )

Check if a room can be joined by the user.

Args:
    room_id (int): The ID of the room.
    access_code (int, optional): The access code of the room.

Returns:
    bool: Whether the room can be joined.

Definition at line 69 of file rooms.py.

create_room()

int talkomatic.api.v1.rooms.create_room	(	str	room_name,
		RoomType	room_type,
		RoomLayoutType	layout )

Create a room on the Talkomatic REST API with its name, type and layout.

Args:
    room_name (str): The name of the room.
    room_type (RoomType): The type of the room.
    layout (RoomLayoutType): The layout of the room.

Returns:
    int: The ID of the created room.

Definition at line 35 of file rooms.py.

get_room()

Room talkomatic.api.v1.rooms.get_room

(

int

room_id

)

Get a room (including private rooms) from the Talkomatic REST API by ID.

Args:
    room_id (int): The ID of the room.

Returns:
    Room: The room with the given ID.

Definition at line 21 of file rooms.py.

get_rooms()

list[Room] talkomatic.api.v1.rooms.get_rooms

(

)

Get all visible (public/semi-private) rooms from the Talkomatic REST API.

Returns:
    list[Room]: A list of all visible rooms.

Definition at line 10 of file rooms.py.