Interface: Project
@roomful/relay / Project
Interface: Project
Section titled “Interface: Project”Defined in: packages/relay/src/management/types.ts:10
A project groups rooms together and carries a quota. Owned by an account; every newly created project starts with the relay-wide default limits clamped by any account-level quota.
Properties
Section titled “Properties”createdAt
Section titled “createdAt”createdAt:
number
Defined in: packages/relay/src/management/types.ts:24
Epoch milliseconds when the project was created.
description
Section titled “description”description:
string|undefined
Defined in: packages/relay/src/management/types.ts:18
Free-form description.
id:
string
Defined in: packages/relay/src/management/types.ts:12
Unique project id across the relay.
metadata
Section titled “metadata”metadata:
Record<string,unknown> |undefined
Defined in: packages/relay/src/management/types.ts:21
Opaque metadata the owner can attach.
name:
string
Defined in: packages/relay/src/management/types.ts:15
Human-readable project name (required, but can be the same as the id).
ownerId
Section titled “ownerId”ownerId:
string
Defined in: packages/relay/src/management/types.ts:33
The account that owns the project. A relay must provide this claim
(via the JWT sub or a custom field) during authorization.
updatedAt
Section titled “updatedAt”updatedAt:
number
Defined in: packages/relay/src/management/types.ts:27
Epoch milliseconds when the project was last updated.