The base class necessary to communicate to the DMCC Server.
| C# | Visual Basic | Visual C++ |
public class ServiceProvider : IServiceProvider
Public Class ServiceProvider _ Implements IServiceProvider
public ref class ServiceProvider : IServiceProvider
| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
| ServiceProvider()()() |
The base object for DMCC communication.
| |
| ConvertDialStringToE164(String, List<(Of <(String>)>), Object) |
Convert one or more dial strings to E164 format.
| |
| ConvertE164ToDialString(String, List<(Of <(String>)>), Object) |
Convert one or strings which are in E164 format to dial strings.
| |
| DefaultApplicationName |
The default name of the application which invoked the Service Provider.
| |
| Finalize()()() |
This destructor will also close the socket to the server (if it has not already been closed).
(Overrides Object.Finalize()()().) | |
| getActualProtocolVersion |
The protocol version that DMCC is using.
| |
| GetAutoKeepAliveEnabled()()() |
Lets the application know if auto keep alive is enabled.
| |
| GetCallInformationLink |
Returns a reference to the CallInformationLink object
| |
| GetDevice(String) |
Given a device name (Id), returns a reference to the associated Device.
| |
| GetDeviceIdList(Object) |
Get all the Device IDs that are active on the DMCC server.
| |
| GetDeviceIdList(String, Object) |
Get all the Device Ids that are active for a particular session id.
| |
| GetMonitorList(Object) |
Get a list of all the monitors which are active on this DMCC server.
| |
| GetMonitorList(String, Object) |
Get a list of all the monitors which are active on a particular session id.
| |
| GetNewDevice()()() |
Creates a new Device object and returns a reference to it.
| |
| getSessionId |
Returns the session name (id) as a string
| |
| GetSessionIdList(Object) |
Retrieve all the active sessions that are running in a DMCC server.
| |
| getThirdPartyCallController |
Returns a reference to the ThirdPartCallControl object
| |
| getXmlProcessor |
Returns a reference to the XML Processor object
| |
| Log |
The name of the log4net error logger. The config file is DMCC.config and must be in the same folder as the application
that is using the .NET API is in.
| |
| OnConvertDialStringToE164Response |
Handler for ConvertDialStringToE164Response responses.
| |
| OnConvertE164ToDialStringResponse |
Handler for ConvertE164ToDialStringResponse responses.
| |
| OnGetDeviceIdListEvent |
Handler for GetDeviceIdListEvent events.
| |
| OnGetDeviceIdListResponse |
Handler for GetDeviceIdListResponse responses.
| |
| OnGetMonitorListEvent |
Handler for GetMonitorListEvent events.
| |
| OnGetMonitorListResponse |
Handler for GetMonitorListResponse responses.
| |
| OnGetSessionIdListResponse |
Handler for GetSessionIdListResponse responses.
| |
| OnMissedAtLeastOneKeepAliveEvent |
Handler for Missed Keep Alive events.
| |
| OnResetApplicationSessionResponse |
Handler for ResetApplicationSession responses.
| |
| OnServerConnectionDownEvent |
Handler for Server Connection Down events.
| |
| OnServerConnectionNotActiveEvent |
Handler for Server Connection Not Active events.
| |
| OnSessionManagementStartMonitorResponse |
Event registration for responses to SessionManagementStartMonitor requests.
| |
| OnSessionManagementStopMonitorResponse |
Event registration for responses to SessionManagementStopMonitor requests.
| |
| OnStartApplicationSessionResponse |
Handler for StartApplcationSession responses.
| |
| OnStopApplicationSessionResponse |
Handler for StopApplicaitonSession responses.
| |
| OnTransferMonitorObjectsEvent |
Handler for TransferMonitorObjectsEvent events.
| |
| OnTransferMonitorObjectsResponse |
Handler for TransferMonitorObjectsResponse responses.
| |
| Reconnect(String, Object) |
Sends a StartApplicationSession message to the server. If sessionId is not null then the server will try to reconnect
a session that has timed out or become inactive.
| |
| ResetApplicationSession(Object, Int32) |
Send a ResetApplicationSession XML message to the server.
| |
| SessionManagementStartMonitor(ServiceProvider..::.SessionManagementEvents, String, Object) |
Start the monitor for session management.
| |
| SessionManagementStopMonitor(String, Object) |
Stop a session magagement monitor.
| |
| ShutDown(ServiceProvider..::.ServiceProviderObjectDeactivatedEventArgs..::.ServiceProviderObjectDeactivatedReason, String) |
Allows the application to tell the Service Provider to shutdown. The Service Provider will in turn notify ThirdPartyCallControl,
CallInformationLink, and all the Devices that have been created to also shut down. The Devices in turn will notify their
Phone objects. The Phone Pbjects will in turn notify their Media Objects.
Calling this method will also force the socket to the server to be closed. Therefore, once this method returns control to the application the
application should not invoke any methods which will result in a message being sent to the server. If the application does do this then
exceptions will be thrown back to the application.
Note: The API provides a callback (OnObjectDeactivatedEvent) for all publicly exposed objects. This will allow the application the ability to easily
be notified when an object has bee shutdown (deactivated).
| |
| StartApplicationSession(String, Int32, String, String, String, Int32, Int32, String, Boolean, Object, Boolean, Boolean) |
Sends a StartApplicationSession message to the server.
| |
| StartApplicationSession(String, Int32, String, String, String, Int32, Int32, String, Boolean, Object, Boolean, Boolean, LocalCertificateSelectionCallback) |
Sends a StartApplicationSession message to the server.
| |
| StartAutoKeepAlive(Int32) |
Tell the API to start automatically sending the ResetApplicationSession messages every InernalInMs milliseconds. 1,000 milliseconds is 1 second.
If the API is already sending messages then it will cease doing so on the previous interval.
| |
| StopApplicationSession(String, Object) |
Sends a Stop ApplicationSession XML message to the server. If Devices have objects that are registered the API will attempt to
unregister them BEFORE sending this message. In general, the application should have unregistered all devices (and processed the
unregistration response) BEFORE invoking this method.
| |
| StopAutoKeepAlive()()() |
Stops the ResetApplicationSession messages from automatically being sent to the server.
| |
| TransferMonitorObjects(String, String, Object) |
Transfer all the devices and monitors from one session to another session. The session which the
monitors are being trasferred from will be closed by the DMCC server.
|
| Object | |
| ServiceProvider | |
Assembly: ServiceProvider (Module: ServiceProvider)