Source: trellinator-libs/Comment.js

  1. /**
  2. * @class Comment
  3. * @memberof module:TrelloEntities
  4. * @param data (Object} key/value pairs of 
  5. * information, must at least contain "id",
  6. * can basically just pass in response from Trello API
  7. * @constructor
  8. * @classdesc The Comment class represents
  9. * a Comment in Trello. You will mostly interact
  10. * with this class when returned in an IterableCollection
  11. * from a Card method or as a result of a Notification
  12. *
  13. * @example
  14. * var notif = new Notification(posted);
  15. * 
  16. * if(new RegExp("Remove.*").test(notif.addedComment().text()))
  17. *     notif.card().removeMember(notif.member());
  18. */
  19. var Comment = function(data)
  20. {
  21.     this.data = data;
  22.     this.containing_card = null;
  24.     /**
  25.     * Return the id of this comment
  26.     * @memberof module:TrelloEntities.Comment
  27.     * @example
  28.     * card.comments().first().id();
  29.     */
  30.     this.id = function()
  31.     {
  32.         if(!this.data.data)
  33.             throw new Error("Malformed comment object");
  35.         return this.data.data.id ? this.data.data.id:this.data.id;
  36.     }
  38.     /**
  39.     * Return the Card on which this comment
  40.     * was added
  41.     * @memberof module:TrelloEntities.Comment
  42.     * @example
  43.     * var card = new Notification(posted).addedComment().card();
  44.     */
  45.     this.card = function()
  46.     {
  47.       return this.containing_card;
  48.     }
  49.     
  50.     /**
  51.     * Return the text of the comment
  52.     * @memberof module:TrelloEntities.Comment
  53.     * @example
  54.     * card.comments().first().text();
  55.     */
  56.     this.text = function()
  57.     {
  58.         if(!this.data.data)
  59.             throw new Error("Malformed comment object");
  61.         return this.data.data.text;
  62.     }
  63.     
  64.     /**
  65.     * Return the member who made a comment
  66.     * @memberof module:TrelloEntities.Comment
  67.     * @example
  68.     * card.comments().first().member();
  69.     */
  70.     this.member = function()
  71.     {
  72.       return new Member(this.data.memberCreator);
  73.     }
  74.     
  75.     /**
  76.     * Return an IterableCollection of mentioned members
  77.     * @memberof module:TrelloEntities.Comment
  78.     * @example
  79.     * card.comments().first().mentionedMembers();
  80.     */
  81.     this.mentionedMembers = function()
  82.     {
  83.         var ret     = new Array();
  85.         this.card().board().members().each(function(member)
  86.         {
  87.             if(new RegExp(".*@"+member.name()+".*").test(this.text()))
  88.                 ret.push(member);
  89.         });
  90.         
  91.         if(!ret.length)
  92.             throw new InvalidActionException("No members were mentioned in this comment");
  93.         
  94.         return new IterableCollection(ret);
  95.     }
  96.     
  97.     /**
  98.     * Return a Date when this comment was made
  99.     * @memberof module:TrelloEntities.Comment
  100.     * @example
  101.     * card.comments().first().when().toString();
  102.     */
  103.     this.when = function()
  104.     {
  105.       return new Date(this.data.date);
  106.     }
  108.     /**
  109.     * A name() function used in name comparisons
  110.     * in the IterableCollection findByName method
  111.     * @memberof module:TrelloEntities.Comment
  112.     * @example
  113.     * card.comments().findByName(new RegExp(".*search.*")).first().text();
  114.     */
  115.     this.name = function()
  116.     {
  117.         return this.text();
  118.     }
  119.     
  120.     /**
  121.     * Delete this comment, works only if you have 
  122.     * more permissions than the person who made the
  123.     * comment, you made the comment or the person
  124.     * who made the comment has deleted their account
  125.     * Returns the containing card
  126.     * @memberof module:TrelloEntities.Comment
  127.     * @example
  128.     * card.comments().first().del();
  129.     */
  130.     this.del = function()
  131.     {
  132.         TrelloApi.del("actions/"+this.id());
  133.         return this.card();
  134.     }
  136.     /**
  137.     * Edit this comment, works only if you have 
  138.     * more permissions than the person who made the
  139.     * comment, you made the comment or the person
  140.     * who made the comment has deleted their account
  141.     * Returns the containing card
  142.     * @memberof module:TrelloEntities.Comment
  143.     * @example
  144.     * card.comments().first().del();
  145.     */
  146.     this.setText = function(text)
  147.     {
  148.         TrelloApi.put("actions/"+this.id()+"/text?value="+encodeURIComponent(text));
  149.         return this.card();
  150.     }
  151.     
  152.     //INTERNAL USE ONLY
  153.     this.setContainingCard = function(card)
  154.     {
  155.       this.containing_card = card;
  156.       return this;
  157.     }
  158. }