Skip to main content

Type Alias: Emitter

type Emitter = {
  client_id: UUID;
  client_type: "user" | "guest" | "api" | "unknown";
  is_headless: boolean;
  user_id: UUID;
  username: string;
  session_id: UUID;
};

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:7

Properties​

client_id​

client_id: UUID;

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:13

The unique identifier of the client. This is unique for each client in a session. This is only valid for the duration of the session.

client_type​

client_type: "user" | "guest" | "api" | "unknown";

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:21

The type of the client.

  • "user" for authenticated users
  • "api" for client using the rest API
  • "guest" for unauthenticated users
  • "unknown" for unknown clients

is_headless​

is_headless: boolean;

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:25

Indicates if the client is headless (no streaming).

user_id​

user_id: UUID;

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:31

The unique identifier of the user on the 3dverse platform. The same user can have multiple clients in a session. In this case, the user_id is the same for all clients spawned by the same user.

username​

username: string;

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:35

The username associated to the user on the 3dverse platform.

session_id​

session_id: UUID;

Defined in: node_modules/@3dverse/livelink.core/dist/sources/internal/EditorEvents.d.ts:39

The unique identifier of the session from which the event was emitted.