From Bright Pattern Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.

• 5.2 • 5.3

API Events

evtApiUp

evtApiUp is sent when the API is successfully connected (or reconnected) to the softphone.

Note that no information is provided about calls that already may be present on the Agent Desktop.

Syntax

void evtApiUp(System.EventArgs args);


evtApiDown

evtApiDown is 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.

Syntax

void evtApiDown(System.EventArgs args);


evtCallDialing

evtCallDialing is 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 the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void evtCallDialing(DesktopControlAPI.CallArgs args);


evtCallOffered

evtCallOffered is sent when the softphone receives a new incoming call.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void evtCallOffered(DesktopControlAPI.CallArgs args);


evtCallDisconnected

evtCallDisconnected is sent when an existing call is released.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void evtCallDisconnected(DesktopControlAPI.CallArgs args);


onError

onError is sent when an error occurs while executing a method.

For parameters, see the description of auxiliary class DesktopControlAPI.ErrorEventArgs.

Syntax

void onError(DesktopControlAPI. ErrorEventArgs args);


onCallRecordingStarted

onCallRecordingStarted is sent when call recording is started. Note that this event does not indicate that a call was established or if a call was not recorded.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void onCallRecordingStarted(DesktopControlAPI.CallArgs args);


onCallRecordingStopped

onCallRecordingStopped is sent when call recording is stopped.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void onCallRecordingStopped(DesktopControlAPI.CallArgs args);


onCallRecordingMuted

onCallRecordingMuted is sent when call recording is muted.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void onCallRecordingMuted(DesktopControlAPI.CallArgs args);


onCallRecordingUnmuted

onCallRecordingUnmuted is sent when call recording is unmuted.

For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.

Syntax

void onCallRecordingUnmuted(DesktopControlAPI.CallArgs args);


onScreenRecordingStarted

onScreenRecordingStarted is sent when screen recording is started.

For parameters, see the description of auxiliary class DesktopControlAPI.ScreenRecordingArgs.

Syntax

void onScreenRecordingStarted(DesktopControlAPI.ScreenRecordingArgs args);


onScreenRecordingCompleted

onScreenRecordingCompleted is sent when screen recording is stopped.

For parameters, see the description of auxiliary class DesktopControlAPI.ScreenRecordingArgs.

Syntax

void onScreenRecordingCompleted(DesktopControlAPI.ScreenRecordingArgs args);


onScreenRecordingsMuted

onScreenRecordingsMuted is sent when screen recording is muted.

For parameters, see the description of auxiliary class DesktopControlAPI.BaseEventArgs.

Syntax

void onScreenRecordingsMuted(DesktopControlAPI. BaseEventArgs args);


onScreenRecordingsUnmuted

onScreenRecordingsUnmuted is sent when screen recording is unmuted.

For parameters, see the description of auxiliary class DesktopControlAPI.BaseEventArgs.

Syntax

void onScreenRecordingsUnmuted (DesktopControlAPI.BaseEventArgs args);


< Previous | Next >