pub struct SceneChatAlias { /* private fields */ }websocket only.Expand description
The "scene" switch of one connection’s ChatStreamEnable
subscription, shared with that connection’s SceneStreamHandler.
While on, the handler delivers every Scene event the user may
receive, as a SceneStreamEnable with regionIds and eventTypes
both null would: the "scene" path “Subscribes to all Scene event
types for all regions in which the user has an active avatar”
(draft-atwood-jmap-scene-wss-00 §Interoperability with JMAP Chat
WebSocket). That covers every SceneStreamEnable subscription
without observe. An observer subscription also reaches listed
regions without an avatar (“It has no observer form”, jmap-chat-spec
93f2258), so for an event the "scene" path does not admit the
handler still asks the connection’s own observer subscription. Either
way the union the server “MUST deliver” is decided once per event:
“if an event matches both subscriptions, it is delivered exactly once”
(§Subscription Union).
SceneStreamDisable does not touch it, and turning it off leaves the
SceneStreamEnable subscription in place (§Subscription
Independence).
Set it to jmap_chat_server::EphemeralSubscription::scene after every
change of the Chat subscription; jmap-chat-scene-server does.