CcmComposerUIAPIV2.Model.RunCallbacks

CcmComposerUIAPIV2.Model.RunCallbacks call returns a RunCallbacks object that can be passed to the Start call. The call takes a single object as an argument. From this object, the following attributes are registered as a callback:

• onruncompleted. Function(RunInfo, Result). This function is called when the interactive document composition process is completed successfully. During the callback, RunInfo and Result objects are passed. The element identified by the elementid parameter on the Start call contains the latest form presented to the end user during the interactive document composition.

  If the call does not contain any form, see RunInfo for the attribute hasbeeninteractive.

• onrunsuspended. Function(RunInfo). This function is called when the interactive document composition is suspended by the user. During the callback, a RunInfo object is passed. The element identified by the elementid parameter on the Start call contains the last form presented to the end user during interactive document composition.

  If the call does not contain any form, see RunInfo for the attribute hasbeeninteractive.

• onrunfailed. Function(RunInfo, Error). This function is called when the interactive document composition is completed in an error state. During the callback, RunInfo and Error objects are passed.
• oncwfieldchanged. Function(RunInfo, FieldInfo). This function is called whenever a user makes a change that has an effect on a Field in an interactive Content Wizard. This could either be selection or de-selection of a Section or Text Block, a change to the content of an editable Text Block, or an answer to a question in a QForm. During the callback, RunInfo and FieldInfo objects are passed.

  This attribute does not apply to editable Rich Text Blocks.

• onerror. Function(RunInfo, Error). This function is called when an error occurs during the interactive document composition, but the process continues. During the callback, RunInfo and Error objects are passed.