From Bright Pattern Documentation
< 3.13:Simplified-desktop-net-api-specification
Revision as of 22:52, 26 August 2016 by Sasha (talk | contribs) (Created new topic from branched topic Documentation:ServicePattern:simplified-desktop-net-api-specification:APIEvents:3.12)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

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 CallDial 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.


< Previous | Next >
< Previous | Next >