Doc updates for the change in event handling framework.

This commit is contained in:
Ian Gulliver
2015-05-31 18:33:31 -07:00
parent 381283d864
commit 761cb92767
3 changed files with 88 additions and 711 deletions

View File

@@ -15,19 +15,6 @@ String.prototype.hashCode = function() {};
/**
* @see https://www.cosmopolite.org/reference#callbacks
* @typedef {{onConnect: (function()|undefined),
* onDisconnect: (function()|undefined),
* onLogin: (function(string, string)|undefined),
* onLogout: (function(string)|undefined),
* onMessage: (function(Cosmopolite.typeMessage)|undefined),
* onPin: (function(Cosmopolite.typeMessage)|undefined),
* onUnpin: (function(Cosmopolite.typeMessage)|undefined)}}
*/
Cosmopolite.typeCallbacks;
/**
* @see https://www.cosmopolite.org/reference#message
* @typedef {{event_type: string,
@@ -60,14 +47,12 @@ Cosmopolite.typeSubjectLoose;
/**
* @see https://www.cosmopolite.org/reference#constructor
* @constructor
* @param {?Cosmopolite.typeCallbacks=} opt_callbacks
* @param {?string=} opt_urlPrefix
* @param {?string=} opt_namespace
* @param {?string=} opt_trackingID
* @nosideeffects
*/
function Cosmopolite(
opt_callbacks, opt_urlPrefix, opt_namespace, opt_trackingID) {}
function Cosmopolite(opt_urlPrefix, opt_namespace, opt_trackingID) {}
/**