Gets the scope of the specified category.

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

Syntax

Visual Basic (Declaration)
Public 
Function 
BeginGetScope ( _
	
categoryUri 
As 
Uri, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
Visual Basic (Usage)
Dim 
instance 
As 

ChatRoomCategoryManagementServices
Dim 
categoryUri 
As 
Uri
Dim 
userCallback 
As 
AsyncCallback
Dim 
state 
As 
Object
Dim 
returnValue 
As 
IAsyncResult

returnValue = instance.
BeginGetScope(
categoryUri, _
	
userCallback, 
state)
C#
public 
IAsyncResult 
BeginGetScope(
	
Uri 
categoryUri,
	
AsyncCallback 
userCallback,
	
Object 
state
)

Parameters

categoryUri
Type: System . . :: . . Uri

The category URI.

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 EndGetScope(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 BeginSetScope(ChatRoomCategory, ICollection < (Of < <' ( GroupChatPrincipalSummary > ) > > ) , AsyncCallback, Object)

See Also