Controller for receiving and sending messages to clients
IClientsController
is defined in the Telligent.Evolution.Extensibility.Sockets.Version1
namespace of Telligent.Evolution.Core.dll
Definition
interface IClientsController { event EventHandler<UserConnectedEventArgs> Connected { add; remove; } event EventHandler<UserDisconnectedEventArgs> Disconnected { add; remove; } event EventHandler<MessageReceivedEventArgs> Received { add; remove; } void Broadcast(string messageName, Object data = null); void Send(int userId, string messageName, Object data = null); }
Events
Connected
Event raised when a user connects or reconnects after an interruption
Handler
void EventHandler<UserConnectedEventArgs>(Object sender, UserConnectedEventArgs e);
Disconnected
Event raised when a user disconnects
Handler
void EventHandler<UserDisconnectedEventArgs>(Object sender, UserDisconnectedEventArgs e);
Received
Event raised when a message is received from a user
Handler
void EventHandler<MessageReceivedEventArgs>(Object sender, MessageReceivedEventArgs e);
Methods
void Broadcast(string messageName, Object data = null);
Sends a message to all users, along with optional message data to serialize as JSON
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageName | string | Message Name | Required | ||
data | Object | Data | Optional |
void Send(int userId, string messageName, Object data = null);
Sends a message to a specific user, along with optional message data to serialize as JSON
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
messageName | string | Message Name | Required | ||
data | Object | Data | Optional |