Documentation / @imvu/client / Room

Class: Room

Defined in: packages/client/src/resources/Room.ts:6

Shared state for any remotely addressable node, edge, or collection document.

Extends

• Resource<RoomRelations>

Constructors

Constructor

new Room(client, options?): Room;

Defined in: packages/client/src/resources/Resource.ts:23

Parameters

Parameter	Type
client	Client
options?	ResourceOptions

Returns

Room

Inherited from

Resource.constructor

Properties

_id

_id: string = '';

Defined in: packages/client/src/resources/Resource.ts:21

Inherited from

Resource._id

---

_url

protected _url: string = '';

Defined in: packages/client/src/resources/RemoteDocument.ts:13

Inherited from

Resource._url

---

capacity

capacity: number = 0;

Defined in: packages/client/src/resources/Room.ts:14

---

client

protected readonly client: Client;

Defined in: packages/client/src/resources/RemoteDocument.ts:16

Inherited from

Resource.client

---

contentRating

contentRating: string = '';

Defined in: packages/client/src/resources/Room.ts:18

---

description

description: string = '';

Defined in: packages/client/src/resources/Room.ts:8

---

fetchedAt

fetchedAt: number = 0;

Defined in: packages/client/src/resources/Resource.ts:39

When this instance last received data from the API (ms since epoch); 0 if never.

Inherited from

Resource.fetchedAt

---

isAgeVerified

isAgeVerified: boolean = false;

Defined in: packages/client/src/resources/Room.ts:21

---

isAp

isAp: boolean = false;

Defined in: packages/client/src/resources/Room.ts:23

---

isFriendsOnly

isFriendsOnly: boolean = false;

Defined in: packages/client/src/resources/Room.ts:19

---

isNonGuestOnly

isNonGuestOnly: boolean = false;

Defined in: packages/client/src/resources/Room.ts:20

---

isVip

isVip: boolean = false;

Defined in: packages/client/src/resources/Room.ts:22

---

language

language: string = '';

Defined in: packages/client/src/resources/Room.ts:16

---

name

name: string = '';

Defined in: packages/client/src/resources/Room.ts:7

---

occupancy

occupancy: number = 0;

Defined in: packages/client/src/resources/Room.ts:15

---

options

protected options: ResourceOptions = {};

Defined in: packages/client/src/resources/Resource.ts:25

Inherited from

Resource.options

---

ownerUsername

ownerUsername: string = '';

Defined in: packages/client/src/resources/Room.ts:17

---

privacy

privacy: string = '';

Defined in: packages/client/src/resources/Room.ts:10

'public' or 'private'.

---

rating

rating: number = 0;

Defined in: packages/client/src/resources/Room.ts:13

---

relations

relations: Partial<TRelations> = {};

Defined in: packages/client/src/resources/Resource.ts:44

Internal

Inherited from

Resource.relations

---

revision

revision: number = 0;

Defined in: packages/client/src/resources/RemoteDocument.ts:8

Inherited from

Resource.revision

---

stale

stale: boolean = false;

Defined in: packages/client/src/resources/RemoteDocument.ts:9

Inherited from

Resource.stale

---

supportsAudience

supportsAudience: boolean = false;

Defined in: packages/client/src/resources/Room.ts:25

Live (audience) rooms use hangouts instead of a classic chat; chat returns null for them.

---

type

type: string = '';

Defined in: packages/client/src/resources/Room.ts:12

listed, marriage, shared, shop_together, closed, …

---

updates

updates: Partial<TUpdates> = {};

Defined in: packages/client/src/resources/Resource.ts:49

Internal

Inherited from

Resource.updates

---

updateTarget

updateTarget: 
  | APIUpdateTarget
  | null
  | undefined;

Defined in: packages/client/src/resources/RemoteDocument.ts:11

Undefined until metadata is loaded; null means the API explicitly provides no update target.

Inherited from

Resource.updateTarget

Accessors

id

Get Signature

get id(): string;

Defined in: packages/client/src/resources/Resource.ts:34

Returns

string

Inherited from

Resource.id

---

url

Get Signature

get url(): string;

Defined in: packages/client/src/resources/RemoteDocument.ts:28

Canonical REST URL and cache identity for this document.

Returns

string

Inherited from

Resource.url

Methods

_applyRemoteMetadata()

_applyRemoteMetadata(url, updateTarget): void;

Defined in: packages/client/src/resources/RemoteDocument.ts:33

Internal

Apply address/update metadata from an authoritative REST response.

Parameters

Parameter	Type
url	string
updateTarget	APIUpdateTarget | null

Returns

void

Inherited from

Resource._applyRemoteMetadata

---

_hydrate()

_hydrate(node): void;

Defined in: packages/client/src/resources/Resource.ts:69

Internal

Refresh this canonical instance from an authoritative REST document.

Parameters

Parameter	Type
node	APIResource

Returns

void

Inherited from

Resource._hydrate

---

_invalidate()

_invalidate(): void;

Defined in: packages/client/src/resources/RemoteDocument.ts:40

Internal

Mark this document stale after an IMQ invalidation.

Returns

void

Inherited from

Resource._invalidate

---

_patch()

_patch(data): void;

Defined in: packages/client/src/resources/Room.ts:27

Internal

Assign fields from a raw (possibly partial) API payload. Used by build for the initial data and, later, by IMQ for in-place live updates — hence the in guards, so a partial payload only touches the fields it carries. Subclasses override this and call super._patch(data).

Parameters

Parameter	Type
data	Record<string, any>

Returns

void

Overrides

Resource._patch

---

authenticated()

protected authenticated(): void;

Defined in: packages/client/src/resources/Resource.ts:104

Returns

void

Inherited from

Resource.authenticated

---

chat()

chat(): Promise<Chat | null>;

Defined in: packages/client/src/resources/Room.ts:52

The room's classic chat, or null for live (audience) rooms.

Returns

Promise<Chat | null>

---

collectionRelationship()

protected collectionRelationship<T, K>(
   relation, 
   cls, 
   options?
): Collection<T>;

Defined in: packages/client/src/resources/Resource.ts:122

Type Parameters

Type Parameter
T extends Resource<APIRelations, APIUpdateTarget>
K extends keyof RoomRelations

Parameters

Parameter	Type
relation	K
cls	Constructor<T>
options?	CollectionOptions

Returns

Collection<T>

Inherited from

Resource.collectionRelationship

---

join()

join(options?): Promise<ChatSession>;

Defined in: packages/client/src/resources/Room.ts:57

Join this room's chat. Shorthand for (await room.chat()).join().

Parameters

Parameter	Type
options?	JoinOptions

Returns

Promise<ChatSession>

---

moderators()

moderators(): Promise<User<UserRelations>[]>;

Defined in: packages/client/src/resources/Room.ts:47

Returns

Promise<User<UserRelations>[]>

---

refresh()

refresh(): Promise<Room>;

Defined in: packages/client/src/resources/Resource.ts:95

Re-read this resource from REST and update it in place. Resolves to the same instance, so references held elsewhere see the fresh data and stale clears.

Returns

Promise<Room>

Inherited from

Resource.refresh

---

relationship()

protected relationship<T, K>(
   relation, 
   cls, 
   options?
): Promise<T | null>;

Defined in: packages/client/src/resources/Resource.ts:110

Type Parameters

Type Parameter
T extends Resource<APIRelations, APIUpdateTarget>
K extends keyof RoomRelations

Parameters

Parameter	Type
relation	K
cls	Constructor<T>
options?	FetchOptions

Returns

Promise<T | null>

Inherited from

Resource.relationship

---

watch()

watch(): Promise<DocumentWatch<Room>>;

Defined in: packages/client/src/resources/RemoteDocument.ts:46

Observe explicit IMQ invalidations for this document.

Returns

Promise<DocumentWatch<Room>>

Inherited from

Resource.watch

---

build()

static build<T>(
   this, 
   client, 
   node
): T;

Defined in: packages/client/src/resources/Resource.ts:57

Construct a resource from a raw API node, then populate it via _patch. No validation — we trust the wire types and rely on tests for API drift (see MODERNIZATION.md). Fields keep their defaults until _patch overwrites them, so an instance is never in an unset state.

Type Parameters

Type Parameter
T extends Resource<any, APIUpdateTarget>

Parameters

Parameter	Type
this	new (client, options?) => T
client	Client
node	APIResource

Returns

T

Inherited from

Resource.build