API Docs for: 0.25.0
Show:

NodeActionsMixin Class

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

Controller mixin that implements common actions performed on nodes.

Methods

_affiliateNode

(
  • node
  • institution
)
Promise private

Defined in addon/mixins/node-actions.js:22

Helper method that affiliates an institution with a node.

Parameters:

Returns:

Promise:

Returns a promise that resolves to the updated node with the newly created institution relationship

addChild

(
  • title
  • description
  • category
)
Promise

Defined in addon/mixins/node-actions.js:187

Add a child (component) to a node.

Parameters:

  • title String

    Title for the child

  • description String

    Description for the child

  • category String

    Category for the child

Returns:

Promise:

Returns a promise that resolves to the newly created child node.

addContributor

(
  • userId
  • permission
  • isBibliographic
  • sendEmail
)
Promise

Defined in addon/mixins/node-actions.js:98

Add a contributor to a node

Parameters:

  • userId String

    ID of user that will be a contributor on the node

  • permission String

    User permission level. One of "read", "write", or "admin". Default: "write".

  • isBibliographic Boolean

    Whether user will be included in citations for the node. "default: true"

  • sendEmail Boolean

    Whether user will receive an email when added. "default: true"

Returns:

Promise:

Returns a promise that resolves to the newly created contributor object.

addContributors

(
  • contributors
  • sendEmail
)
Promise

Defined in addon/mixins/node-actions.js:111

Bulk add contributors to a node

Parameters:

  • contributors Array

    Array of objects containing contributor permission, bibliographic, and userId keys

  • sendEmail Boolean

    Whether user will receive an email when added. "default: true"

Returns:

Promise:

Returns a promise that resolves to an array of added contributors

affiliateNode

(
  • institutionId
)
Promise

Defined in addon/mixins/node-actions.js:72

Affiliate a node with an institution

Parameters:

  • institutionId String

    ID of the institutution to be affiliated

Returns:

Promise:

Returns a promise that resolves to the updated node with the newly affiliated institution relationship

apply

(
  • obj
)
private

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

Parameters:

Returns:

applied object

deleteNode

() Promise

Defined in addon/mixins/node-actions.js:62

Delete a node

Returns:

Promise:

Returns a promise that resolves after the deletion of the node.

detect

(
  • obj
)
Boolean private

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

Parameters:

Returns:

Boolean:

removeContributor

(
  • contributor
)
Promise

Defined in addon/mixins/node-actions.js:122

Remove a contributor from a node

Parameters:

  • contributor Object

    Contributor relationship that will be removed from node

Returns:

Promise:

Returns a promise that will resolve upon contributor deletion. User itself will not be removed.

reopen

(
  • arguments
)
private

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

Parameters:

reorderContributors

(
  • contributor
  • newIndex
  • contributors
)
Promise

Defined in addon/mixins/node-actions.js:161

Reorder contributors on a node, and manually updates store.

Parameters:

  • contributor Object

    Contributor record to be modified

  • newIndex Integer

    Contributor's new position in the list

  • contributors Array

    New contributor list in correct order

Returns:

Promise:

Returns a promise that resolves to the updated contributor.

unaffiliateNode

(
  • institution
)
Promise

Defined in addon/mixins/node-actions.js:85

Unaffiliate a node with an institution

Parameters:

  • institution Object

    Institution relationship to be removed from node

Returns:

Promise:

Returns a promise that resolves to the updated node with the affiliated institution relationship removed.

updateContributor

(
  • contributor
  • permissions
  • bibliographic
)
Promise

Defined in addon/mixins/node-actions.js:148

Update contributors of a node. Makes a bulk request to the APIv2.

Parameters:

  • contributor Contributor

    relationship on the node.

  • permissions String

    desired permissions.

  • bibliographic Boolean

    desired bibliographic statuses

Returns:

Promise:

Returns a promise that resolves to the updated node with edited contributor relationships.

updateContributors

(
  • contributors
  • permissionsChanges
  • bibliographicChanges
)
Promise

Defined in addon/mixins/node-actions.js:134

Update contributors of a node. Makes a bulk request to the APIv2.

Parameters:

  • contributors Contributor[]

    Contributor relationships on the node.

  • permissionsChanges Object

    Dictionary mapping contributor ids to desired permissions.

  • bibliographicChanges Object

    Dictionary mapping contributor ids to desired bibliographic statuses

Returns:

Promise:

Returns a promise that resolves to the updated node with edited contributor relationships.

updateNode

(
  • title
  • description
  • category
  • isPublic
)
Promise

Defined in addon/mixins/node-actions.js:36

Update a node

Parameters:

  • title String

    New title of the node

  • description String

    New Description of the node

  • category String

    New node category

  • isPublic Boolean

    Should this node be publicly-visible?

Returns:

Promise:

Returns a promise that resolves to the updated node

Properties

node

DS.Model

Defined in addon/mixins/node-actions.js:14

The node to perform these actions on. If not specified, defaults to the model hook.