Skip to main content

SessionInfo

@3dverse/livelink v0.8.10

@3dverse/livelink / SessionInfo

Type Alias: SessionInfo

SessionInfo: object & object

Defined in: livelink.js/sources/session/SessionInfo.ts:9

Information about a session.

Type declaration​

session_id​

readonly session_id: UUID

The unique identifier of the session.

scene_id​

readonly scene_id: UUID

The unique identifier of the scene the session is running in.

is_transient_session​

readonly is_transient_session: boolean

Whether the session is a transient session. Transient sessions are temporary and changes are not saved.

Type declaration​

scene_name?​

readonly optional scene_name: string

The name of the scene the session is running in.

folder_id?​

readonly optional folder_id: UUID

The unique identifier of the 3dverse console folder the scene is in.

max_users?​

readonly optional max_users: number

The maximum number of users that can join the session.

created_by?​

readonly optional created_by: UUID

The unique identifier of the user that created the session.

created_at?​

readonly optional created_at: Date

The date and time the session was created.

country_code?​

readonly optional country_code: string

The country code of the 3dverse server the session is running on.

continent_code?​

readonly optional continent_code: string

The continent code of the 3dverse server the session is running on.

clients?​

readonly optional clients: ClientInfo[]

The information about the clients connected to the session.