Skip to content

Documentation / @imvu/client / JoinOptions

Interface: JoinOptions ​

Defined in: packages/client/src/chat/ChatSession.ts:12

Extends ​

Properties ​

ignoreOwnMessages? ​

ts
ignoreOwnMessages?: boolean;

Defined in: packages/client/src/chat/ChatSession.ts:18

Skip the echo of our own lines (the server sends them back). Default true.


keepAliveInterval? ​

ts
keepAliveInterval?: number;

Defined in: packages/client/src/chat/ChatSession.ts:14

How often to renew presence. The server drops silent participants after ~3.5–4 min. Default 45 s (as the web client).


leaveWhenBooted? ​

ts
leaveWhenBooted?: boolean;

Defined in: packages/client/src/chat/ChatSession.ts:20

Leave automatically when someone boots us. Default true.


observeParticipants? ​

ts
observeParticipants?: boolean;

Defined in: packages/client/src/chat/ChatSession.ts:16

Track who is present and emit join/leave/update. Default true.


trackChanges? ​

ts
trackChanges?: boolean;

Defined in: packages/client/src/chat/ChatObserver.ts:18

Re-read a participant whenever the server reports it updated, to detect outfit and seat changes. Default true. Every participant's 45 s keepalive also counts as an update, so turn this off to cut REST traffic to joins and leaves only.

Inherited from ​

ObserveOptions.trackChanges

Released under the MIT License.