`hubsclient.cloudapi`#

Module Contents#

Classes#

`RoomInfo`
`AvatarInfo`
`CloudAPI`

API#

class hubsclient.cloudapi.RoomInfo#

id: str = None#

name: str = None#

description: str = None#

url: str = None#

scene_id: str = None#

room_size: int = None#

lobby_count: int = None#

member_count: int = None#

user_data: dict = None#

is_public: bool = None#

preview_image_url: str = None#

classmethod from_obj(data: dict)#

class hubsclient.cloudapi.AvatarInfo#

id: str = None#

name: str = None#

description: str = None#

url: str = None#

preview_images: dict = None#

gltfs: dict = None#

attributions: dict = None#

allow_remixing: bool = None#

classmethod from_obj(data: dict)#

class hubsclient.cloudapi.CloudAPI(host: str, app_token: str = None, user_token: str = None, user_id: str = None)#

Initialization

Hubs Cloud API client.

Parameters:

host – The host of the room, e.g. “hubs.mozilla.com”
app_token – The API key app token (from https://<host>/token)
user_token – The API key user token (from https://<host>/token)

_gql_app_connect(app_token: str = None)#

_gql_user_connect(user_token: str = None)#

_v1api_query(route: str, params: dict = {}, method: Literal[GET, POST] = 'GET')#

media_search(type: Literal[rooms, scene_listings, avatar_listings, scenes, avatars, favorites, assets], query: str = None, _parser: Callable[[dict], Any] | None = None, page_limit=None, **kwargs)#

get_public_rooms(**kwargs)#

get_avatars(**kwargs)#