API Docs for: undefined
Show:

AsyncCommand Class

Extends Base
Defined in: ../gallery-async-command/js/async-command.js:21

Asynchronous command class.

Item Index

Methods

Attributes

Events

Methods

run

() chainable

Defined in ../gallery-async-command/js/async-command.js:106

Execute the command function.

Attributes

args

Array

Defined in ../gallery-async-command/js/async-command.js:117

Array of arguments to be passed to the command function. A special callback function is automatically added as the first argument.

Default: []

Fires event argsChange

Fires when the value for the configuration attribute args is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

completed

Boolean

Defined in ../gallery-async-command/js/async-command.js:139

Boolean value indicating the completed status of the command.

Default: false

Fires event completedChange

Fires when the value for the configuration attribute completed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

ctx

Defined in ../gallery-async-command/js/async-command.js:150

Execution context for the command function.

Fires event ctxChange

Fires when the value for the configuration attribute ctx is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

error

Defined in ../gallery-async-command/js/async-command.js:159

Error value passed to the failure event.

Fires event errorChange

Fires when the value for the configuration attribute error is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

failed

Boolean

Defined in ../gallery-async-command/js/async-command.js:168

Boolean value indicating the failed status of the command.

Default: false

Fires event failedChange

Fires when the value for the configuration attribute failed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

fn

Function

Defined in ../gallery-async-command/js/async-command.js:179

The command function to execute. This function receives a special success callback function as the first parameter. The success callback function has a method parameter called fail. One of these callback functions must be called in order to complete the command.

Fires event fnChange

Fires when the value for the configuration attribute fn is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

started

Boolean

Defined in ../gallery-async-command/js/async-command.js:195

Boolean value indicating the started status of the command.

Default: false

Fires event startedChange

Fires when the value for the configuration attribute started is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

value

Defined in ../gallery-async-command/js/async-command.js:206

Value passed to the success event.

Fires event valueChange

Fires when the value for the configuration attribute value is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

complete

Defined in ../gallery-async-command/js/async-command.js:31

Fired when the command function completes.

Event Payload:

  • error Object

    Optional error value.

  • failed Boolean

    Indicates the failed status of the command.

  • value Object

    Optional return value from the command function.

failure

protected

Defined in ../gallery-async-command/js/async-command.js:47

Fired when the command function fails.

Event Payload:

  • error Object

    Optional error value.

start

protected

Defined in ../gallery-async-command/js/async-command.js:69

Fired when the command function starts.

success

protected

Defined in ../gallery-async-command/js/async-command.js:83

Fired when the command function succeeds.

Event Payload:

  • value Object

    Optional return value from the command function.