API Docs for: 0.25.0
Show:

RegistrationActionsMixin Class

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

Controller mixin that implements common actions performed on registrations (and registration drafts).

Methods

_generateRegistrationPayload

(
  • draft
  • registrationChoice
  • liftEmbargo
)
Object private

Defined in addon/mixins/registration-actions.js:51

Build the request payload used when creating a registration from a draft.

Parameters:

  • draft String

    ID of the draft registration

  • registrationChoice String

    Either "immediate" or "embargo".

  • liftEmbargo Date

    if registrationChoice === "embargo", liftEmbargo should be the date to lift the embargo.

Returns:

Object:

Returns the attributes portion of the payload for creating a registration.

_updateMetadata

(
  • currentMetadata
  • newMetadata
)
Object

Defined in addon/mixins/registration-actions.js:28

Update the current registration metadata with new responses. Takes the currentMetadata and recursively merges in the newMetadata.

Parameters:

  • currentMetadata Object

    The registration metadata at last save.

  • newMetadata Object

    New registration metadata.

Returns:

Object:

Returns merge of currentMetadata and newMetadata

apply

(
  • obj
)
private

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

Parameters:

Returns:

applied object

createDraft

(
  • schemaId
)
Promise

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

Create a draft registration of the node.

Parameters:

  • schemaId String

    ID of the chosen registration schema

Returns:

Promise:

Returns a promise that resolves to the updated node - with the newly created draft registration.

deleteDraft

(
  • draft
)
Promise

Defined in addon/mixins/registration-actions.js:88

Delete a draft registration of the node.

Parameters:

  • draft Object

    Draft to be deleted

Returns:

Promise:

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

detect

(
  • obj
)
Boolean private

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

Parameters:

Returns:

Boolean:

editDraft

(
  • updatedMetadata
)
Promise

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

Edit a draft registration of the node

Parameters:

  • updatedMetadata Object

    Responses to questions in the registration schema, nested in the format the registration schema expects to questions in the registration schema

Returns:

Promise:

Returns a promise that resolves to the updated draft

registerDraft

(
  • updatedMetadata
  • registrationChoice
  • liftEmbargo
)
Promise

Defined in addon/mixins/registration-actions.js:114

Register a draft (creates a registration from a draft)

Parameters:

  • updatedMetadata Object

    esponses to questions in the registration schema, nested in the format the registration schema expects

  • registrationChoice String

    Either "immediate" or "embargo".

  • liftEmbargo Date

    if registrationChoice === "embargo", liftEmbargo should be the date to lift the embargo.

Returns:

Promise:

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

reopen

(
  • arguments
)
private

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

Parameters:

Properties

draft

DS.Model

Defined in addon/mixins/registration-actions.js:20

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

node

DS.Model

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

TODO: Document this parameter