Real time events

TODO

• Change naming convention from "notify" to "send to clients". (done)
• Add "send to server" communication channel to design. (done)

How to use in plugins

Notify about an event in PHP:

\local_rtcomms\api::notify($context, $component, $area, $itemid, $payload);

Subscribe and listen to events:

Subscribe in PHP:

\local_rtcomms\api::subscribe($context, $component, $area, $itemid);

Listen in Javascript:

require(['core/pubsub', 'local_rtcomms/api'], function(PubSub, RealtimeApi) {
    // Only adds an additional client side listener.
    PubSub.subscribe(RealtimeApi.channelName(context, component, area, itemid),
        function(eventData) {
            // access context, component, area, itemid, payload as keys in event data
            // example for context
            document.write(eventData['context']);
            // access payload by key
            document.write(eventData['payload']['testkey']);
        }
    );
    // OR Add listener and ask rtcomms to also subscribe to the server as well.
    RealtimeApi.subscribe(context, component, area, itemid),
        function(eventData) {
            // access context, component, area, itemid, payload as keys in event data
            // example for context
            document.write(eventData['context']);
            // access payload by key
            document.write(eventData['payload']['testkey']);
        }
    );
});

OR Dynamic Javascript Subscription Initiliase in PHP:

local_rtcomms\api::init();

then in Javascript subscribe using:

require(['core/pubsub', 'local_rtcomms/events', 'local_rtcomms/api'], function(PubSub, RealTimeEvents, api) {
    api.subscribe(context, component, area, itemid, function(eventData) {
        // access context, component, area, itemid, payload as keys in event data
        // example for context
        document.write(eventData['context']);
        // access payload by key
        document.write(eventData['payload']['testkey']);
    });
});

TODO: Connection lost JS event, change the favicon, etc.