ChatRoomSession.BeginGetHiddenParticipantList(AsyncCallback, Object) Method
Definition
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 current list of participants for a large chat room.
public:
IAsyncResult ^ BeginGetHiddenParticipantList(AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginGetHiddenParticipantList (AsyncCallback userCallback, object state);
member this.BeginGetHiddenParticipantList : AsyncCallback * obj -> IAsyncResult
Public Function BeginGetHiddenParticipantList (userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult that references this operation.
Exceptions
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
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.