InstantMessagingCall InstantMessagingCall InstantMessagingCall InstantMessagingCall Class

Definition

InstantMessagingCall is the class that supports instant messaging-based communication.

public ref class InstantMessagingCall : Microsoft::Rtc::Collaboration::Call
public class InstantMessagingCall : Microsoft.Rtc.Collaboration.Call
type InstantMessagingCall = class
    inherit Call
Public Class InstantMessagingCall
Inherits Call
Inheritance
InstantMessagingCallInstantMessagingCallInstantMessagingCallInstantMessagingCall

Remarks


Instant messaging communication is realtime, text-based communication. InstantMessagingCall is an implementation of the abstract Call class. It implements signaling for instant messaging calls. Actual text messages are exchanged on an instance of InstantMessagingFlow, which is created at the time when the call is established.

Constructors

InstantMessagingCall(Conversation) InstantMessagingCall(Conversation) InstantMessagingCall(Conversation) InstantMessagingCall(Conversation)

Creates a new instance of the InstantMessagingCall class.

Properties

ActiveMediaTypes ActiveMediaTypes ActiveMediaTypes ActiveMediaTypes

Gets the list of active media types for the call.

(Inherited from Call)
ApplicationContext ApplicationContext ApplicationContext ApplicationContext

Gets or sets an application-defined context.

(Inherited from Call)
CallId CallId CallId CallId

Gets the CallId of the primary SIP session used by the call.

(Inherited from Call)
CanBeDeflected CanBeDeflected CanBeDeflected CanBeDeflected

Gets whether this call can be deflected to a destination URI other than given destination URI.

(Inherited from Call)
CanHandleTransferReceived CanHandleTransferReceived CanHandleTransferReceived CanHandleTransferReceived

Gets whether the application supports handling of incoming transfer requests.

(Inherited from Call)
Conversation Conversation Conversation Conversation

Gets the conversation that contains this call.

(Inherited from Call)
DefaultMediaType DefaultMediaType DefaultMediaType DefaultMediaType

Gets the default media type for this call.

Flow Flow Flow Flow

Gets an InstantMessagingFlow for this call.

IsEarlyMediaSupported IsEarlyMediaSupported IsEarlyMediaSupported IsEarlyMediaSupported

Gets whether the call supports the reliable provisional response for early media.

(Inherited from Call)
IsImmediateAutoAcceptNeeded IsImmediateAutoAcceptNeeded IsImmediateAutoAcceptNeeded IsImmediateAutoAcceptNeeded

Gets whether the call should be automatically accepted. immediately upon receipt.

IsReplacesSupported IsReplacesSupported IsReplacesSupported IsReplacesSupported

Gets whether the local endpoint supports the call replacement feature.

(Inherited from Call)
IsThirdPartyCallControl IsThirdPartyCallControl IsThirdPartyCallControl IsThirdPartyCallControl

Gets whether the call is used in a third-party call control scenario.

(Inherited from Call)
IsUsingGeneratedIdentity IsUsingGeneratedIdentity IsUsingGeneratedIdentity IsUsingGeneratedIdentity

Gets whether the call should use a generated identity during call establishment to a trusted conference.

(Inherited from Call)
LocalTag LocalTag LocalTag LocalTag

Gets the local tag of the primary session.

(Inherited from Call)
OriginalDestinationUri OriginalDestinationUri OriginalDestinationUri OriginalDestinationUri

Gets the original destination URI of the call.

(Inherited from Call)
RemoteEndpoint RemoteEndpoint RemoteEndpoint RemoteEndpoint

Gets the remote endpoint of the call.

(Inherited from Call)
RemoteEndpointProperties RemoteEndpointProperties RemoteEndpointProperties RemoteEndpointProperties

Gets the call-specific properties of the remote participant endpoint of this call.

(Inherited from Call)
RemoteTag RemoteTag RemoteTag RemoteTag

Gets the remote tag of the primary session.

(Inherited from Call)
RouteSetStatus RouteSetStatus RouteSetStatus RouteSetStatus

Gets the status of the dialog's route set.

(Inherited from Call)
State State State State

Gets the current state of the call.

(Inherited from Call)
SupportedMediaTypes SupportedMediaTypes SupportedMediaTypes SupportedMediaTypes

Gets the list of supported Media names, which are acceptable m-lines in SDP offer/answer.

Methods

BeginAccept(AsyncCallback, Object) BeginAccept(AsyncCallback, Object) BeginAccept(AsyncCallback, Object) BeginAccept(AsyncCallback, Object)

Accepts an incoming call.

(Inherited from Call)
BeginAccept(CallAcceptOptions, AsyncCallback, Object) BeginAccept(CallAcceptOptions, AsyncCallback, Object) BeginAccept(CallAcceptOptions, AsyncCallback, Object) BeginAccept(CallAcceptOptions, AsyncCallback, Object)

Accepts an incoming call with given options.

(Inherited from Call)
BeginEstablish(AsyncCallback, Object) BeginEstablish(AsyncCallback, Object) BeginEstablish(AsyncCallback, Object) BeginEstablish(AsyncCallback, Object)

Establishes an outgoing call.

(Inherited from Call)
BeginEstablish(CallEstablishOptions, AsyncCallback, Object) BeginEstablish(CallEstablishOptions, AsyncCallback, Object) BeginEstablish(CallEstablishOptions, AsyncCallback, Object) BeginEstablish(CallEstablishOptions, AsyncCallback, Object)

Establishes an outgoing call with given options.

(Inherited from Call)
BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object)

Establishes an outgoing call.

(Inherited from Call)
BeginEstablish(String, ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(String, ToastMessage, CallEstablishOptions, AsyncCallback, Object)

Begins the operation of establishing the instant messaging call with the remote participant.

BeginEstablish(ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(ToastMessage, CallEstablishOptions, AsyncCallback, Object) BeginEstablish(ToastMessage, CallEstablishOptions, AsyncCallback, Object)

Begins the operation of establishing the instant messaging call on existing Conversation.

BeginHandleTermination(AsyncCallback, Object) BeginHandleTermination(AsyncCallback, Object) BeginHandleTermination(AsyncCallback, Object) BeginHandleTermination(AsyncCallback, Object)

Handles termination in a class derived from the call class.

(Inherited from Call)
BeginSendInfo(ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendInfo(ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendInfo(ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendInfo(ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object)

Sends an INFO message to the remote participant of this call.

(Inherited from Call)
BeginSendMessage(MessageType, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendMessage(MessageType, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendMessage(MessageType, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginSendMessage(MessageType, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object)

Send a message to the remote participant specified.

(Inherited from Call)
BeginSendReliableProvisionalResponse(Int32, Boolean, CallProvisionalResponseOptions, AsyncCallback, Object) BeginSendReliableProvisionalResponse(Int32, Boolean, CallProvisionalResponseOptions, AsyncCallback, Object) BeginSendReliableProvisionalResponse(Int32, Boolean, CallProvisionalResponseOptions, AsyncCallback, Object) BeginSendReliableProvisionalResponse(Int32, Boolean, CallProvisionalResponseOptions, AsyncCallback, Object)

This method can be used to send a reliable provisional response with option to send answer for early media. If the inviter supports 100rel and the local policy is not unsupported, this method will wait for the PRACK. Otherwise, this method will not require 100rel. Any application that supports 100rel is recommended to use this method for sending provisional response. SendProvisional method can be used only when the application knows for sure that the remote does not require 100rel.

(Inherited from Call)
BeginTerminate(AsyncCallback, Object) BeginTerminate(AsyncCallback, Object) BeginTerminate(AsyncCallback, Object) BeginTerminate(AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

(Inherited from Call)
BeginTerminate(CallTerminateOptions, AsyncCallback, Object) BeginTerminate(CallTerminateOptions, AsyncCallback, Object) BeginTerminate(CallTerminateOptions, AsyncCallback, Object) BeginTerminate(CallTerminateOptions, AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

(Inherited from Call)
BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object) BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

(Inherited from Call)
BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object) BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object) BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object) BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object)

Initiates a transfer request to the remote participant of the current call to replace another existing call in Attended type.

(Inherited from Call)
BeginTransfer(String, CallTransferOptions, AsyncCallback, Object) BeginTransfer(String, CallTransferOptions, AsyncCallback, Object) BeginTransfer(String, CallTransferOptions, AsyncCallback, Object) BeginTransfer(String, CallTransferOptions, AsyncCallback, Object)

Initiates a transfer request to the remote participant to transfer the current call to the given transfer target in Attended or Unattended type.

(Inherited from Call)
BindMediaProvider(MediaProvider) BindMediaProvider(MediaProvider) BindMediaProvider(MediaProvider) BindMediaProvider(MediaProvider)

Binds a user-specified media provider to the call.

(Inherited from Call)
Decline() Decline() Decline() Decline()

Declines an incoming call with a 603 response code (DeclineEverywhere).

(Inherited from Call)
Decline(CallDeclineOptions) Decline(CallDeclineOptions) Decline(CallDeclineOptions) Decline(CallDeclineOptions)

Declines an incoming call with options.

(Inherited from Call)
EndAccept(IAsyncResult) EndAccept(IAsyncResult) EndAccept(IAsyncResult) EndAccept(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed

(Inherited from Call)
EndEstablish(IAsyncResult) EndEstablish(IAsyncResult) EndEstablish(IAsyncResult) EndEstablish(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

(Inherited from Call)
EndHandleTermination(IAsyncResult) EndHandleTermination(IAsyncResult) EndHandleTermination(IAsyncResult) EndHandleTermination(IAsyncResult)

This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

(Inherited from Call)
EndSendInfo(IAsyncResult) EndSendInfo(IAsyncResult) EndSendInfo(IAsyncResult) EndSendInfo(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

(Inherited from Call)
EndSendMessage(IAsyncResult) EndSendMessage(IAsyncResult) EndSendMessage(IAsyncResult) EndSendMessage(IAsyncResult)

This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed

(Inherited from Call)
EndSendReliableProvisionalResponse(IAsyncResult) EndSendReliableProvisionalResponse(IAsyncResult) EndSendReliableProvisionalResponse(IAsyncResult) EndSendReliableProvisionalResponse(IAsyncResult)

This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed

(Inherited from Call)
EndTerminate(IAsyncResult) EndTerminate(IAsyncResult) EndTerminate(IAsyncResult) EndTerminate(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

(Inherited from Call)
EndTransfer(IAsyncResult) EndTransfer(IAsyncResult) EndTransfer(IAsyncResult) EndTransfer(IAsyncResult)

This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed

(Inherited from Call)
Forward(String) Forward(String) Forward(String) Forward(String)

Forwards the call to the specified target URI with a response code of 303.

(Inherited from Call)
Forward(String, CallForwardOptions) Forward(String, CallForwardOptions) Forward(String, CallForwardOptions) Forward(String, CallForwardOptions)

Forwards the call to a different target URI with given options.

(Inherited from Call)
GetActiveMediaTypes() GetActiveMediaTypes() GetActiveMediaTypes() GetActiveMediaTypes()

Gets the active media types for the call.

(Inherited from Call)
GetMediaForDialReplaces() GetMediaForDialReplaces() GetMediaForDialReplaces() GetMediaForDialReplaces()

Gets the enumeration of media types that MCU should offer when dialing or replacing this call.

(Inherited from Call)
GetNewEarlyDialog() GetNewEarlyDialog() GetNewEarlyDialog() GetNewEarlyDialog()

Returns the dialog context for the new early dialog.

(Inherited from Call)
GetTraceCorrelationID() GetTraceCorrelationID() GetTraceCorrelationID() GetTraceCorrelationID()

Gets the trace correlation id for this instance.

(Inherited from Call)
HandleCallMessageReceived(CallMessageReceivedEventArgs) HandleCallMessageReceived(CallMessageReceivedEventArgs) HandleCallMessageReceived(CallMessageReceivedEventArgs) HandleCallMessageReceived(CallMessageReceivedEventArgs)

Handles a message received event in a class derived from the call class.

(Inherited from Call)
HandleFlowConfigurationRequested(MediaFlow) HandleFlowConfigurationRequested(MediaFlow) HandleFlowConfigurationRequested(MediaFlow) HandleFlowConfigurationRequested(MediaFlow)

Handles the FlowConfigurationRequested event raising.

HandleForwardReceived(CallForwardReceivedEventArgs) HandleForwardReceived(CallForwardReceivedEventArgs) HandleForwardReceived(CallForwardReceivedEventArgs) HandleForwardReceived(CallForwardReceivedEventArgs)

Handles the forward response.

HandleMessageReceived(MessageReceivedEventArgs) HandleMessageReceived(MessageReceivedEventArgs) HandleMessageReceived(MessageReceivedEventArgs) HandleMessageReceived(MessageReceivedEventArgs)

Handles a message received event in a class derived from the call class.

(Inherited from Call)
HandleStateChange(CallStateChangedEventArgs) HandleStateChange(CallStateChangedEventArgs) HandleStateChange(CallStateChangedEventArgs) HandleStateChange(CallStateChangedEventArgs)

Indicates a state change to the derived call.

HandleTransferNotificationReceived(TransferStateChangedEventArgs) HandleTransferNotificationReceived(TransferStateChangedEventArgs) HandleTransferNotificationReceived(TransferStateChangedEventArgs) HandleTransferNotificationReceived(TransferStateChangedEventArgs)

Handles the received notifications.

HandleTransferReceived(CallTransferReceivedEventArgs) HandleTransferReceived(CallTransferReceivedEventArgs) HandleTransferReceived(CallTransferReceivedEventArgs) HandleTransferReceived(CallTransferReceivedEventArgs)

Handles the transfer received event.

IsSupportedMediaType(String) IsSupportedMediaType(String) IsSupportedMediaType(String) IsSupportedMediaType(String)

Determines whether the given media type is present in the list of supported media types.

(Inherited from Call)
MakeCallback(AsyncCallback, IAsyncResult) MakeCallback(AsyncCallback, IAsyncResult) MakeCallback(AsyncCallback, IAsyncResult) MakeCallback(AsyncCallback, IAsyncResult)

Invokes a specified call using the application's queue for the events.

(Inherited from Call)
ProcessIncomingInviteHeaders(IEnumerable<SignalingHeader>) ProcessIncomingInviteHeaders(IEnumerable<SignalingHeader>) ProcessIncomingInviteHeaders(IEnumerable<SignalingHeader>) ProcessIncomingInviteHeaders(IEnumerable<SignalingHeader>)

Checks the interesting headers for the call and initializes the needed call properties.

RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg) RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg) RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg) RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg)

Raises a generic event with a specific event argument type to the application

(Inherited from Call)
SendProvisionalResponse(Int32, CallProvisionalResponseOptions) SendProvisionalResponse(Int32, CallProvisionalResponseOptions) SendProvisionalResponse(Int32, CallProvisionalResponseOptions) SendProvisionalResponse(Int32, CallProvisionalResponseOptions)

Sends a provisional response synchronously.

(Inherited from Call)
UnbindMediaProvider() UnbindMediaProvider() UnbindMediaProvider() UnbindMediaProvider()

Removes the currently bound media provider. BindMediaProvider(MediaProvider)

(Inherited from Call)

Events

AutoAcceptNeeded AutoAcceptNeeded AutoAcceptNeeded AutoAcceptNeeded

Raised when the call needs to be automatically accepted by the application.

ConversationChanged ConversationChanged ConversationChanged ConversationChanged

Raised when this call is moved to a derived conversation.

(Inherited from Call)
InfoReceived InfoReceived InfoReceived InfoReceived

Raised when an INFO message is received on this call.

(Inherited from Call)
InstantMessagingFlowConfigurationRequested InstantMessagingFlowConfigurationRequested InstantMessagingFlowConfigurationRequested InstantMessagingFlowConfigurationRequested

Raised when InstantMessagingFlow is created. Applications can use this event handler to register for flow related event handlers and optionally set flow configuration.

ProvisionalResponseReceived ProvisionalResponseReceived ProvisionalResponseReceived ProvisionalResponseReceived

Raised when a provisional response is received for an outgoing INVITE.

(Inherited from Call)
RemoteParticipantChanged RemoteParticipantChanged RemoteParticipantChanged RemoteParticipantChanged

Raised when the remote participant that accepted this call cannot be verified as matching the original participant invited.

(Inherited from Call)
RouteSetStatusChanged RouteSetStatusChanged RouteSetStatusChanged RouteSetStatusChanged

Raised when the state of the route set of the call changes.

(Inherited from Call)
StateChanged StateChanged StateChanged StateChanged

Raised when the state of the call changes.

(Inherited from Call)

Extension Methods

GetRemoteParticipant(Call) GetRemoteParticipant(Call) GetRemoteParticipant(Call) GetRemoteParticipant(Call)
CreateSessionErrorReport(Call, DiagnosticsInformation) CreateSessionErrorReport(Call, DiagnosticsInformation) CreateSessionErrorReport(Call, DiagnosticsInformation) CreateSessionErrorReport(Call, DiagnosticsInformation)
GeneratePrimarySessionCallId(Call) GeneratePrimarySessionCallId(Call) GeneratePrimarySessionCallId(Call) GeneratePrimarySessionCallId(Call)
GetConferenceQoeServerAddress(Call) GetConferenceQoeServerAddress(Call) GetConferenceQoeServerAddress(Call) GetConferenceQoeServerAddress(Call)
GetIfCallFromVerifiedSource(Call) GetIfCallFromVerifiedSource(Call) GetIfCallFromVerifiedSource(Call) GetIfCallFromVerifiedSource(Call)
GetMcuReplacesInformation(Call) GetMcuReplacesInformation(Call) GetMcuReplacesInformation(Call) GetMcuReplacesInformation(Call)
Redeliver(Call) Redeliver(Call) Redeliver(Call) Redeliver(Call)
SetMissedCallStatus(Call, Boolean) SetMissedCallStatus(Call, Boolean) SetMissedCallStatus(Call, Boolean) SetMissedCallStatus(Call, Boolean)

Applies to