From Bright Pattern Documentation
Contents
- Introduction
- API Specification
- General Information
- Event Delivery
- API Instantiation and Initialization
- API Methods
- 1 API Events
- 1.1 evtApiUp
- 1.2 evtApiDown
- 1.3 evtCallDialing
- 1.4 evtCallOffered
- 1.5 evtCallDisconnected
- 1.6 onError
- 1.7 onCallRecordingStarted
- 1.8 onCallRecordingStopped
- 1.9 onCallRecordingMuted
- 1.10 onCallRecordingUnmuted
- 1.11 onScreenRecordingStarted
- 1.12 onScreenRecordingCompleted
- 1.13 onScreenRecordingsMuted
- 1.14 onScreenRecordingsUnmuted
- API Properties
- Auxiliary Classes
Simplified Desktop .NET API Specification
API Events
evtApiUp
Syntax | void evtApiUp(System.EventArgs _args); |
Description | Sent when the API is successfully connected (or reconnected) to the softphone. Note that no information is provided about calls which may already be present on the Agent Desktop. |
evtApiDown
Syntax | void evtApiDown(System.EventArgs _args); |
Description | Sent when the ShutdownAPI method is called or when the API loses connection to the softphone. In case of connection loss, the API will try to reconnect every 15 seconds; once reconnected the evtApiUp event is sent. |
evtCallDialing
Syntax | void evtCallDialing(DesktopControlAPI.CallArgs args); |
Description | Sent when the softphone starts dialing a call. Note that this event reports calls both initiated by a prior Dial method and dialed directly from the Agent Desktop. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
evtCallOffered
Syntax | void evtCallOffered(DesktopControlAPI.CallArgs args); |
Description | Sent when the softphone receives a new incoming call. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
evtCallDisconnected
Syntax | void evtCallDisconnected(DesktopControlAPI.CallArgs args); |
Description | Sent when an existing call is released. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
onError
Syntax | void onError(DesktopControlAPI. ErrorEventArgs args); |
Description | Sent when an error occurs while executing a method. For parameters, see description of auxiliary class DesktopControlAPI.ErrorEventArgs. |
onCallRecordingStarted
Syntax | void onCallRecordingStarted(DesktopControlAPI.CallArgs _args); |
Description | Sent when call recording is started. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
onCallRecordingStopped
Syntax | void onCallRecordingStopped(DesktopControlAPI.CallArgs _args); |
Description | Sent when call recording is stopped. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
onCallRecordingMuted
Syntax | void onCallRecordingMuted(DesktopControlAPI.CallArgs args); |
Description | Sent when call recording is muted. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
onCallRecordingUnmuted
Syntax | void onCallRecordingUnmuted(DesktopControlAPI.CallArgs args); |
Description | Sent when call recording is unmuted. For parameters, see description of auxiliary class DesktopControlAPI.CallArgs. |
onScreenRecordingStarted
Syntax | void onScreenRecordingStarted(DesktopControlAPI.ScreenRecordingArgs _args); |
Description | Sent when screen recording is started. For parameters, see description of auxiliary class DesktopControlAPI.ScreenRecordingArgs. |
onScreenRecordingCompleted
Syntax | void onScreenRecordingCompleted(DesktopControlAPI.ScreenRecordingArgs _args); |
Description | Sent when screen recording is stopped. For parameters, see description of auxiliary class DesktopControlAPI. ScreenRecordingArgs. |
onScreenRecordingsMuted
Syntax | void onScreenRecordingsMuted(DesktopControlAPI. BaseEventArgs args); |
Description | Sent when screen recording is muted. For parameters, see description of auxiliary class DesktopControlAPI. BaseEventArgs. |
onScreenRecordingsUnmuted
Syntax | void onScreenRecordingsUnmuted (DesktopControlAPI. BaseEventArgs args); |
Description | Sent when screen recording is unmuted. For parameters, see description of auxiliary class DesktopControlAPI. BaseEventArgs. |