Flesh out externs file

This commit is contained in:
Ian Gulliver
2014-06-14 12:21:16 -07:00
parent 7ef3e5ab0c
commit a51359068f

View File

@@ -40,7 +40,10 @@ Cosmopolite.typeMessage;
Cosmopolite.typeSubject; Cosmopolite.typeSubject;
/** @typedef {(Cosmopolite.typeSubject|string|number)} */ /**
* @see https://www.cosmopolite.org/reference#subject
* @typedef {(Cosmopolite.typeSubject|string|number)}
*/
Cosmopolite.typeSubjectLoose; Cosmopolite.typeSubjectLoose;
@@ -58,6 +61,28 @@ function Cosmopolite(
opt_callbacks, opt_urlPrefix, opt_namespace, opt_trackingID) {} opt_callbacks, opt_urlPrefix, opt_namespace, opt_trackingID) {}
/**
* @see https://www.cosmopolite.org/reference#shutdown
*/
Cosmopolite.prototype.shutdown = function() {};
/**
* @see https://www.cosmopolite.org/reference#getProfile
* @return {Promise}
* @nosideeffects
*/
Cosmopolite.prototype.getProfile = function() {};
/**
* @see https://www.cosmopolite.org/reference#currentProfile
* @const
* @nosideeffects
*/
Cosmopolite.prototype.currentProfile = function() {};
/** /**
* @see https://www.cosmopolite.org/reference#subscribe * @see https://www.cosmopolite.org/reference#subscribe
* @param {Cosmopolite.typeSubjectLoose|Array.<Cosmopolite.typeSubjectLoose>} * @param {Cosmopolite.typeSubjectLoose|Array.<Cosmopolite.typeSubjectLoose>}
@@ -68,3 +93,83 @@ function Cosmopolite(
*/ */
Cosmopolite.prototype.subscribe = Cosmopolite.prototype.subscribe =
function(subjects, opt_messages, opt_lastID) {}; function(subjects, opt_messages, opt_lastID) {};
/**
* @see https://www.cosmopolite.org/reference#unsubscribe
* @param {Cosmopolite.typeSubjectLoose} subject
* @return {Promise}
*/
Cosmopolite.prototype.unsubscribe = function(subject) {};
/**
* @see https://www.cosmopolite.org/reference#sendMessage
* @param {Cosmopolite.typeSubjectLoose} subject
* @param {!*} message
* @return {Promise}
*/
Cosmopolite.prototype.sendMessage = function(subject, message) {};
/**
* @see https://www.cosmopolite.org/reference#getMessages
* @param {Cosmopolite.typeSubjectLoose} subject
* @return {Array.<Cosmopolite.typeMessage>}
* @const
* @nosideeffects
*/
Cosmopolite.prototype.getMessages = function(subject) {};
/**
* @see https://www.cosmopolite.org/reference#getLastMessage
* @param {Cosmopolite.typeSubjectLoose} subject
* @return {?Cosmopolite.typeMessage}
* @const
* @nosideeffects
*/
Cosmopolite.prototype.getLastMessage = function(subject) {};
/**
* @see https://www.cosmopolite.org/reference#pin_method
* @param {Cosmopolite.typeSubjectLoose} subject
* @param {!*} message
* @return {Promise}
*/
Cosmopolite.prototype.pin = function(subject, message) {};
/**
* @see https://www.cosmopolite.org/reference#unpin
* @param {string} id
* @return {Promise}
*/
Cosmopolite.prototype.unpin = function(id) {};
/**
* @see https://www.cosmopolite.org/reference#getPins
* @param {Cosmopolite.typeSubjectLoose} subject
* @return {Array.<Cosmopolite.typeMessage>}
* @const
* @nosideeffects
*/
Cosmopolite.prototype.getPins = function(subject) {};
/**
* @see https://www.cosmopolite.org/reference#trackEvent
* @param {...*} var_args
*/
Cosmopolite.prototype.trackEvent = function(var_args) {};
/**
* @see https://www.cosmopolite.org/reference#uuid
* @return {string}
* @const
* @nosideeffects
*/
Cosmopolite.prototype.uuid = function() {};