This documentation is archived and is not being maintained.

ChatRoom Class

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.

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.


Namespace:  Microsoft.Rtc.Collaboration.GroupChat
Assembly:  Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)

public class ChatRoom

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(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).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.