This documentation is archived and is not being maintained.

GroupChatPreferenceBundle 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 an arbitrary block of Data which a group chat application may define for storing user preferences and settings, or any other purpose.


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

Public Class GroupChatPreferenceBundle
Dim instance As GroupChatPreferenceBundle

The group chat client uses a set of preference bundles to store client settings such as chat rooms joined, chat room display settings, and other customizations. The format of data stored in a preference bundle is application dependent.

Each preference bundle has a name (see Label) and version number (see SequenceId). When requesting preferences for a given Label through BeginGetPreferenceBundle(String, Int32, Boolean, AsyncCallback, Object), the supplied SequenceId will be compared to the version stored on the server. If the supplied version is greater than or equal to the server version, no data will be returned. If the supplied version is less than the server version, a current version of the data will be returned.

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