API Docs for: undefined
Show:

Plugin.AsyncCommandWithhold Class

Extends Plugin.Base
Defined in: js/async-command-withhold.js:13

Asynchronous command withhold plugin.

Item Index

Attributes

Attributes

withhold

Number

Defined in js/async-command-withhold.js:37

Approximate delay in milliseconds to wait between the time the command function reports completion and when the completed status is updated.

Default: 0

Fires event withholdChange

Fires when the value for the configuration attribute withhold 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.