ChatRoomManagementServices.BeginFindChatRoomsByParentCategory Method

  • Article

Finds all chat rooms in the parent category referenced by parentCategory. To find subcategories within a category, use BeginFindCategoriesByParentCategory(Uri, AsyncCallback, Object).

Namespace: Microsoft.Rtc.Collaboration.GroupChat.Management
Assembly:  Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)

Syntax

'Declaration
Public Function BeginFindChatRoomsByParentCategory ( _
    parentCategory As Uri, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomManagementServices
Dim parentCategory As Uri
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginFindChatRoomsByParentCategory(parentCategory, _
    userCallback, state)

public IAsyncResult BeginFindChatRoomsByParentCategory(
    Uri parentCategory,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • parentCategory
    Type: System.Uri
    The parent category.
  • 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
ArgumentException

Thrown when invalid arguments are passed.
[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown when the GroupChatEndpoint is not established.
[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 EndFindChatRoomsByParentCategory(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

ChatRoomManagementServices Class

ChatRoomManagementServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace