Skip to main content

Type Alias: ClientInfo

type ClientInfo = {
    client_id: UUID;
    client_type: "user" | "guest" | "unknown";
    user_id: UUID;
    username: string;
};

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

Information about a client in a session.

Properties​

client_id​

client_id: UUID;

Defined in: livelink.js/sources/session/ClientInfo.ts:15

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" | "unknown";

Defined in: livelink.js/sources/session/ClientInfo.ts:23

The type of the client.

  • "user" for authenticated users
  • "guest" for unauthenticated users
  • "unknown" for unknown clients

user_id​

user_id: UUID;

Defined in: livelink.js/sources/session/ClientInfo.ts:30

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: livelink.js/sources/session/ClientInfo.ts:35

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