PersistentChatServices.BeginGetPreferenceBundle Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.PersistentChat

Assembly:: Microsoft.Rtc.Collaboration.PersistentChat.dll

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.

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.

public:
 IAsyncResult ^ BeginGetPreferenceBundle(System::String ^ label, int seqId, bool provideDefault, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginGetPreferenceBundle (string label, int seqId, bool provideDefault, AsyncCallback userCallback, object state);

member this.BeginGetPreferenceBundle : string * int * bool * AsyncCallback * obj -> IAsyncResult

Public Function BeginGetPreferenceBundle (label As String, seqId As Integer, provideDefault As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

label: String

The preference label.

seqId: Int32

The preference sequence ID.
Every time the PersistentChatPreferenceBundle is accessed, whether for read or write, the SequenceId is incremented.

provideDefault: Boolean

If true, the server will attempt to vend a default value for the requested preference, if no value is defined for the given preference lable.

userCallback: AsyncCallback

The method to be invoked when this asynchronous operation completes.

state: Object

An object to be passed back to the callback.

Returns

IAsyncResult

An IAsyncResult that references this operation.

Exceptions

ArgumentException

label is null or empty.

ChatServerConnectionException

The PersistentChatEndpoint is not established.

InvalidOperationException

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

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the chat server.

Remarks

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

Applies to