Skip to main content

Type Alias: SessionInfo

type SessionInfo = {
    session_id: UUID;
    scene_id: UUID;
    is_transient_session: boolean;
    scene_name?: string;
    folder_id?: UUID;
    max_users?: number;
    created_by?: UUID;
    created_at?: Date;
    country_code?: string;
    continent_code?: string;
    clients?: ClientInfo[];
};

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

Information about a session.

Properties​

session_id​

readonly session_id: UUID;

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

The unique identifier of the session.

scene_id​

readonly scene_id: UUID;

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

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

is_transient_session​

readonly is_transient_session: boolean;

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

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

scene_name?​

readonly optional scene_name: string;

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

The name of the scene the session is running in.

folder_id?​

readonly optional folder_id: UUID;

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

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

max_users?​

readonly optional max_users: number;

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

The maximum number of users who can join the session.

created_by?​

readonly optional created_by: UUID;

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

The unique identifier of the user who created the session.

created_at?​

readonly optional created_at: Date;

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

The date and time the session was created.

country_code?​

readonly optional country_code: string;

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

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

continent_code?​

readonly optional continent_code: string;

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

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

clients?​

readonly optional clients: ClientInfo[];

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

The information about the clients connected to the session.