Contents

II3IDInitiator Interface

Overview

Derived From: IDispatch

Interface ID: {B73E8AC5-0016-40F3-AEAE-34BA6B78564A}

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.

When one of the modules in CIC, such as Telephony Services, generates an event. Notifier sees the event and tells other modules about that event. One of these modules is Interaction Processor, where the handlers are registered. When the Notifier tells the Interaction Processor about an event, Interaction Processor starts an instance of a handler.

When you publish a handler, the handler's initiator tells Interaction Processor which event to watch for. An event is something that happens to an object. For example, a call (object) can be sent to voice mail (event). If an initiator is configured in a handler to start when calls are sent to voice mail, then Interaction Processor starts that handler any time it is notified of that event.

Note: Subroutine initiators are different from other initiators because they are started by a call from another handler instead of an event that occurs on the CIC system. See also the Interaction Designer help system (id.chm) for more information about initiators.

Methods

Commit	Commits an initiator object so that it can be used by handler developers.
RegisterForStepEvents	Registers for step events from ID for this initiator.

Properties

Description	Returns the description of this initiator.
Designer	Returns an Interaction Designer interface pointer.
Events	Returns a collection of the currently selected steps for the active view of the handler (if it's active).
ExitPath	Returns the exit path for the initiator.
HelpContext	Returns the WinHelp context string associated with this initiator.
HelpFile	Returns the name of the WinHelp help file that describes this initiator.
II3IDInitiatorAddOnInstance	Returns a COM Interface pointer to the initiator registered in Interaction Designer if the InitiatorSpecifier parameter to II3IDInitaitors::RegisterInitiator identified a COM object that implemented the II3IDInitiatorAddOn interface.
InitNotificationObjectType	Returns the notification event associated with this initiator.
IsCommitted	Lets you know whether or not this initiator has been committed.
IsExternal	Indicates whether or not this initiator is an external initiator.
Label	Returns the label for this initiator.
ModuleName	Returns the module name for this initiator.
Name	Returns the name of this initiator.
ObjectIDs	Returns a collection of the currently selected steps for the active view of the handler. The handler must be active.
ParameterDefinitions	Returns a collection of parameter definitions for this initiator. Calls to this property to retrieve parameter definitions for an internal intiator or internal tool will fail, rather than return an empty collection.
RuntimeDLLName	Returns the runtime DLL name for the initiator.
RuntimeFunctionName	Returns the runtime function name for the initiator.
Version	Returns the registered version of this initiator.