ASTCstaProviderInterface Class Reference

This is the main class of Activa framework. Provides a csta-like programming interface. More...

#include <ActivaAPI.h>

Inheritance diagram for ASTCstaProviderInterface:

List of all members.

Public Member Functions
virtual AC_RESULT	Connect (std::string sHost, int nPort, std::string user, std::string pwd, AUTH_TYPE eAuthType=at_md5)=0
	factory method
virtual bool	Disconnect ()=0
	Disconnect from Asterisk.
virtual MonitorXref	OpenMonitor (std::string deviceId)=0
virtual bool	CloseMonitor (MonitorXref xref)=0
	Close a previously opened monitor.
virtual AC_RESULT	MakeCall (std::string callingDevice, std::string contextCalling, std::string calledDevice, DWORD &callid, std::string contextCalled, std::string callerIdName, std::string userData, std::string variable, bool bLockReaderAfterResponse=false)=0
	Originates a call from callingDevice to calleddevice using 'context'.
virtual AC_RESULT	MakePredictiveCall (std::string callingDevice, std::string contextCalling, std::string calledDevice, std::string contextCalled, DWORD &callid, std::string callerId, std::string userData, DWORD timeout, std::string variable, bool bLockReaderAfterResponse=false)=0
	Originate a predictive call from callingDevice to calledDevice using 'context'.
virtual AC_RESULT	ClearCall (DWORD callId)=0
	Disconnects a call identified by uniqueid/callid.
virtual AC_RESULT	ClearConnection (DWORD callid, std::string address)=0
	Disconnects a Connection identified by callId and device).
virtual AC_RESULT	FastTransfer (DWORD callId, std::string transferringDevice, std::string destination, std::string destinationContext)=0
	Redirects a call to an extsnsion.
virtual AC_RESULT	SetDoNotDisturb (std::string deviceId, bool bDND_on, std::string dndContext)=0
	Sets Do-not-disturb flag on/off.
virtual AC_RESULT	SetAgentStatus (std::string deviceId, std::string queue, AGENT_STATUS newStatus, std::string agentContext)=0
	Set agentState.
virtual AC_RESULT	StartRecording (DWORD callid, std::string address, std::string RecordingFileName, std::string format, std::string mix)=0
	Start Recording.
virtual AC_RESULT	StopRecording (DWORD callid, std::string address)=0
	Stop Recording.
virtual AC_RESULT	PauseRecording (DWORD callid, std::string address)=0
	Pause Recording.
virtual AC_RESULT	UnpauseRecording (DWORD callid, std::string address)=0
	Unpause Recording.
virtual AC_RESULT	ChangeRecordingFileName (DWORD callid, std::string address, std::string NewRecordingFileName)=0
	Change Recording File Name.
virtual DWORD	GetNewCallId ()=0
virtual bool	DropCallId (DWORD idCall)=0
virtual bool	GetMonitorSet (DWORD callId, Set_xref &setXref)=0
virtual void	UnLockReader ()=0

---

Detailed Description

This is the main class of Activa framework. Provides a csta-like programming interface.

This is an interface to the main class of Activa framework ASTCstaProvider. Provides a csta-like programming interface. To create an instance you can call CreateASTCSTAProvider factory method Events are reported through a listener class implementing ASTCstaListener interface. A custom logger can be attached via ASTLogListener

---

Member Function Documentation

virtual AC_RESULT ASTCstaProviderInterface::Connect	(	std::string	sHost,
		int	nPort,
		std::string	user,
		std::string	pwd,
		AUTH_TYPE	eAuthType = at_md5
	)			[pure virtual]

factory method

Connect to Asterisk

Implemented in ASTCstaProvider.

virtual bool ASTCstaProviderInterface::DropCallId

(

DWORD

idCall

)

[pure virtual]

Returns:

result This method is implemented ONLY to allow ASTTapiProvider::TSPI_lineMakeCall() to drop a idCall previously acquired through GetCallId()

Implemented in ASTCstaProvider.

virtual bool ASTCstaProviderInterface::GetMonitorSet	(	DWORD	callId,
		Set_xref &	setXref
	)			[pure virtual]

returns the monitor set linked to the given callid

Implemented in ASTCstaProvider.

virtual DWORD ASTCstaProviderInterface::GetNewCallId

(

)

[pure virtual]

Returns:

New Callid This method is implemented ONLY to allow ASTTapiProvider::TSPI_lineMakeCall() to get a real unique callid before Originate().

Implemented in ASTCstaProvider.

virtual MonitorXref ASTCstaProviderInterface::OpenMonitor

(

std::string

deviceId

)

[pure virtual]

Opens a monitor to a device. Monitors are refererd by an opaque int handler known as monitor xref (monitor cross-reference)

Implemented in ASTCstaProvider.

virtual void ASTCstaProviderInterface::UnLockReader

(

)

[pure virtual]

UnLocks Reader Thread

Implemented in ASTCstaProvider.

---

The documentation for this class was generated from the following file:

• astprovider/ActivaAPI/ActivaAPI.h