Edit

Share via


InstantMessagingFlow Class

Definition

Represents the media in and InstantMessagingCall.

public ref class InstantMessagingFlow : Microsoft::Rtc::Collaboration::ComponentModel::MediaFlow
public class InstantMessagingFlow : Microsoft.Rtc.Collaboration.ComponentModel.MediaFlow
type InstantMessagingFlow = class
    inherit MediaFlow
Public Class InstantMessagingFlow
Inherits MediaFlow
Inheritance
InstantMessagingFlow

Properties

Call

Gets the InstantMessagingCall associated with this flow. Can be null if the call type is not InstantMessagingCall.

ComposingTimeoutValue

Gets or sets the value (in seconds) for the composing timeout.

LocalComposingState

Gets or sets the local composing state.

MessageConsumptionMode

Gets the message consumption mode for this flow as configured in the flow settings.

SignalingContext

Gets the value of associated SignalingContext for the flow.

(Inherited from MediaFlow)
State

Gets the MediaFlowState for the flow.

(Inherited from MediaFlow)
SupportedRemoteMediaCapabilities

Gets the instant messaging media capabilities supported by all the remote participants.

Methods

BeginSendFailureDeliveryNotification(InstantMessageId, Int32, AsyncCallback, Object)

Begins an asynchronous operation to report that a message was not delivered to its final destination.

BeginSendInstantMessage(ContentType, Byte[], AsyncCallback, Object)

Send an instant message in the conversation.

BeginSendInstantMessage(String, AsyncCallback, Object)

Send a text message in the conversation.

BeginSendSuccessDeliveryNotification(InstantMessageId, AsyncCallback, Object)

Begins an asynchronous operation to report that a message was successfully delivered to its final destination.

EndSendFailureDeliveryNotification(IAsyncResult)

Gets the results of sending a delivery notification.

EndSendInstantMessage(IAsyncResult)

Gets the results of the SendInstantMessage operation.

EndSendSuccessDeliveryNotification(IAsyncResult)

Gets the results of sending a delivery notification.

Initialize(InstantMessagingFlowTemplate)

Optionally overwrites settings of the flow.

MakeCallback(AsyncCallback, IAsyncResult)

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

(Inherited from MediaFlow)
RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg)

Raises a generic event with a specific event argument type.

(Inherited from MediaFlow)
TryUpdateFlowState(MediaFlowState, MediaFlowState)

Updates the MediaFlow's state.

(Inherited from MediaFlow)

Events

DeliveryNotificationReceived

Raised when a message delivery notification is received.

MessageReceived

Raised when a message is received.

PropertiesChanged

Raised when instant messaging flow properties changes.

RemoteComposingStateChanged

Raised when the composing state for a remote participant changes.

StateChanged

Raised when the state of MediaFlow has changed.

(Inherited from MediaFlow)

Extension Methods

BeginSendFailureDeliveryNotification(InstantMessagingFlow, InstantMessageId, Int32, SendFailureDeliveryNotificationOptions, AsyncCallback, Object)
BeginSendInstantMessage(InstantMessagingFlow, ContentType, Byte[], SendInstantMessageOptions, AsyncCallback, Object)
BeginSendSuccessDeliveryNotification(InstantMessagingFlow, InstantMessageId, SendSuccessDeliveryNotificationOptions, AsyncCallback, Object)

Applies to