comment/Comment.js

  1. var FieldDBObject = require("./../FieldDBObject").FieldDBObject;
  3. /**
  4.  * @class Comments allow users to collaborate between each other and take
  5.  *        note of important things, issues to be fixed, etc. These can
  6.  *        appear on datum, sessions corpora, and datalists. Comments can
  7.  *        also be edited and removed.
  8.  *
  9.  * @property {String} text Describe text here.
  10.  * @property {Number} username Describe username here.
  11.  * @property {Date} timestamp Describe timestamp here.
  12.  *
  13.  * @name  Comment
  14.  * @extends FieldDBObject
  15.  * @constructs
  16.  */
  17. var Comment = function Comment(options) {
  18.   if (!this._fieldDBtype) {
  19.     this._fieldDBtype = "Comment";
  20.   }
  21.   this.debug("Constructing Comment ", options);
  22.   FieldDBObject.apply(this, arguments);
  23. };
  25. Comment.prototype = Object.create(FieldDBObject.prototype, /** @lends Comment.prototype */ {
  27.   constructor: {
  28.     value: Comment
  29.   },
  31.   build: {
  32.     value: function(usermask) {
  33.       this.timestamp = Date.now();
  34.       this.gravatar = usermask.gravatar;
  35.       this.username = usermask.username;
  36.     }
  37.   },
  39.   /**
  40.    * The edit function allows users to edit a comment.
  41.    *
  42.    * @param {String}  newtext Takes new text and replaces old one.
  43.    */
  44.   edit: {
  45.     value: function(newtext) {
  46.       this.text = newtext;
  47.       this.timestampModified = Date.now();
  48.     }
  49.   },
  51.   commentCreatedActivity: {
  52.     value: function(indirectObjectString) {
  53.       var commentstring = this.text;
  54.       return [{
  55.           verb: "commented",
  56.           verbicon: "icon-comment",
  57.           directobjecticon: "",
  58.           directobject: "'" + commentstring + "'",
  59.           indirectobject: indirectObjectString,
  60.           teamOrPersonal: "team",
  61.           context: " via Offline App."
  62.         },
  64.         {
  65.           verb: "commented",
  66.           verbicon: "icon-comment",
  67.           directobjecticon: "",
  68.           directobject: "'" + commentstring + "'",
  69.           indirectobject: indirectObjectString,
  70.           teamOrPersonal: "personal",
  71.           context: " via Offline App."
  72.         }
  73.       ];
  74.     }
  75.   }
  77. });
  79. exports.Comment = Comment;