PersistentChatPreferenceBundle Class

Definition

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

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

Remarks

The Version 14 or older Group Chat clients use 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 via 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.

Constructors

PersistentChatPreferenceBundle(String, Int32, String)

Initializes a new instance of the PersistentChatPreferenceBundle class.

Properties

Data

Gets or sets the block of data which this preference represents. A preference bundle can be used to store arbitrary information which is needed by a persistent chat application.

Label

Gets or sets the label for this preference bundle. The label is a short name or description for the block of data stored in this preference.

SequenceId

Gets or sets the sequence ID. The sequence ID is a monotonically increasing value which governs the revision level of a preference. Every time the pref bundle is accessed, whether for read or write, the seq ID is incremented.

Applies to