Share via


InstantMessageModality Members

Include Protected Members
Include Inherited Members

Defines the instant messaging modality. It supports actions such as sending an instant message, checking or setting the composing (typing) flag, etc. This class exposes events such as messages being sent or received.

The InstantMessageModality type exposes the following members.

Properties

  Name Description
Public property Capabilities Gets the instant messaging capabilities.
Public property Conversation Gets the associated conversation object. (inherited from Modality)
Public property Endpoint Sets or gets the contact endpoint that is used by the modality. (inherited from Modality)
Public property IsTyping Returns true if the participant associated with this InstantMessageModality instance is typing.
Public property Participant Gets the associated participant object. (inherited from Modality)
Public property Properties Gets a dictionary of modality properties. (inherited from Modality)
Public property State Gets the modality state. (inherited from Modality)

Top

Methods

  Name Description
Public method Accept Accepts an invitation to a modality. (inherited from Modality)
Public method BeginConnect Activates a conversation modality by connecting the modality to its associated local and remote endpoints. (inherited from Modality)
Public method BeginConsultativeTransfer Transfers a connected modality to an existing conversation. (inherited from Modality)
Public method BeginDisconnect Disconnects from the modality. (inherited from Modality)
Public method BeginForward(Contact, AsyncCallback, Object) Forwards an active conversation to a specified contact. (inherited from Modality)
Public method BeginForward(ContactEndpoint, AsyncCallback, Object) Forwards an active conversation to a specified remote contact endpoint. You cannot forward conversations between the local contacts endpoints. (inherited from Modality)
Public method BeginHold Places the modality on hold. (inherited from Modality)
Public method BeginRetrieve Retrives a held modality. (inherited from Modality)
Public method BeginSendMessage(String, AsyncCallback, Object) Sends a plain text message to a remote conversation participant.
Public method BeginSendMessage(IDictionary<InstantMessageContentType, String>, AsyncCallback, Object) Sends a text message formatted for specified content type to a remote conversation participant.
Public method BeginSetComposing Sets the local composing state. The composing flag indicates that the local participant is typing a message.
Public method BeginSetProperty Sets a property associated with this modality. (inherited from Modality)
Public method BeginTransfer(Contact, TransferOptions, AsyncCallback, Object) Transfers an active conversation to a specified remote contact. (inherited from Modality)
Public method BeginTransfer(ContactEndpoint, TransferOptions, AsyncCallback, Object) Transfer an active conversation to a specified remote contact endpoint. You cannot transfer a conversation to another local contact endpoint. (inherited from Modality)
Public method CanInvoke Returns true if a specific action is available. (inherited from Modality)
Public method CanSetProperty Returns true if a property can be set on the modality. (inherited from Modality)
Public method CreateObjRef (inherited from MarshalByRefObject)
Public method EndConnect Blocks calling thread until BeginConnect completes. (inherited from Modality)
Public method EndConsultativeTransfer Blocks calling thread until BeginConsultativeTransfer completes. (inherited from Modality)
Public method EndDisconnect Blocks calling thread until BeginDisconnect completes. (inherited from Modality)
Public method EndForward Blocks the calling thread until BeginForward completes. (inherited from Modality)
Public method EndHold Blocks calling thread until BeginHold completes. (inherited from Modality)
Public method EndRetrieve Blocks calling thread until BeginRetrieve completes. (inherited from Modality)
Public method EndSendMessage Ends send message operation and un-blocks program execution on calling thread.
Public method EndSetComposing Ends the set composing operation.
Public method EndSetProperty Blocks the calling thread until BeginSetProperty completes. (inherited from Modality)
Public method EndTransfer Blocks current thread until BeginTransfer completes and returns a list of context properties. (inherited from Modality)
Public method Equals (inherited from Object)
Protected method Finalize (Overrides Modality.Finalize().)
Public method GetHashCode (inherited from Object)
Public method GetLifetimeService (inherited from MarshalByRefObject)
Public method GetType (inherited from Object)
Public method InitializeLifetimeService (inherited from MarshalByRefObject)
Protected method MemberwiseClone() (inherited from Object)
Protected method MemberwiseClone(Boolean) (inherited from MarshalByRefObject)
Public method Reject Rejects an invitation to share a modality. (inherited from Modality)
Public method SetCapabilities Sets the instant messaging capabilities that the client supports.
Public method ToString (inherited from Object)

Top

Events

  Name Description
Public event ActionAvailabilityChanged Occurs when an action availability changes. (inherited from Modality)
Public event InstantMessagePropertyChanged Occurs when a property of the instant message modality changes.
Public event InstantMessageReceived Occurs when an instant message is received, or sent if the InstantMessageModality belongs to the local participant.
Public event IsTypingChanged Raised when the istyping state changes.
Public event ModalityStateChanged Occurs when modality state changes. (inherited from Modality)

Top

See Also

Reference

InstantMessageModality Class

Microsoft.Lync.Model.Conversation Namespace