Sets the scope of the specified category.
Assembly: Microsoft.Rtc.Collaboration.GroupChat(in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function BeginSetScope ( _ category As ChatRoomCategory, _ newScope As ICollection( Of GroupChatPrincipalSummary), _ userCallback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
Visual Basic (Usage) |
---|
Dim instance As ChatRoomCategoryManagementServices Dim category As ChatRoomCategory Dim newScope As ICollection( Of GroupChatPrincipalSummary) Dim userCallback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance. BeginSetScope( category, _ newScope, userCallback, state) |
C# |
---|
public IAsyncResult BeginSetScope( ChatRoomCategory category, ICollection< GroupChatPrincipalSummary> newScope, AsyncCallback userCallback, Object state ) |
Parameters
- category
- Type:
Microsoft.Rtc.Collaboration.GroupChat
.
.
::
.
.
ChatRoomCategory
The category on which you wish to set scope.
- newScope
- Type:
System.Collections.Generic
.
.
::
.
.
ICollection
<
(Of
<
(
<'
GroupChatPrincipalSummary
>
)
>
)
>
The new scope.
- 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.
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
Unlike BeginAddUsersOrGroupsToRole(ChatRoomRole, Uri, ICollection < (Of < <' ( GroupChatPrincipalSummary > ) > > ) , AsyncCallback, Object) , this command deletes the existing scope, and replaces it with the specified newScope.
This request will be processed asynchronously. See EndSetScope(IAsyncResult) to complete this asynchronous operation.
The scope of a category is a collection of users and user groups who may:
-
Search for and find the chat rooms in this category and those below it.
-
Be added to the member or manager list of the category, its subcategories, and chat rooms.
When specified, the scope of a category must always be a subset of the scope of the parent category. Hence, scope can be narrowed, but never increased. See BeginGetScope(Uri, AsyncCallback, Object)