InstantMessagingMcuSession Class

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration

Assembly:: Microsoft.Rtc.Collaboration.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Allows requests to be made to the Instant Messaging MCU.

public ref class InstantMessagingMcuSession : Microsoft::Rtc::Collaboration::McuSession

public class InstantMessagingMcuSession : Microsoft.Rtc.Collaboration.McuSession

type InstantMessagingMcuSession = class
    inherit McuSession

Public Class InstantMessagingMcuSession
Inherits McuSession

Inheritance: Object

McuSession
InstantMessagingMcuSession

Remarks

This class represents the Instant Messaging specific implementation of the media-agnostic McuSession. The class encapsulates operations and events relevant to the Instant Messaging MCU.

Properties

ConferenceSession	Gets the parent ConferenceSession object. (Inherited from McuSession)
InstantMessagingBlockAllMode	Gets whether messages can be sent in the conversation. InstantMessagingBlockAllMode
McuInformation	Gets information about the MCU including the MCU address or null if the MCU session is not bound to a conference (The parent ConferenceSession has not joined a conference yet, or the joined conference does not support the corresponding MCU type). (Inherited from McuSession)
State	Gets the state of the MCU as communicated by the focus. (Inherited from McuSession)
SupportedMediaTypes	Gets the media types supported by the Instant Messaging MCU.

Methods

BeginDialOut(String, AsyncCallback, Object)	Requests from the Instant Messaging MCU to initiate an Instant Messaging call to the supplied destination URI.
BeginDialOut(String, McuDialOutOptions, AsyncCallback, Object)	Sends a request to MCU to initiate a call to the supplied destination URI. (Inherited from McuSession)
BeginEject(ConversationParticipant, AsyncCallback, Object)	Ejects a participant from the MCU. (Inherited from McuSession)
BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object)	Ejects a participant from the MCU. (Inherited from McuSession)
BeginEject(String, AsyncCallback, Object)	Ejects a participant or an endpoint from the MCU based on the supplied URI. (Inherited from McuSession)
BeginEject(String, EjectOptions, AsyncCallback, Object)	Ejects a participant or an endpoint from the MCU based on the supplied URI. (Inherited from McuSession)
BeginModifyInstantMessagingBlockAllMode(InstantMessagingBlockAllMode, AsyncCallback, Object)	Modifies the instant messaging block filter on InstantMessagingMcuSession.
BeginSendCommand(ConferenceCommand, AsyncCallback, Object)	Send a request to the MCU via the focus. (Inherited from McuSession)
BeginSendCommand(ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)	Send a request to the MCU via the focus. (Inherited from McuSession)
BeginTransfer(Call, McuTransferOptions, AsyncCallback, Object)	Transfers an established two party call to the MCU. (Inherited from McuSession)
EndDialOut(IAsyncResult)	Waits for the pending operation to complete.
EndEject(IAsyncResult)	Waits for the pending eject operation to complete. (Inherited from McuSession)
EndModifyInstantMessagingBlockAllMode(IAsyncResult)	Waits for the pending operation to complete.
EndSendCommand(IAsyncResult)	Waits for the pending send command to complete. (Inherited from McuSession)
EndTransfer(IAsyncResult)	Waits for the pending operation to complete. (Inherited from McuSession)
GetLocalParticipantEndpoints()	Gets a snapshot collection of the endpoints used by the local participant to communicate with the MCU. (Inherited from McuSession)
GetRemoteParticipantEndpoints()	Gets a snapshot collection of the endpoints used by remote participants to communicate with the MCU. (Inherited from McuSession)
HandleParticipantEndpointAttendanceChanged(Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>)	Processes added or removed participant endpoints to the MCU.
HandleParticipantEndpointPropertiesChanged(ParticipantEndpoint, PropertyMergeInformation<McuParticipantEndpointProperties>)	Process updated MCU participant endpoint properties.
HandlePropertiesChanged(PropertyMergeInformation<McuSessionProperties>)	Process updated session properties.
RaiseAttendanceChanged<TProperties>(Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, EventHandler<ParticipantEndpointAttendanceChangedEventArgs<TProperties>>)	Raises a attendance changed event on behalf of the derived class. (Inherited from McuSession)
RaiseSessionParticipantPropertyChanged<TProperties>(ParticipantEndpoint, PropertyMergeInformation<McuParticipantEndpointProperties>, EventHandler<ParticipantEndpointPropertiesChangedEventArgs<TProperties>>)	Raises a property changed event for the McuSessionParticipant. (Inherited from McuSession)
RaiseSessionPropertyChanged<TProperties>(PropertyMergeInformation<McuSessionProperties>, EventHandler<PropertiesChangedEventArgs<TProperties>>)	Raises a property changed event on behalf of the derived class. (Inherited from McuSession)
ResetCore()	Recycles the InstantMessagingMcuSession for reuse.
ToString()	Returns a String that represents the current McuSession. (Inherited from McuSession)
TryGetParticipantEndpointProperties(ParticipantEndpoint, InstantMessagingMcuParticipantEndpointProperties)	Gets the properties of the supplied participant endpoint in this MCU.
TryGetParticipantEndpointProperties(ParticipantEndpoint, McuParticipantEndpointProperties)	Gets the basic properties for a participant endpoint in the MCU. (Inherited from McuSession)

Events

ParticipantEndpointAttendanceChanged	Raised when one or more participant endpoints join or leave the MCU.
ParticipantEndpointPropertiesChanged	Raised when one or more participant endpoint properties changes.
PropertiesChanged	Raised when one or more session properties change.
StateChanged	Raised when the MCU state changes are reported back to the application. (Inherited from McuSession)

Extension Methods

BeginSendCommand(McuSession, ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)
EndSendCommand(McuSession, IAsyncResult)

Applies to