API Docs for: 0.25.0
Show:

CommentableMixin Class

Extends Ember.Mixin
Defined in: addon/mixins/commentable.js:8
Module: mixins
Parent Module: ember-osf

Controller mixin that implements basic commenting functionality. Uses the base model in the route model hook.

Methods

addComment

(
  • text
)
Promise

Defined in addon/mixins/commentable.js:32

Action that adds a new comment targeting the model by GUID.

Parameters:

  • text String

    The text of the new comment

Returns:

Promise:

The newly created comment

apply

(
  • obj
)
private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:555

Parameters:

Returns:

applied object

deleteComment

(
  • comment
)
Promise

Defined in addon/mixins/commentable.js:60

Action that handles deletion of an existing comment.

Parameters:

Returns:

Promise:

detect

(
  • obj
)
Boolean private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:586

Parameters:

Returns:

Boolean:

editComment

(
  • comment
)
Promise

Defined in addon/mixins/commentable.js:51

Action that edits an existing comment.

Parameters:

Returns:

Promise:

reopen

(
  • arguments
)
private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:518

Parameters:

reportComment

() Promise

Defined in addon/mixins/commentable.js:80

Action that reports a comment for administrative review

Returns:

Promise:

restoreComment

(
  • comment
)
Promise

Defined in addon/mixins/commentable.js:70

Action that restores a deleted comment.

Parameters:

Returns:

Promise:

Properties

comments

Comment[] public

Defined in addon/mixins/commentable.js:15

The list of comments associated with a model. Defaults to using the model hook, and ensures that new comments are shown first (to match API convention)