Microsoft.Rtc.Collaboration.PersistentChat Namespace

Classes

ChatHistoryQueryOptions

Parameters which specify a chat history query.

ChatHistoryResult

A collection of Messages for a single chat room, which match the requested ChatHistoryQueryOptions. Returned as the result of a chat history query.

ChatMessage

Represents a message that was posted to a chat room.

ChatMessageReceivedEventArgs

Event argument forwarded by a ChatRoomSession when a message is received.

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.

ChatRoomCategorySummary

Basic information about a chat room category.

ChatRoomFileDownloadJob

Provides metadata and controls for handling a file download operation with a chat room.

ChatRoomFileTransferProgressEventArgs

Event argument forwarded by a ChatRoomFileDownloadJob or ChatRoomFileUploadJob when file transfer progress has changed.

ChatRoomFileUploadJob

Provides metadata and controls for handling a file upload operation with a chat room.

ChatRoomInvitation

Basic information about a chat room invitation.

ChatRoomInvitationEventArgs

Event argument forwarded by a PersistentChatEndpoint when a chat room invitation is received.

ChatRoomParticipant

Represents a user that is actively joined to a ChatRoomSession.

ChatRoomPropertiesChangedEventArgs

Event argument forwarded by a ChatRoomSession when the properties of the chat room have changed.

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.

ChatRoomSessionStateChangedEventArgs

Event argument forwarded by a ChatRoomSession when the participation status of the currently logged in user has changed.

ChatRoomSessionStateException

Thrown when an operation is attempted on a ChatRoomSession which is not supported based on its current state.

ChatRoomSettings

Settings needed for creating a chat room.

ChatRoomSnapshot

Returned from a request to browse chat rooms.

ChatRoomSummary

Basic information about a chat room.

ChatServerConnectionException

The PersistentChatEndpoint fails to connect to the Persistent Chat server, or when an request is made when the PersistentChatEndpoint is not in a valid state.

CommandFailedException

The persistent chat server encounters an error while processing a request.

FormattedOutboundChatMessage

Used to construct a chat message which 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)).

InheritedChatRoomInviteProperty

Represents the room invitations property which is derived from information associated with a chatroom, as well as information associated with the parent category.

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.

MessagePartChatRoomLink

A portion of a message which represents a chat room link.

MessagePartEmoticon

A portion of a message which represents an emoticon

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.

MessagePartHyperLink

A portion of a message which represents a hyper link, such as //www.microsoft.com.

MessagePartPlainText

A portion of a message which represents a simple, plain-text string.

MessagePartStoryTitle

A portion of a message which represents a story title.

ParticipantAttendanceChangedEventArgs

Event argument forwarded by a ChatRoomSession when a user enters or leaves the room.

ParticipantLeftEventArgs

Event argument forwarded by a ChatRoomSession when another user leaves the chat room.

ParticipantPrivilegeChangedEventArgs

Event argument forwarded by a ChatRoomSession when the privileges of a user have changed; see IsManager and IsPresenter.

PersistentChatAddIn

An add-in is a web-based application which can be associated with a chat room (see AddIn).

PersistentChatEndpoint

An endpoint which is the basis for all communication with the Persistent Chat server. This endpoint represents a single connection to a single persistent chat server, using an existing LocalEndpoint instance. This endpoint encapsulates references to all active ChatRoomSession instances to which the user has joined, and provides a access to a variety of management services, functionality for browsing the catalog of available chat rooms, and methods for reviewing chat history. (See PersistentChatServices)

PersistentChatEndpointStateChangedEventArgs

Event argument forwarded by a PersistentChatEndpoint when the state of the persistent chat server connection has changed.

PersistentChatException

Represents the base class for all exceptions defined in the Microsoft Persistent Chat API.

PersistentChatPreferenceBundle

Describes an arbitrary block of Data which a persistent chat application may define for storing user preferences and settings, or any other purpose.

PersistentChatServerConfiguration

Properties and configuration settings which apply to the persistent chat server to which the PersistentChatEndpoint has connected.

PersistentChatServices

Provides access to a wide variety of persistent chat features and services, including:

Enums

ChatEmoticon

Enumerates a chat message emoticon, which can be used as part of a chat message. See MessagePartEmoticon

ChatRoomBehavior

Enumerates the chat room behavior settings

ChatRoomInvitationSetting

Enumerates the invitation setting of a chat room

ChatRoomPrivacy

Enumerates the chat room privacy settings

ChatRoomRole

Enumerates a permissioned role on a ChatRoom. These roles may be granted to any provisioned PersistentChatPrincipal.

ChatRoomSessionState

Enumerates the state of a chat room session

PersistentChatEndpointState

Enumerates the state of a group chat endpoint

PersistentChatErrorCode

Enumerates the persistent chat error codes.

PersistentChatPrincipalType

Enumerates a type of user or user group.

RoomPermissionMap

Enumerates the room permission map.