PersistentChatServices.BeginGetPreferenceBundle method

Lync 2013

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.PersistentChat
Assembly:  Microsoft.Rtc.Collaboration.PersistentChat (in Microsoft.Rtc.Collaboration.PersistentChat.dll)

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

Parameters

label
Type: System.String

The preference label.

seqId
Type: System.Int32

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

provideDefault
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 preference lable.

userCallback
Type: System.AsyncCallback

The method to be invoked when this asynchronous operation completes.

state
Type: System.Object

An object to be passed back to the callback.

Return value

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

ExceptionCondition
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.

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

Show:
© 2015 Microsoft