Interface ISignalingHandler
The interface that provides all the signaling events to the user.
Namespace: Microsoft.Bot.Builder.Enterprise.Core
Assembly: Microsoft.Bot.Builder.Enterprise.dll
Syntax
public interface ISignalingHandlerMethods
View SourceOnIncomingCallCompletedAsync(ICall, AnswerNotification)
Called when an incoming call is completed. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnIncomingCallCompletedAsync(ICall call, AnswerNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| AnswerNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnIncomingCallReceivedAsync(ICall, Conversation)
Called when an incoming call is received. Returns one of the allowed options:
- AnswerOption
- DeclineOption
- RouteCallOption The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task<AnswerOption> OnIncomingCallReceivedAsync(ICall call, Conversation conversation)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| Conversation | conversation | The conversation contained in the incoming call. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AnswerOption> | The AnswerOption. |
OnJoinCallCompletedAsync(ICall, JoinCallNotification)
Called when a join call is completed. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnJoinCallCompletedAsync(ICall call, JoinCallNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| JoinCallNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnPlaceCallCompletedAsync(ICall, PlaceCallNotification)
Called when a outgoing placeCall is completed.. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnPlaceCallCompletedAsync(ICall call, PlaceCallNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| PlaceCallNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnPlayMediaCompletedAsync(ICall, PlayNotification)
Called when a play media action is completed. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnPlayMediaCompletedAsync(ICall call, PlayNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| PlayNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnRosterChangedAsync(ICall, RosterUpdateNotification)
Called when the call roster has changed. The execution time of this method should take no more than 5 seconds, otherwise the backend server will consider this notification as timed-out.
Declaration
Task OnRosterChangedAsync(ICall call, RosterUpdateNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| RosterUpdateNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnRouteCallCompletedAsync(ICall, RouteCallNotification)
Called when a forward call action is completed. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnRouteCallCompletedAsync(ICall call, RouteCallNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| RouteCallNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnStateChangedAsync(ICall, CallStateChangeNotification)
Called when the call state has changed. The execution time of this method should take no more than 5 seconds, otherwise the backend server will consider this notification as timed-out.
Declaration
Task OnStateChangedAsync(ICall call, CallStateChangeNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| CallStateChangeNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |
OnTransferCompletedAsync(ICall, TransferNotification)
Called when a transfer call is completed. The execution time of this method should take no more than 20 seconds, otherwise the backend server will consider this callback as timed-out.
Declaration
Task OnTransferCompletedAsync(ICall call, TransferNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| ICall | call | The call. |
| TransferNotification | notification | The notification. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | The System.Threading.Tasks.Task. |