Socket.IO Client API

Socket.IO Client API

Whispers

Uses namespace /whispers

Send a whisper

socket.of('/whispers').emit('whisper', to, message, function(sent) {
    // sent is true if message was received by recipient, otherwise false (recipient offline?)
});

Receive whispers

socket.of('/whispers').on('whisper', function(from, message) {
    // <from> message
});

Channels

Uses namespace /channels

Join channel

socket.of('/channels').emit('join', channel, function(joined) {
    // joined is true if channel was joined, otherwise false (already in channel)
});

Leave channel

socket.of('/channels').emit('leave', channel, function(left) {
    // left is true if channel was left, otherwise false (not in channel)
});

Someone joined a channel you're in

socket.of('/channels').on('join', function(channel, name) {
    // name joined channel
});

Someone left a channel you're in

socket.of('/channels').on('leave', function(channel, name) {
    // name left channel
});

Send a channel message

socket.of('/channels').emit('chat', channel, message, function(sent) {
    // sent is true if message was received, otherwise false (not in channel)
});

Receive channel messages

socket.of('/channels').on('chat', function(channel, name, message) {
    // [channel] name: message
});