ChatRoomSession.BeginGetHiddenParticipantList Method
Get the current list of participants for a "Large" chat room.
Namespace: Microsoft.Rtc.Collaboration.GroupChat
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
'Declaration
Public Function BeginGetHiddenParticipantList ( _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomSession
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginGetHiddenParticipantList(userCallback, _
state)
public IAsyncResult BeginGetHiddenParticipantList(
AsyncCallback userCallback,
Object state
)
Parameters
- 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.
Exceptions
| Exception | Condition |
|---|---|
| [Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException] | Thrown when the GroupChatEndpoint is not established. |
| [Microsoft.Rtc.Collaboration.GroupChat.ChatRoomSessionStateException] | Thrown when the ChatRoomSession is not joined. |
| [System.InvalidOperationException] | Thrown when the chat server connection is not in a valid state to send the command. |
| [RealTimeException] | Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server. |
Remarks
This request will be processed asynchronously. See EndGetHiddenParticipantList(IAsyncResult) to complete this asynchronous operation.
This command is only supported for "Large" chat rooms. Large chat rooms exceed a 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 vend a participant list to new users who join the chat room. To view the participant list of such a chat room, use this method.