Skip to main content
room(options?) Returns configuration information about the room you’re currently connected to, including room-level settings, domain-level settings, and any token configuration. Also available after preAuth(), before joining. If a room URL has been specified but join() hasn’t completed yet, resolves with { roomUrlPendingJoin: string }. Resolves to null if no room URL has been specified.

Parameters

boolean
Optional. When false, only explicitly-set properties are returned, omitting defaults. Defaults to true.

Return value

Returns Promise<DailyRoomInfo | DailyPendingRoomInfo | null>. DailyRoomInfo contains:
string
Room UUID.
string
Room name.
object
Room-level configuration. Some properties are omitted for security purposes. See room configuration for the full property list.
object
Domain-level configuration. Some properties are omitted for security purposes. See domain configuration for the full property list.
object
Configuration from the meeting token used to join, if any. See meeting tokens for all properties.

Example

See also