Share via


ChatRoomSession Members

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Enables a user to join a chat room. When joined to a chat room, a user can send and receive chat messages in real time.

The ChatRoomSession type exposes the following members.

Constructors

  Name Description
Public method ChatRoomSession Initializes a new instance of the ChatRoomSession class.

Top

Properties

  Name Description
Public property AddIn Gets the current add-in which applies to this chat room.
Public property CanChat Gets or sets a value indicating whether the current user can chat. If IsAuditorium, the user must have Presenter permission to chat.
Public property CanManage Gets or sets a value indicating whether the current user can manage this chat room.
Public property ChatRoomUri Gets the URI of the chat room to which this session is joined. If the session is not joined, this property is null.
Public property Endpoint Gets the endpoint on which this session was established.
Public property IsAuditorium Gets the value indicating if the chat room is an auditorium chat room. When true, only those members who have been granted Presenter privileges may post messages. If the session is not joined, this property returns false.
Public property Name Gets the name of the chat room to which this session is joined. If the session is not joined, this property is null.
Public property ParentCategoryUri Gets the URI of the category for the chat room to which this session is joined. If the session is not joined, this property is null.
Public property Participants Gets the participant list of the chat room to which this session is joined. If the session is not joined, this property returns null.
Public property State Gets a value indicating whether this session is joined.
Public property Topic Gets the topic of the chat room to which this session is joined. If the session is not joined, this property is null.

Top

Methods

  Name Description
Public method BeginDownloadFile Downloads a file from the chat room.
Public method BeginGetHiddenParticipantList Get the current list of participants for a "Large" chat room.
Public method BeginGetRecentChatHistory Returns the requested number of recent chat messages for this chat room, up to the server limit.
Public method BeginJoin(String, AsyncCallback, Object) Join the chat room with the given name. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
Public method BeginJoin(Uri, AsyncCallback, Object) Join the chat room indicated by the given URI. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
Public method BeginJoin(ChatRoomSummary, AsyncCallback, Object) Join the chat room indicated by the given ChatRoomSession. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
Public method BeginLeave Leave the chat room. This method ends a user's current session which was initiated by a Join operation.
Public method BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) Query the history of chat on this chat room.
Public method BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object) Query the history of chat on this chat room.
Public method BeginSendChatMessage(String, AsyncCallback, Object) Send a chat message to the chat room. Users must first successfully join a chat room to initiate the session before a message can be sent.
Public method BeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object) Sends a formatted chat message to a chat room. A formatted message can be composed of hyperlinks, emoticons, and other parts.
Public method BeginSendChatMessage(String, Boolean, AsyncCallback, Object) Send a high priority message to the chat room. An alert message will be displayed within the group chat client using a different color (usually red) for emphasis. It will also, depending up on the users preferences, be announce by a bell, chime, or other sound effect. Users must first successfully join a chat room to initiate the session before a message can be sent.
Public method BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object) Send a story message to the chat room. Story messages are generally used for sending long-format chat messages. They are displayed in the group chat client as a one-line message, on which the title of the story appears as a clickable link. When selected, the entire content of the message is displayed in a dialog box. Users must first successfully join a chat room to initiate the session before a message can be sent.
Public method BeginUploadFile Uploads a file to the chat room.
Public method EndDownloadFile Completes the asynchronous request initiated by BeginDownloadFile(ChatRoomFileDownloadJob, AsyncCallback, Object).
Public method EndGetHiddenParticipantList Completes the asynchronous request initiated by BeginGetHiddenParticipantList(AsyncCallback, Object).
Public method EndGetRecentChatHistory Completes the asynchronous request initiated by BeginGetRecentChatHistory(Int32, AsyncCallback, Object).
Public method EndJoin Completes the asynchronous request initiated by BeginJoin(ChatRoomSummary, AsyncCallback, Object), BeginJoin(String, AsyncCallback, Object), or BeginJoin(Uri, AsyncCallback, Object).
Public method EndLeave Completes the asynchronous request initiated by BeginLeave(AsyncCallback, Object)
Public method EndQueryChatHistory Completes the asynchronous request initiated by BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) or BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object).
Public method EndSendChatMessage Completes the asynchronous request initiated by BeginSendChatMessage(String, AsyncCallback, Object), BeginSendChatMessage(String, Boolean, AsyncCallback, Object), or BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object).
Public method EndUploadFile Completes the asynchronous request initiated by BeginUploadFile(ChatRoomFileUploadJob, AsyncCallback, Object).
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event ChatMessageReceived Raised when a chat message is received. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ChatRoomPropertiesChanged Raised when the properties of the chat room change. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ChatRoomSessionStateChanged Raised when the joined state of this session changes. This event will fire when invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) or BeginLeave(AsyncCallback, Object) on the session. It will also be fired if the membership privileges of the currently logged in user change, or if the GroupChatEndpoint is disconnected. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ParticipantAttendanceChanged Raised when a participant joins the chat room. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ParticipantPrivilegeChanged Raised when a participant joins the chat room. Privileges monitored by this event include Manager and Presenter. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.

Top

Operators

  Name Description
Public operatorStatic member Implicit(ChatRoomSession to ChatRoomSummary) Performs an implicit conversion from ChatRoomSession to ChatRoomSummary.

Top

See Also

Reference

ChatRoomSession Class

Microsoft.Rtc.Collaboration.GroupChat Namespace