ChatRoomManagementServices.BeginGetCategoryUsers Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.PersistentChat.Management

Assembly:

Microsoft.Rtc.Collaboration.PersistentChat.dll

Finds users or user groups who are eligible for the Creator role on the specified category.

public:
 IAsyncResult ^ BeginGetCategoryUsers(Uri ^ categoryUri, System::String ^ filter, int resultSize, AsyncCallback ^ userCallBack, System::Object ^ state);

public IAsyncResult BeginGetCategoryUsers (Uri categoryUri, string filter, int resultSize, AsyncCallback userCallBack, object state);

member this.BeginGetCategoryUsers : Uri * string * int * AsyncCallback * obj -> IAsyncResult

Public Function BeginGetCategoryUsers (categoryUri As Uri, filter As String, resultSize As Integer, userCallBack As AsyncCallback, state As Object) As IAsyncResult

Parameters

categoryUri

Uri

The target category to search for users

filter

String

A filter to specify the first few characters of a name

resultSize

Int32

The size of the resulted list

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

ArgumentNullException

categoryUri or filter is null.

ArgumentException

categoryUri is not a valid category URI.

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.