ChatRoomSession.BeginGetHiddenParticipantList method

Lync 2013

Get the current list of participants for a large chat room.

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

public IAsyncResult BeginGetHiddenParticipantList(
	AsyncCallback userCallback,
	Object state
)

Parameters

userCallback
Type: System.AsyncCallback

The callback 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
ChatServerConnectionException

The PersistentChatEndpoint is not established.

ChatRoomSessionStateException

The State 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 persistent chat server.

This command is only supported for large chat rooms, with the number of participants exceeding the server configurable population size. When a chat room population reaches this limit, the server stops notifying users of changes to the participant list, and does not send a participant list to new users who join the chat room. In such cases, this method can be used to view the participant list of such a chat room. This request will be processed asynchronously. Call EndGetHiddenParticipantList(IAsyncResult) to complete this asynchronous operation.

Show:
© 2015 Microsoft