ChatRoomManagementServices.BeginFindUsersOrGroupsForRole Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.PersistentChat.Management

Assembly:: Microsoft.Rtc.Collaboration.PersistentChat.dll

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.

Finds users or user groups who are eligible for the given role on the specified chat room.

public:
 IAsyncResult ^ BeginFindUsersOrGroupsForRole(Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomRole role, Uri ^ chatRoomUri, System::String ^ searchString, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginFindUsersOrGroupsForRole (Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomRole role, Uri chatRoomUri, string searchString, AsyncCallback userCallback, object state);

member this.BeginFindUsersOrGroupsForRole : Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomRole * Uri * string * AsyncCallback * obj -> IAsyncResult

Public Function BeginFindUsersOrGroupsForRole (role As ChatRoomRole, chatRoomUri As Uri, searchString As String, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

role: ChatRoomRole

The role for which eligible users are being searched.

chatRoomUri: Uri

The chat room URI.

searchString: String

The search string by which eligible users will be filtered.

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

ArgumentException

searchString is null or empty, chatRoomUri is not a valid chat room URI.

ArgumentOutOfRangeException

role has value Creator

ArgumentNullException

chatRoomUri is null.

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.

Remarks

The searchString parameter value matches against the Name of the user or user group. To be eligible for Member or Manager roles, a user or user group must be in scope on the category. To be eligible for Presenter, the principal must already be a member of the chat room. This request will be processed asynchronously. See EndFindUsersOrGroupsForRole(IAsyncResult) to complete this asynchronous operation.

Applies to