PersistentChatEndpoint Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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)
public ref class PersistentChatEndpoint
public class PersistentChatEndpoint
type PersistentChatEndpoint = class
Public Class PersistentChatEndpoint
- Inheritance
-
PersistentChatEndpoint
Constructors
PersistentChatEndpoint(Uri, LocalEndpoint) |
Initializes a new instance of the PersistentChatEndpoint class. |
Properties
ActiveChatRoomSessions |
Gets a copy of the collection of currently active ChatRoomSession instances. Only those sessions which have successfully joined a chat room are included in the collection of ActiveChatRoomSessions. This property returns copy of the endpoint's collection. To access a single active ChatRoomSession by name, without incurring this overhead, use the indexer (see (Item[String]). |
InnerEndpoint |
Gets the inner endpoint which provides a conduit for delivery of messages between this client and the persistent chat servers. |
Item[String] |
Gets an active ChatRoomSession with the specified name. The name is not case sensitive. |
Item[Uri] |
Gets an active ChatRoomSession with the specified URI. |
PersistentChatServices |
An object which provides access to a wide variety of persistent chat features and services. All administrative functionality and client services, with the exception of establishing a ChatRoomSession, are exposed through this object. |
State |
Gets a value indicating whether this endpoint is connected to a Persistent Chat server. |
Methods
BeginEstablish(AsyncCallback, Object) |
Establish a connection with the Persistent Chat server. This request will be processed asynchronously. See EndEstablish(IAsyncResult) to complete this asynchronous operation. |
BeginTerminate(AsyncCallback, Object) |
Terminate an established connection with the Persistent Chat server, and clean up all resources associated with the connection. This request will be processed asynchronously. See EndTerminate(IAsyncResult) to complete this asynchronous operation. |
EndEstablish(IAsyncResult) |
Completes the asynchronous request initiated by BeginEstablish(AsyncCallback, Object) |
EndTerminate(IAsyncResult) |
Completes the asynchronous request initiated by BeginTerminate(AsyncCallback, Object) |
Events
ChatRoomInvitationReceived |
Occurs when a chat room invitation is received. |
ConnectionStateChanged |
Occurs when the connection state of this endpoint changes. |
Applies to
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for