CtiHostedControl Class

Reference

Definition

Namespace:: Microsoft.Uii.Desktop.Cti.Controls

Assembly:: Microsoft.Uii.Desktop.Cti.Controls.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the CTI hosted control base interface definition.

public ref class CtiHostedControl abstract : Microsoft::Uii::Csr::HostedControl, Microsoft::Uii::Desktop::Cti::Core::ICtiControl

public abstract class CtiHostedControl : Microsoft.Uii.Csr.HostedControl, Microsoft.Uii.Desktop.Cti.Core.ICtiControl

type CtiHostedControl = class
    inherit HostedControl
    interface ICtiControl

Public MustInherit Class CtiHostedControl
Inherits HostedControl
Implements ICtiControl

Inheritance: UserControl

HostedControl
CtiHostedControl

Implements: ICtiControl

Constructors

CtiHostedControl()	Initializes a new instance of the CtiHostedControl class.
CtiHostedControl(Guid, String, String)	Initializes a new instance of the CtiHostedControl class.

Fields

actions	Dictionary of actions (Inherited from HostedControl)
actionsByID	Dictionary of actions (Inherited from HostedControl)

Properties

AgentID	Useful for management apps that need to know who is logged into them. This is used for apps supporting the IHostedApplication2 interface. (Inherited from HostedControl)
AppHostWorkItem	For CAB integration purposes only; allows injection of current WorkItem (Inherited from HostedControl)
ApplicationHost	Intended to provide access to the containing ApplicationHost instance to support advanced hosting senarios. Usage may increase coupling between AIF hosted applications, running counter to the architectural intent of AIF. Setter is for internal use only, it will have no effect. (Inherited from HostedControl)
ApplicationID	Returns the unique id for this hosted application. (Inherited from HostedControl)
ApplicationName	Returns the name of the hosted application as given in the database. (Inherited from HostedControl)
CanEmbed	Returns `true` if the application can be hosted within the UII panels. False if the application can only be integrated with UII via scripts. (Inherited from HostedControl)
ConfigurationReader	Gets or set the hosted controls Configuration Value reader object. (Inherited from HostedControl)
Context	Contains session-wide context. Modifying this also notifies other applications of the context change. (Inherited from HostedControl)
DisplayGroup	The name of the UII panel this application is hosted within. This is taken from the database Application table initialization XML. (Inherited from HostedControl)
EnableAutoSignOn	Get the value of private member variable enableAutoSignOn. (Inherited from HostedControl)
Icon	Used for hosted WinForm apps that want a simple way to set their icons. (Inherited from HostedControl)
ImplementedAsCcf20	Allows system to run certain routines as CCF 2.0 or prior (Inherited from HostedControl)
IsAdapterSessionController	Gets a boolean indicating whether the adapter is a SessionController. (Inherited from HostedControl)
IsDynamic	Gets or sets a value indicating whether this instance is dynamic. (Inherited from HostedControl)
IsGlobal	Tells whether the hosted application is global (Inherited from HostedControl)
IsListed	Allows to be seen but not listed in SessionExplorer or CurrentSessionUI (Inherited from HostedControl)
IsNavigating	Could be used to indicate an application is changing its state. (Inherited from HostedControl)
IsTagged	When true, application is dependent on workflow (Inherited from HostedControl)
OptimumSize	The size that the applications's window will initially be if it is a floating window. (Inherited from HostedControl)
SessionManager	Allows hosted apps to have access to sessions (Inherited from HostedControl)
Text	Sets/Gets the text for the window or tab control containing this application. (Inherited from HostedControl)
TopLevelWindow	Returns a control for the owning window of this hosted app. If this is an external application, then null is returned. (Inherited from HostedControl)

Methods

AddAction(Int32, String, String)	Adds an action for use from one application or the UII core to this application. An action with id of 1 is the default action and is called when initing the application. There is no requirement to have a default action though. (Inherited from HostedControl)
AddImplicitAction(String)	Adds implicit action . Action Id will use the maximum available int . (Inherited from HostedControl)
AnswerCall(CtiCommandRequest)	Answers the call identified by the call ID.
CleanUpAndShutdown()	Cleans up and shuts down any CTI specific functions and should be called as part of shutdown.
Close()	Called when the app is closed. (Inherited from HostedControl)
ConferenceCall(CtiCommandRequest)	Orders a conference command.
Dispose(Boolean)	Cleans up any resources being used.
DoAction(Action, String)	Obsolete. Method to override in the implemention to handle the action. (Inherited from HostedControl)
DoAction(Int32, String)	Obsolete. Called to perform the action configured in the database. Do not override this method! To handle DoAction in your implementation override DoAction(RequestActionEventArgs) instead. (Inherited from HostedControl)
DoAction(RequestActionEventArgs)	Method to override in the implementation to handle the action. (Inherited from HostedControl)
DoAction(String, String)	Obsolete. Called to perform the action configured in the database. (Inherited from HostedControl)
DoDefaultAction()	Performs this hosted application's default action, if there is one. The default action is the one with an id of 1, but it is not required. (Inherited from HostedControl)
ErrorMsg(String, String)	So hosted winform applications can use this and have the same error message style as the rest of the desktop. (Inherited from HostedControl)
ExecuteGenericCommand(String, CtiCommandRequest)	Generic command handler. If the command does not exist in the currnet interface it can be extended via this interface.
FireChangeContext(ContextEventArgs)	Informs all the other applications that the context has changed. (Inherited from HostedControl)
FireRequestAction(RequestActionEventArgs)	Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all apps get the action. (Inherited from HostedControl)
GetAgentId()	Gets the agent ID for the currently logged agent.
GetGlobalAgentConfigVars()	Gets the agent configuration environment variables.
GetIconList()	Gets the icon images (Inherited from HostedControl)
GetStateData()	Gets the application state data for the windows application For now we retrieve only the InputText value (Inherited from HostedControl)
HandleRequestAction(Object, RequestActionEventArgs)	This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. (Inherited from HostedControl)
HandleRequestDefaultAction(Object, DataEventArgs<ApplicationProperties>)	This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. (Inherited from HostedControl)
HangUpCall(CtiCommandRequest)	Releases the call.
HoldCall(CtiCommandRequest)	Holds the call identified by the call ID
InitAndLogOn()	Initializes and logs the agent into CTI.
Initialize()	Called when the application should initialize its internal state (Inherited from HostedControl)
LogOffAgent()	Logs the current agent out.
MakeOutboundCall(CtiCommandRequest)	Dials an out bound number.
NotifyContextChange(Context)	Event which happens whenever the context is changed. (Inherited from HostedControl)
NotifyContextChange(String)	Obsolete. Event which happens whenever the context is changed. This is called by the applicationHost (Inherited from HostedControl)
PickupCall(CtiCommandRequest)	Picks a call up from hold.
PushUrl(CtiCommandRequest)	Pushes a URL.
RejectCall(CtiCommandRequest)	Rejects the call identified by the call ID.
SendChatMessage(CtiCommandRequest)	Sends a chat message to the call identified by the call ID
SessionChange(Boolean, Guid)	Called for global applications when the session is activated or deactivated Not called for non-global applications. (Inherited from HostedControl)
SetAgentMediaAddress(String)	Sets the agents media address
SetAgentState(CtiStateRequest)	Sets the agent state to the requested state.
SetCallVariable(CtiCommandRequest)	Sets a call state variable on the CTI object for the specified call.
SetContext(Context)	Obsolete. This is used to set the context from applicationhost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In otherwords, a race condition. (Inherited from HostedControl)
SetContext(String)	Obsolete. This is used to set the context from applicationhost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In otherwords, a race condition. (Inherited from HostedControl)
SetStateData(String)	Sets the StateData to the controls (Inherited from HostedControl)
TransferCall(CtiCommandRequest)	Orders a call transfer Command
WrapCall(CtiCommandRequest)	Wraps the call identified by the call ID.

Events

ActionCompleted	Obsolete. For internal use (Inherited from HostedControl)
ActionCompletedEvent	Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic. (Inherited from HostedControl)
AgentLogMessageEvent	Raised when a Agent Log Event occurs.
AgentStateChangedEvent	Raised when a Agent State change Event occures
CallDestructedEvent	Raised when a call is terminated.
CallItemEvent	Raised when a Chat Item Event is generated
CallMediaConnectedEvent	Raised when the Media Endpoint connects.
CallNewCallEvent	Raised when a New Call is generated.
CallNewCallInfoEvent	Raised when a new call info event is generated.
CallStateChangeEvent	Raised when a Call State Event is generated
ChangeContext	This event is for internal UII use only and should not be used directly. If your hosted control wants to recieve context change notification, you should be overriding NotifyContextChange method in your implementation. (Inherited from HostedControl)
GeneralCtiEvent	Event used to pass event data not covered in the named events.
RequestAction	Obsolete. For internal use (Inherited from HostedControl)
RequestActionEvent	Event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic. (Inherited from HostedControl)
RequestActionStatusEvent	Event to notify ApplicationHost of action status. (Inherited from HostedControl)

Applies to