Conversation Class

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Represents a multi-party, multi-modal call contexts between a local participant and one or more remote participants.

public ref class Conversation

public class Conversation

type Conversation = class

Public Class Conversation

Inheritance

Object

Conversation

Remarks

A conversation involving more than two participants uses a conference. Typically, a conversation can either start as a conference or start as a two party conversation and then get escalated to a conference when a new participant needs to be added or a modality requiring a multi-point controller unit (MCU) needs to be added.

Constructors

Conversation(LocalEndpoint, ConversationSettings)	Creates a new instance of the Conversation class, with given settings.
Conversation(LocalEndpoint)	Creates a new instance of the Conversation class.

Properties

ActiveMediaTypes	Obsolete. Gets the list of active media types for this conversation.
ApplicationContext	Gets or sets the application-specific context for this conversation.
Calls	Gets the list of established calls in this conversation.
ConferenceSession	Gets the conference session for this conversation.
Endpoint	Gets the endpoint associated with this conversation.
Id	Gets the conversation identifier.
LocalParticipant	Gets the local participant of this conversation.
Priority	Gets the priority of the conversation.
RemoteParticipants	Gets the collection of remote participants.
State	Gets the current state of the conversation.
Subject	Gets the subject of the conversation.

Methods

BeginEscalateToConference(AsyncCallback, Object)	Begins an asynchronous operation to escalate the conversation to a conference.
BeginInviteRemoteParticipants(IEnumerable<String>, IEnumerable<String>, ToastMessage, AsyncCallback, Object)	Obsolete. This method will be removed from future versions. For more information, see ConferenceInvitation.BeginDeliver(). Begins an asynchronous operation to invite remote participants to the conversation’s conference.
BeginInviteRemoteParticipants(IEnumerable<String>, ToastMessage, AsyncCallback, Object)	Obsolete. This method will be removed from future versions. Instead, use ConferenceInvitation.BeginDeliver(). Begins an asynchronous operation to invite remote participants to the conversation’s conference.
BeginTerminate(AsyncCallback, Object)	Begins an asynchronous operation to terminate the conversation.
BeginTerminate(ConversationTerminateOptions, AsyncCallback, Object)	Begins an asynchronous operation to terminate the conversation.
BeginUpdateProperties(ConversationProperties, AsyncCallback, Object)	Begins an asynchronous operation to update the properties of the conversation.
EndEscalateToConference(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndInviteRemoteParticipants(IAsyncResult)	Obsolete. This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndTerminate(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndUpdateProperties(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
GetActiveMediaTypes()	Returns a snapshot of active mediatypes of all remote participants and the local participant.
GetConversationContextChannels()	Returns a snapshot of context channels tied to the conversation.
GetLobbyParticipants()	Gets the collection of lobby participants.
GetRemoteParticipantsCount()	Gets the current number of remote participants participating in this conversation.
GetTraceCorrelationID()	Gets the trace correlation id for this instance.
Impersonate(String, String, String)	Impersonate as a different user.

Events

EscalateToConferenceRequested	Raised when the existing remote participant requests to escalate the conversation into conference.
InviteRemoteParticipantUpdate	Obsolete. Raised when the remote participant sends a response to the conference invitation.
LobbyParticipantAttendanceChanged	Raised when one or more participants join or leave the conference lobby.
ParticipantPropertiesChanged	Raised when one or more properties of the participant change(s).
PropertiesChanged	Raised when one or more properties are changed in the conversation.
RemoteParticipantAttendanceChanged	Raised when one or more remote participants join or leave the conversation.
StateChanged	Raised when the state of the conversation changes.

Extension Methods

BeginRestore(Conversation, ConversationRestoreOptions, AsyncCallback, Object)

BindReplicationHandler(Conversation, ConversationReplicationHandler)

EnablePeerToPeerRecording(Conversation)

EndRestore(Conversation, IAsyncResult)

GetDerivedConversationId(Conversation)