Contents

Interfaces

This page lists all COM interfaces in the API. Use hyperlinks on this page to drill down to specific information, such as the methods and properties supported by a particular interface. Interface names are sorted alphabetically.

Interface Name	Description
II3ID	This interface provides a gateway into Interaction Designer. It provides access to handlers, subroutines, tools, and to properties that provide general information about the Designer environment.
II3ID2	This interface is an updated Designer application interface with some small enhancements from the original Designer interface.
II3IDDebugStepEvents	This interface should be implemented by tools that support displaying a read-only dialog for the tool step's properties when debugging a handler.
II3IDEvents	The objects that you create using this interface provide event notification from Interaction Designer.
II3IDEvents2	The objects that you create using this interface receive event notifications from Interaction Designer.
II3IDExitPath	II3IDExitPath exposes the functionality of an exit path defined for a tool, subroutine or initiator. Initiators and subroutines only have 1 exit path. Tool steps can have two or more exit paths.
II3IDExitPaths	II3IDExitPaths implements a collection of exit paths for a tool.
II3IDExpression	II3IDExpression wrappers the expression used when determining the value of a parameter.
II3IDExternal	II3IDExternal provides access to the main Interaction Designer interface pointer.
II3IDHandler	II3IDHandler provides an interface that wraps a handler in Interaction Designer.
II3IDHandler2	II3IDHandler2 provides an enhanced handler interface for Designer from II3IDHandler.
II3IDHandlers	II3IDHandlers implements a collection of the handlers currently opened in Interaction Designer.
II3IDICServer	Information about the current server Designer is connected to.
II3IDICServer2	Server interface
II3IDInitiator	This interface wrappers Initiator objects. An initiator is always the first step in a handler. It tells Interaction Processor which event starts an instance of that handler.
II3IDInitiator2	This is an enhanced version of the original II3IDInitiator interface.
II3IDInitiatorAddOn	Initiators created by II3IDInitaitors::RegisterInitiator must implement this interface. Call II3IDInitiator::RegisterForStepEvents to receive step event notifications.
II3IDInitiatorEvent	The event notification associated with an initiator.
II3IDInitiatorEvents	The events defined for an initiator.
II3IDInitiatorObjectID	The initiator object ID for an initiator.
II3IDInitiatorObjectIDs	This interface manipulates a collection of object ID's defined for an initiator.
II3IDInitiators	II3IDInitiators implements a collection of the currently loaded initiators in Interaction Designer.
II3IDMenuItem	This interface to Interaction Designer's Menu Manager allows custom menus to be added and manipulated as needed.
II3IDMenuItemEvents	This interface provides notification when menus are selected in Interaction Designer.
II3IDMenuItems	II3IDMenuItems implements a collection of menu items.
II3IDMenuManager	This interface permits developers work with custom menus. New menu items can be added to the Utilities menu, and you can obtain a collection of custom menu items.
II3IDMenuManager2	This interface permits developers work with custom menus. New menu items can be added to the Utilities menu, and you can obtain a collection of custom menu items.
II3IDMessage	II3IDMessage is the general container for information logged to the Interaction Designer messages collection.
II3IDMessages	II3IDMessages is a collection of II3IDMessage objects logged for this ID session.
II3IDOldStepInfo	II3IDOldStepInfo is used to communicate information back to a developer about how a step looked in it's 'old' format. This would be a format that is no longer in sync with the currently registered format.
II3IDParameter	II3IDParameter wrappers an Interaction Designer parameter. Parameters are actual instances of parameter definitions. Tool steps, subroutine steps and a handler's initiator will all have an II3IDParameters collection that contains Parameter objects.
II3IDParameterDefinition	II3IDParameterDefinition contains the data definition (meta data) defined for a parameter.
II3IDParameterDefinition2	II3IDParameterDefinition2 is an enhanced version of II3IDParameterDefinition that returns parameter definition (meta data) about a parameter.
II3IDParameterDefinitions	II3IDParameterDefinitions is a collection of parameter definition (meta data) objects.
II3IDParameters	II3IDParameters implements a collection of parameter objects and is obtained when you call II3IDStep::get_Parameters.
II3IDStep	A step is an actual instance of a tool, subroutine or initiator within a handler. To determine what it is an instance of, get its step type and then request the step's SourceTool, SourceInitiator or SourceSubroutine properties.
II3IDStep2	Enhanced II3IDStep interface
II3IDStepEvents	This interface manages step notifications from Interaction Designer.
II3IDStepLink	II3IDStepLink contains the previous step, it's exit path and the next step that this steplink points to.
II3IDStepLinks	II3IDStepLinks implements a collection of links between a step and the steps it connects to, or a collection of all steps that connect to a single step.
II3IDSteps	II3IDSteps implements a collection of steps contained within a handler.
II3IDSubroutine	This interface wraps Interaction Designer Subroutine objects.
II3IDSubroutine2	This interface is an enhanced subroutine interface.
II3IDSubroutines	The II3IDSubroutines interface implements a collection of subroutines.
II3IDTool	II3IDTool provides an interface that wraps tool objects. II3IDTool implements full support for external tools (i.e. tools created by developers) and has limited support for internal tools (i.e. tools created by Interaction Designer itself).
II3IDTool2	This interface is an updated Designer application interface with some small enhancements from the original Designer interface.
II3IDToolAddOn	Tools created by II3IDTools::RegisterTool may implement this interface for callouts from Interaction Designer. Call II3IDTool::RegisterForStepEvents to receive step event notifications.
II3IDTools	II3IDTools implements a collection that contains a collection of tools.
II3IDToolSetAddOn	The II3IDToolSetAddOn interface allows developers to define tools using COM instead of the native DLL API calls.
II3IDType	All variables in Interaction Designer are typed. This interface wrappers the data type of a II3IDVariable variable object, so that you can obtain the description, module, name, and other attributes.
II3IDTypes	II3IDTypes implements a collection of data types that have been defined by currently loaded objects (tools) in Interaction Designer.
II3IDVariable	This interface wrappers all available variables in a handler.
II3IDVariable2	This is an enhanced version of the original II3IDVariable interface.
II3IDVariables	The interface provides access to a collection of variables defined in the current handler.
II3IDXMLStepEvents	This interface should be implemented by tools that support displaying a read-only dialog for the tool step's properties when debugging a handler.