GroupChatUserAdministrationServices.BeginGetFederatedUser Method

  • Article

Gets the GroupChatFederatedUser for the given SIP URI.

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

Syntax

'Declaration
Public Function BeginGetFederatedUser ( _
    sipUri As Uri, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatUserAdministrationServices
Dim sipUri As Uri
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginGetFederatedUser(sipUri, _
    userCallback, state)

public IAsyncResult BeginGetFederatedUser(
    Uri sipUri,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • sipUri
    Type: System.Uri
    The SIP URI of the user to retrieve.
  • 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 EndGetFederatedUser(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

GroupChatUserAdministrationServices Class

GroupChatUserAdministrationServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace