dojox/wire/ml/Invocation.js

• Provides:

  • dojox.wire.ml.Invocation

• Requires:

  • dojox.wire.ml.Action in common

• dojox.wire.ml.Invocation

  • type

    Function

  • chains:
    • dojox.wire.ml.Action: (prototype)
    • dojox.wire.ml.Action: (call)
  • summary

    A widget to invoke a method or publish a topic

  • description

    This widget represents a controller task to invoke a method or
    publish a topic when an event (a function) or a topic is issued.

• dojox.wire.ml.Invocation.object

  • type

    A

  • summary

    scope of a method to invoke

• dojox.wire.ml.Invocation.method

  • type

    A

  • summary

    name of a method to invoke

• dojox.wire.ml.Invocation.topic

  • type

    A

  • summary

    name of a topic to publish

• dojox.wire.ml.Invocation.parameters

  • type

    Arguments

  • summary

    for the method or the topic

• dojox.wire.ml.Invocation.result

  • type

    A

  • summary

    property to store a return value of the method call

• dojox.wire.ml.Invocation.error

  • type

    A

  • summary

    property to store an error on the method call

• dojox.wire.ml.Invocation._run

  • returns

    undefined

  • summary

    Invoke a method or publish a topic

  • description

    If 'topic' is specified, the topic is published with arguments
    specified to 'parameters'.
    If 'method' and 'object' are specified, the method is invoked
    with arguments specified to 'parameters' and set the return
    value to a property specified to 'result'.
    'object', 'parameters' and 'result' can specify properties of
    a widget or an DOM element with the dotted notation.
    If 'parameters' are omitted, the arguments to this method are
    passed as is.

  • type

    Function

• dojox.wire.ml.Invocation.onComplete

  • parameters:
    • result: (typeof anything)

      The return value of a method or undefined for a topic

  • summary

    A function called when the method or the topic publish
    completed

  • description

    If 'result' attribute is specified, the result object also set
    to the specified property.

  • type

    Function

• dojox.wire.ml.Invocation.onError

  • parameters:
    • error: (typeof anything)

      The exception or error occurred

  • summary

    A function called on an error occurs

  • description

    If 'error' attribute is specified, the error object also set to
    the specified property.

  • type

    Function

• dojox.wire.ml.Invocation._getParameters

  • parameters:
    • args: (typeof Array)

      Arguments to a trigger event or topic

  • returns

    Array

  • summary

    Returns arguments to a method or topic to invoke

  • description

    This method retunrs an array of arguments specified by
    'parameters' attribute, a comma-separated list of IDs and
    their properties in a dotted notation.
    If 'parameters' are omitted, the original arguments are
    used.

  • type

    Function

• dojox.wire.ml

  • type

    Object

• dojox.wire

  • type

    Object

• dojox

  • type

    Object