PersistentChatServices Class

Definition

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

public ref class PersistentChatServices
public class PersistentChatServices
type PersistentChatServices = class
Public Class PersistentChatServices
Inheritance
PersistentChatServices

Remarks

The supported features and services includes (1) Browsing the catalog of available chat rooms. (2) Browsing the chat history of logged chat rooms. (3) Reading and writing PersistentChatPreferenceBundle data. (4) Managing chat rooms (using ChatRoomManagementServices). (5) Managing persistent chat users and user groups (using UserServices). (6) Accessing persistent chat server configuration and properties (through ServerConfiguration).

An instance to this class may be obtained from the PersistentChatServices property on PersistentChatEndpoint.

Properties

ChatRoomManagementServices

An object which supports a variety of methods for managing chat rooms.

DomainName

Gets the name of the domain for this server. The DomainName is determined by the SIP URI of the Persistent Chat server pool.

Endpoint

Gets the endpoint that this service object is tied to.

RootCategoryUri

Gets the Root Category URI. The Root Category is the single uri which has no parent category, and from which all other chat rooms and categories are inherited. Use this category as a starting point to explore the entire hierarchy of chat rooms and categories.

ServerConfiguration

An object describing the server configuration.

ServerTimeUtc

Gets the server time in UTC (Coordinated Universal Time) when this endpoint was established. Use this value to compute time zone offsets between the server and the client for determing any shift in message timestamps that may exist due to small differences in the system clocks.

UserServices

An object which supports a variety of methods for administering persistent chat users and groups.

Methods

BeginBrowseChatRoomsByCategoryUri(Uri, AsyncCallback, Object)

Browse a list of chat rooms based on a category uri.

BeginBrowseChatRoomsByCategoryUri(Uri, Int32, AsyncCallback, Object)

Browse a list of chat rooms based on a category uri.

BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the description.

BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, Int32, AsyncCallback, Object)

Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the descriptions. The number of results will be limited to the number specified in the maxResults parameter.

BeginBrowseChatRoomsByFilterCriteria(String, Boolean, String, String, Uri, Nullable<Guid>, Boolean, Nullable<ChatRoomPrivacy>, Nullable<ChatRoomBehavior>, Nullable<Boolean>, Boolean, Int32, AsyncCallback, Object)

Browse a list of chat rooms based on a set of filter criteria

BeginBrowseChatRoomsByInvitations(Int32, AsyncCallback, Object)

Browse the list of chat rooms to which the currently logged in user has been invited. Chat room invitations are issued by the server in batches, and some invitations may not be immediately available for browsing.

This request will be processed asynchronously. See EndBrowseChatRoomsByInvitations(IAsyncResult, Int32) to complete this asynchronous operation.

BeginBrowseChatRoomsByJoinedUser(Uri, AsyncCallback, Object)

Browse the list of chat rooms on which the specified user is presently joined.

This request will be processed asynchronously. See EndBrowseChatRoomsByJoinedUser(IAsyncResult) to complete this asynchronous operation.

BeginBrowseChatRoomsIManage(AsyncCallback, Object, UInt32)

Browse the list of chat rooms that the currently logged in user can manage. This request will be processed asynchronously. See EndBrowseChatRoomsIManage(IAsyncResult) to complete this asynchronous operation.

BeginBrowseMyChatRooms(AsyncCallback, Object, UInt32)

Browse the list of chat rooms of which the currently logged in user is a member. This request will be processed asynchronously. See EndBrowseMyChatRooms(IAsyncResult) to complete this asynchronous operation.

BeginGetPreferenceBundle(String, Int32, Boolean, AsyncCallback, Object)

Get the preference bundle identified by the specified label for the currently logged in user. The sequence ID indicates the version number known to the requestor. If the requested ID matches the server version, no preference will be returned.

BeginQueryChatHistory(ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object)

Query the chat history for the specified collection of chat rooms, using the designated ChatHistoryQueryOptions.

BeginQueryChatHistory(ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object)

Query the chat history for the specified collection of chat rooms, using the designated search string and match options.

BeginSetPreferenceBundle(PersistentChatPreferenceBundle, AsyncCallback, Object)

Save the given preference bundle, and increment the SequenceId

EndBrowseChatRoomsByCategoryUri(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseChatRoomsByCategoryUri(Uri, AsyncCallback, Object) or BeginBrowseChatRoomsByCategoryUri(Uri, Int32, AsyncCallback, Object)

EndBrowseChatRoomsByCriteria(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, AsyncCallback, Object) or BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, Int32, AsyncCallback, Object)

EndBrowseChatRoomsByFilterCriteria(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseChatRoomsByFilterCriteria(String, Boolean, String, String, Uri, Nullable<Guid>, Boolean, Nullable<ChatRoomPrivacy>, Nullable<ChatRoomBehavior>, Nullable<Boolean>, Boolean, Int32, AsyncCallback, Object).

EndBrowseChatRoomsByInvitations(IAsyncResult, Int32)

Completes the asynchronous request initiated by BeginBrowseChatRoomsByInvitations(Int32, AsyncCallback, Object)

EndBrowseChatRoomsByJoinedUser(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseChatRoomsByJoinedUser(Uri, AsyncCallback, Object)

EndBrowseChatRoomsIManage(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseChatRoomsIManage(AsyncCallback, Object, UInt32)

EndBrowseMyChatRooms(IAsyncResult)

Completes the asynchronous request initiated by BeginBrowseMyChatRooms(AsyncCallback, Object, UInt32)

EndGetPreferenceBundle(IAsyncResult)

Completes the asynchronous request initiated by BeginGetPreferenceBundle(String, Int32, Boolean, AsyncCallback, Object)

EndQueryChatHistory(IAsyncResult)

Completes the asynchronous request initiated by BeginQueryChatHistory(ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object) or BeginQueryChatHistory(ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object)

EndSetPreferenceBundle(IAsyncResult)

Completes the asynchronous request initiated by BeginSetPreferenceBundle(PersistentChatPreferenceBundle, AsyncCallback, Object)

Applies to