ConferenceSession.BeginJoin Method (ConferenceJoinInformation, AsyncCallback, Object)
NOTE: This API is now obsolete.
This method will be removed from future versions. Instead, use BeginJoin(String, ConferenceJoinOptions, AsyncCallback, Object) to join a conference. Joins a conference based on the provided join information.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
<ObsoleteAttribute("This method will be removed from future versions. Use BeginJoin(ConferenceJoinOptions options,AsyncCallback userCallback, object state) or BeginJoin(string conferenceUri,ConferenceJoinOptions options,AsyncCallback userCallback, object state)")> _
Public Function BeginJoin ( _
information As ConferenceJoinInformation, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ConferenceSession
Dim information As ConferenceJoinInformation
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginJoin(information, _
userCallback, state)
[ObsoleteAttribute("This method will be removed from future versions. Use BeginJoin(ConferenceJoinOptions options,AsyncCallback userCallback, object state) or BeginJoin(string conferenceUri,ConferenceJoinOptions options,AsyncCallback userCallback, object state)")]
public IAsyncResult BeginJoin(
ConferenceJoinInformation information,
AsyncCallback userCallback,
Object state
)
Parameters
- information
Type: Microsoft.Rtc.Collaboration.ConferenceJoinInformation
Information to customize the join operation.
- 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 operation is not valid at the given conference session state. |
| ArgumentNullException | Thrown when the information argument was null. |
Remarks
Joining a conference is required to receive roster events on the ConferenceSession and McuSession implementations.