SignalingSession.BeginParticipate Method (AsyncCallback, Object)
Participates in a session. This method needs to be called (for both outgoing and incoming messages) to establish the session.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginParticipate ( _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginParticipate(userCallback, _
state)
public IAsyncResult BeginParticipate(
AsyncCallback userCallback,
Object state
)
Parameters
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
Exception | Condition |
---|---|
InvalidOperationException | Thrown when the session is not in a valid state to Participate. |
ArgumentException | Thrown when invalid arguments are passed. |
ArgumentNullException | Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message. |
RealTimeException | Thrown when some other failure occurs. |
Remarks
This method is now deprecated in favor of the BeginEstablish and BeginAccept APIs.