CtiCallStateManager Class

Article
02/21/2017

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

Represents the abstract class interface for the call state manager.

Namespace: Microsoft.Uii.Desktop.Cti.Core
Assembly: Microsoft.Uii.Desktop.Cti.Core (in Microsoft.Uii.Desktop.Cti.Core.dll)

Inheritance Hierarchy

System.Object
Microsoft.Uii.Desktop.Cti.Core.CtiCallStateManager

Syntax

public abstract class CtiCallStateManager : ICtiCallStateManager

Public MustInherit Class CtiCallStateManager
    Implements ICtiCallStateManager

Constructors

	Name	Description
	CtiCallStateManager(ICtiControl)	Initializes a new instance of the CtiCallStateManager class.

Properties

	Name	Description
	CallCount	Gets the number of calls currently in local call list.
	CallersList	Gets or sets the collection of calls that are being managed.
	CtiHostedControl	Gets the pointer to the core CTI interface object that was used to construct this call state manager.
	EnableAutoAnswer	Gets or sets the Boolean value that specifies whether auto answer is enabled.
	EnableOverrideAutoAnswerOnExistingCalls	Gets or sets the Boolean value that specifies whether override auto answer is enabled on existing calls.
	GetCurrentActiveCallCount	Gets the count of active calls.
	GetRootCtiInterface	Gets the root CTI hosted control.

Methods

	Name	Description
	AddCallInfoItemToCallersList(CallInfoData)	Adds a CallInfoData Item to the CallersList.
	AnswerCall(Guid)	Checks whether the call with the given call reference ID is answered.
	ConferenceCall(Guid, Dictionary<String, String>)	Checks whether the call is conferenced.
	DirectDialOut(String)	Checks whether the direct dial out was successful.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetCallInfoData(Guid)	Gets a CallInfoData object by call reference ID.
	GetCallInfoData(String)	Gets a CallInfoData object by the string version of the cti vendor call ID.
	GetCallState(Guid)	Gets the current call state.
	GetCallVariable(Guid, String)	Required Override This function is called to get a variable from the Call
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	HangUpCall(Guid)	Executes a hang-up call request to the base interface.
	HoldCall(Guid)	Executes a hold call request to the base interface.
	IsCallActive(Guid)	Checks whether the current call is active. Required override.
	MemberwiseClone()	(Inherited from Object.)
	OnCallDestructed(CtiCoreEventArgs)	Called when the call is terminated.
	OnCallInfoEvent(CtiCoreEventArgs)	Event Sink for the new call info event.
	OnCallItemEvent(CtiCoreEventArgs)	Event sink for call item events from the CTI system.
	OnCallStateChanged(CtiCoreEventArgs)	Event Sink for the call status changed event.
	OnNewCallEvent(NewCallEventData)	Event sink for the new call event.
	PickupCall(Guid)	Executes a pick up call request to the base interface.
	PushUrl(Guid, Dictionary<String, String>)	Executes a push URL command
	RaiseCallStateChangeEvent(CtiCallEventArgs)	Raises state change event.
	RaiseNewCallEvent(NewCallEventArgs)	Raises a new call event if a new call event is wired.
	RejectCall(Guid, Dictionary<String, String>)	Executes a reject call command to the base interface.
	RemoveCall(CallInfoData)	Removes a call from the calls list.
	RemoveCall(String)	Removes a call from the calls list by the string version of the cti vendor call ID.
	SendChatMessage(Guid, Dictionary<String, String>)	Executes a send chat message command
	SetCallVariables(Guid, Dictionary<String, String>)	Sets the call variables into a call.
	ToString()	(Inherited from Object.)
	TransferCall(Guid, Dictionary<String, String>)	Transfers a call using the additional data to pass the nessessary data to the CTI connector.
	UpdateCallInfoItemEntry(CallInfoData)	Updates a CallInfoData item in the CallersList
	UpdateState()	Updates the current state to new UI controls.
	WrapUpCall(Guid, Dictionary<String, String>)	Executes a Wrap up call command to the base interface

Events

	Name	Description
	CallDestructed	Raised when a call is terminated.
	CallItemEvent	Raised when a new call item information event is received.
	CallManagerStateNewCall	Raised when a new call is received.
	CallManagerStateUpdate	Raised when a call’s state changes.

Remarks

This class is intended to be overridden as necessary to provide implementation points for custom CTI commands.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via