This documentation is archived and is not being maintained.

BeginGetPreferenceBundle Method

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.

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.

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

public IAsyncResult BeginGetPreferenceBundle(
	string label,
	int seqId,
	bool provideDefault,
	AsyncCallback userCallback,
	Object state


Type: System.String
The preference label.
Type: System.Int32
The preference sequence ID. Every time theGroupChatPreferenceBundleis accessed, whether for read or write, the SequenceId is incremented.
Type: System.Boolean
If true, the server will attempt to vend a default value for the requested preference, if no value is defined for the given label.
Type: System.AsyncCallback
The method to be invoked when this asynchronous operation completes.
Type: System.Object
An object to be passed back to the callback.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references this operation.


Thrown when invalid arguments are passed.


Thrown when the GroupChatEndpoint is not established.


Thrown when the chat server connection is not in a valid state to send the command.


Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server.

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