Interface: RoomRecord
@roomful/relay / RoomRecord
Interface: RoomRecord
Section titled “Interface: RoomRecord”Defined in: packages/relay/src/management/types.ts:69
A room record is the management-plane representation of a room.
Properties
Section titled “Properties”createdAt
Section titled “createdAt”createdAt:
number
Defined in: packages/relay/src/management/types.ts:83
When the room was provisioned (epoch ms).
ephemeral
Section titled “ephemeral”ephemeral:
boolean
Defined in: packages/relay/src/management/types.ts:87
When true the room is never persisted and disconnects after ttlMs;
matches the core SDK ephemeral option.
id:
string
Defined in: packages/relay/src/management/types.ts:71
Unique room id across the relay (the same id peers use to join).
metadata
Section titled “metadata”metadata:
Record<string,unknown> |undefined
Defined in: packages/relay/src/management/types.ts:80
Opaque metadata the owner can attach.
name:
string|undefined
Defined in: packages/relay/src/management/types.ts:77
Human-readable label.
projectId
Section titled “projectId”projectId:
string
Defined in: packages/relay/src/management/types.ts:74
The project this room belongs to.
ttlMs:
number
Defined in: packages/relay/src/management/types.ts:90
Auto-disconnect TTL in ms (0 = no TTL, meaningful only with ephemeral).