LiveEventScope class

Object responsible for sending and receiving live share events.

Remarks

Live objects send and receive events using an event scope. Event scopes can be restricted to only receive events from clients with specific roles. Any events that are received from clients without an allowed role type will be ignored.

Event scopes are isolated on a per Fluid object basis. That means that two different Fluid objects using the same event names don't have to worry about collisions. Two event scopes within the same Fluid object, however, don't have any isolation. You can use multiple event scopes within the same FLuid object, you just need to be careful that they send different events.

Constructors

LiveEventScope(IRuntimeSignaler, LiveShareRuntime, UserMeetingRole[])

Creates a new LiveEventScope instance.

Properties

allowedRoles	List of roles allowed to send events through this scope.
clientId	The runtimes current client ID. This will be `undefined` if the client is disconnected.

Inherited Properties

addListener
off
on
once
prependListener
prependOnceListener
removeListener

Methods

offEvent<TEvent>(string, LiveEventListener<TEvent>)	Un-registers a listener for a named event.
onEvent<TEvent>(string, LiveEventListener<TEvent>)	Registers a listener for a named event.
sendEvent<TEvent>(string, TEvent)	Sends an event to other event scope instances for the Fluid object.
sendLocalEvent<TEvent>(string, TEvent)	Sends a local only event to local event scope instance for the Fluid object.

Inherited Methods

emit<E>(string \| symbol, any[])	Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments to each. Returns `true` if the event had listeners, `false` otherwise. import { EventEmitter } from 'node:events'; const myEmitter = new EventEmitter(); // First listener myEmitter.on('event', function firstListener() { console.log('Helloooo! first listener'); }); // Second listener myEmitter.on('event', function secondListener(arg1, arg2) { console.log(`event with parameters ${arg1}, ${arg2} in second listener`); }); // Third listener myEmitter.on('event', function thirdListener(...args) { const parameters = args.join(', '); console.log(`event with parameters ${parameters} in third listener`); }); console.log(myEmitter.listeners('event')); myEmitter.emit('event', 1, 2, 3, 4, 5); // Prints: // [ // [Function: firstListener], // [Function: secondListener], // [Function: thirdListener] // ] // Helloooo! first listener // event with parameters 1, 2 in second listener // event with parameters 1, 2, 3, 4, 5 in third listener
eventNames()	Returns an array listing the events for which the emitter has registered listeners. `import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => {}); myEE.on('bar', () => {}); const sym = Symbol('symbol'); myEE.on(sym, () => {}); console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ]`
getMaxListeners()	Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to `events.defaultMaxListeners`.
listenerCount<E>(string \| symbol, (args: any[]) => void)	Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event.
listeners<E>(string \| symbol)	Returns a copy of the array of listeners for the event named `eventName`. `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
rawListeners<E>(string \| symbol)	Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.once('log', () => console.log('log once')); // Returns a new Array with a function `onceWrapper` which has a property // `listener` which contains the original listener bound above const listeners = emitter.rawListeners('log'); const logFnWrapper = listeners[0]; // Logs "log once" to the console and does not unbind the `once` event logFnWrapper.listener(); // Logs "log once" to the console and removes the listener logFnWrapper(); emitter.on('log', () => console.log('log persistently')); // Will return a new Array with a single function bound by `.on()` above const newListeners = emitter.rawListeners('log'); // Logs "log persistently" twice newListeners[0](); emitter.emit('log');
removeAllListeners<E>(string \| symbol)	Removes all listeners, or those of the specified `eventName`. It is bad practice to remove listeners added elsewhere in the code, particularly when the `EventEmitter` instance was created by some other component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter`, so that calls can be chained.
setMaxListeners(number)	By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding memory leaks. The `emitter.setMaxListeners()` method allows the limit to be modified for this specific `EventEmitter` instance. The value can be set to `Infinity` (or `0`) to indicate an unlimited number of listeners. Returns a reference to the `EventEmitter`, so that calls can be chained.
[captureRejectionSymbol](Error, string \| symbol, any[])	The `Symbol.for('nodejs.rejection')` method is called in case a promise rejection happens when emitting an event and `captureRejections` is enabled on the emitter. It is possible to use `events.captureRejectionSymbol` in place of `Symbol.for('nodejs.rejection')`. `import { EventEmitter, captureRejectionSymbol } from 'node:events'; class MyClass extends EventEmitter { constructor() { super({ captureRejections: true }); } [captureRejectionSymbol](err, event, ...args) { console.log('rejection happened for', event, 'with', err, ...args); this.destroy(err); } destroy(err) { // Tear the resource down here. } }`

Creates a new LiveEventScope instance.

new LiveEventScope(runtime: IRuntimeSignaler, _liveRuntime: LiveShareRuntime, allowedRoles?: UserMeetingRole[])

Parameters

runtime: IRuntimeSignaler

A Fluid objects runtime instance, typically this.runtime.

_liveRuntime: LiveShareRuntime

allowedRoles: UserMeetingRole[]

Optional. List of roles allowed to send events using this scope. You should use a second scope if you need mixed permission support.

List of roles allowed to send events through this scope.

UserMeetingRole[] allowedRoles

Property Value

UserMeetingRole[]

The runtimes current client ID. This will be undefined if the client is disconnected.

undefined | string clientId