Bagikan melalui

Microsoft.Rtc.Collaboration.GroupChat Namespace

  • Artikel

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.

Classes

  Class Description
Public class ChatHistoryQueryOptions Parameters which specify a chat history query.
Public class ChatHistoryResult A collection of Messages for a single chat room, which match the requested ChatHistoryQueryOptions. Returned as the result of a chat history query.
Public class ChatMessage Represents a message that was posted to a chat room.
Public class ChatMessageReceivedEventArgs Event argument forwarded by a ChatRoomSession when a message is received.
Public class ChatRoom 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.
Public class ChatRoomCategory Describes a chat room category. A chat room category is a logical structure for organizing chat rooms. To obtain a reference to a ChatRoomCategory, and access other metadata about it, see CategoryManagementServices.
Public class ChatRoomCategorySettings Settings needed for creating a chat room category.
Public class ChatRoomCategorySummary Basic information about a chat room category.
Public class ChatRoomFileDownloadJob Provides metadata and controls for handling a file download operation with a chat room.
Public class ChatRoomFileTransferProgressEventArgs Event argument forwarded by a ChatRoomFileDownloadJob or ChatRoomFileUploadJob when file transfer progress has changed.
Public class ChatRoomFileUploadJob Provides metadata and controls for handling a file upload operation with a chat room.
Public class ChatRoomInvitationEventArgs Event argument forwarded by a GroupChatEndpoint when a chat room invitation is received.
Public class ChatRoomParticipant Represents a user that is actively joined to a ChatRoomSession.
Public class ChatRoomPropertiesChangedEventArgs Event argument forwarded by a ChatRoomSession when the properties of the chat room have changed.
Public class ChatRoomSession 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.
Public class ChatRoomSessionStateChangedEventArgs Event argument forwarded by a ChatRoomSession when the participation status of the currently logged in user has changed.
Public class ChatRoomSessionStateException Thrown when an operation is attempted on a ChatRoomSession, which is not supported based on its current state.
Public class ChatRoomSettings Settings needed for creating a chat room.
Public class ChatRoomSnapshot Returned from a request to browse chat rooms.
Public class ChatRoomSummary Basic information about a chat room.
Public class ChatServerConnectionException Thrown when the GroupChatEndpoint fails to connect to the Group Chat server, or when a request is made when the GroupChatEndpoint is not in a valid state.
Public class CommandFailedException Thrown when the group chat server encounters an error while processing a request.
Public class FormattedOutboundChatMessage Used to construct a chat message that contains formatted parts, such as emoticons, hyperlinks, and chat room links. Once constructed, you must invoke one or more of the Append methods before sending this message (see BeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object)).
Public class GroupChatAddIn An add-in is a web-based application which can be associated with a chat room (see AddIn).
Public class GroupChatEndpoint An endpoint which is the basis for all communication with the Group Chat server. This endpoint represents a single connection to a single group chat server, using an existing LocalEndpoint instance.
Public class GroupChatEndpointStateChangedEventArgs Event argument forwarded by a GroupChatEndpointwhen the state of the group chat server connection has changed.
Public class GroupChatException Represents the base class for all exceptions defined in the Microsoft Group Chat API.
Public class GroupChatPreferenceBundle Describes an arbitrary block of Data which a group chat application may define for storing user preferences and settings, or any other purpose.
Public class GroupChatServerConfiguration Properties and configuration settings which apply to the group chat server to which the GroupChatEndpoint has connected.
Public class GroupChatServices Provides access to a wide variety of Group Chat features and services. For a list of these features and services, see the Remarks section below.
Public class InheritedChatRoomProperty Represents a Boolean value of a property which is derived from information associated with an entity, as well as information associated with the logical parent or parents of an entity.
Public class MessagePart Base class for all supported message parts. A message part is a portion of a message which can be parsed into an object. Examples include emoticons, hyperlinks, chat room links, and file download links.
Public class MessagePartChatRoomLink A portion of a message that represents a chat room link.
Public class MessagePartEmoticon A portion of a message which represents an emoticon.
Public class MessagePartFileDownloadLink A portion of a message which represents a downloadable file. This message part cannot be used for sending messages, it is only used for parsing inbound messages.
Public class MessagePartHyperLink A portion of a message which represents a hyperlink, such as http://www.microsoft.com.
Public class MessagePartPlainText A portion of a message which represents a simple, plain-text string.
Public class MessagePartStoryTitle A portion of a message which represents a story title.
Public class ParticipantAttendanceChangedEventArgs Event argument forwarded by a ChatRoomSession when a user enters or leaves the room.
Public class ParticipantLeftEventArgs Event argument forwarded by a ChatRoomSession when another user leaves the chat room.
Public class ParticipantPrivilegeChangedEventArgs Event argument forwarded by a ChatRoomSession when the privileges of a user have changed. For more information, see IsManager and IsPresenter.

Enumerations

  Enumeration Description
Public enumeration ChatEmoticon Enumerates a chat message emoticon, which can be used as part of a chat message. For more information, see MessagePartEmoticon.
Public enumeration ChatRoomRole Enumerates a permissioned role on a ChatRoom or ChatRoomCategory. These roles may be granted to any provisioned GroupChatPrincipal.
Public enumeration ChatRoomSessionState Enumerates the state of a chat room session.
Public enumeration GroupChatEndpointState Enumerates the state of a group chat endpoint.
Public enumeration GroupChatPrincipalType Enumerates a type of user or user group.