Class: SocketBroadcastHandler

Defined in: socket/broadcast.ts:14

A subclass of the SocketEventHandler that handles the broadcast events.

Extends

• SocketEventHandler

Constructors

Constructor

new SocketBroadcastHandler(
   room, 
   eventName, 
   source, 
   payload, 
   memberSocket): SocketBroadcastHandler;

Defined in: socket/index.ts:59

Parameters

Parameter	Type	Description
room	Room	The Room where the event is happening
eventName	string	The name of the event
source	User	The User associated with the event
payload	IKeyValue	The input values of the event
memberSocket	string	The member socketID to send event to (may be null)

Returns

SocketBroadcastHandler

Inherited from

SocketEventHandler.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
eventName	protected	string	The event name of a socket event	SocketEventHandler.eventName	socket/index.ts:35
input	protected	IKeyValue	The input of the socket event	SocketEventHandler.input	socket/index.ts:41
memberSocket	protected	string	MemberSocket ID	SocketEventHandler.memberSocket	socket/index.ts:50
output	protected	SocketIOContextOutput	The output of the socket event	SocketEventHandler.output	socket/index.ts:38
room	protected	Room	The room where the event is occurring	SocketEventHandler.room	socket/index.ts:44
source	protected	User	The user associated with the event	SocketEventHandler.source	socket/index.ts:47

Methods

isSDPEvent()

protected isSDPEvent(): boolean;

Defined in: socket/index.ts:110

Checks the Event Name for sdp events

Returns

boolean

room:event or the SDP event Name

Inherited from

SocketEventHandler.isSDPEvent

---

parametersReturn()

protected parametersReturn(): IKeyValue;

Defined in: socket/index.ts:120

Returns the parameters for the broadcast event, with special consideration for SDP events

Returns

IKeyValue

broadcast parameters

Inherited from

SocketEventHandler.parametersReturn

---

passthru()

protected passthru(): Promise<void>;

Defined in: socket/index.ts:77

Event to Trigger a sendToRooms event.

Returns

Promise<void>

Inherited from

SocketEventHandler.passthru

---

process()

protected process(): Promise<any>;

Defined in: socket/broadcast.ts:19

Broadcasts are pushed through

Returns

Promise<any>

original data, plus "source"

Overrides

SocketEventHandler.process

---

result()

result(): Promise<SocketIOContextOutput>;

Defined in: socket/index.ts:101

The output produced from this.process

Returns

Promise<SocketIOContextOutput>

Inherited from

SocketEventHandler.result