Describes a chat room. A chat room is a topic oriented, access controlled forum for posting real-time messages to be shared with a group of users. Chat rooms optionally support logging of chat history, which is available to members for review or query. To obtain a reference to a ChatRoom , and access other metadata about the chat room, see ChatRoomManagementServices .
Inheritance Hierarchy
Namespace: Microsoft.Rtc.Collaboration.GroupChatAssembly: Microsoft.Rtc.Collaboration.GroupChat(in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Class ChatRoom |
Visual Basic (Usage) |
---|
Dim instance As ChatRoom |
C# |
---|
public class ChatRoom |
Remarks
This class describes the configuration and topic of a chat room. To send and receive messages in a chat room, you must be a member, and join the chat room using BeginJoin(ChatRoomSummary, AsyncCallback, Object) . To facilitate this process, ChatRoom supports an implicit conversion to ChatRoomSummary . (See Implicit Widening Implicit Implicit Implicit (ChatRoom to ChatRoomSummary) .)
Chat rooms belong to a ChatRoomCategory , which provide logical grouping of chat rooms, as well as a default set of properties which a chat room may inherit. The category is identified by the ParentCategoryUri .
Each chat room describes its purpose with metadata such as Name , Topic , and Description . In addition, the chat room has properties which can be set to control its behavior. Permission to join or manage a chat room is controlled by an access control list. Users must be in scope on the ChatRoomCategory in order to be added as a member. To find users who are eligible to be granted a specific role on a chat room, see BeginFindUsersOrGroupsForRole(ChatRoomRole, Uri, String, AsyncCallback, Object) .