Skip to content

Context

SkyWayContext

SkyWayContext()

SkyWay Python SDK 全体の設定を行うコンテキスト。

version class-attribute instance-attribute

version = __version__

SkyWay Python SDK のバージョン。

is_setup instance-attribute

is_setup = False

SkyWayContext がセットアップ済みの場合 True、そうでない場合 False。

setup async

setup(token: str) -> None

SkyWayContext をセットアップし、SkyWayの操作を利用可能にする。

create_room async

create_room(name: str | None = None, metadata: str | None = None) -> Room

新しい Room を作成する。

find_room async

find_room(id: str, name: None) -> Room
find_room(id: None, name: str) -> Room
find_room(id: str, name: str) -> Room
find_room(id: str | None = None, name: str | None = None) -> Room

IDまたはNameからRoomを検索して取得する。

find_or_create_room async

find_or_create_room(name: str, metadata: str | None = None) -> Room

NameでRoomを検索し、存在しなければ作成してRoomを返す。

dispose async

dispose() -> None

SkyWayContext を破棄し、使用していたリソースを解放する。