ConferenceSession.BeginJoin Method (ConferenceJoinOptions, AsyncCallback, Object)
Joins a conference based on the provided join options.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginJoin ( _
options As ConferenceJoinOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ConferenceSession
Dim options As ConferenceJoinOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginJoin(options, _
userCallback, state)
public IAsyncResult BeginJoin(
ConferenceJoinOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- options
Type: Microsoft.Rtc.Collaboration.ConferenceJoinOptions
Options to customize joining a conference. Could be set to null.
- 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. |
Remarks
Joining a conference is required to receive roster events on the ConferenceSession and McuSession implementations.
An endpoint supporting privileged operations is required to join as a trusted application.
Applications can customize joining a conference by passing a ConferenceJoinOptions instance.
If the parent Conversation instance has already received and accepted a conference invitation, or received an MCU dial-out, then calling this method will join the application to the specific conference it was invited.
If, however, the application was not invited to a conference through a conference invitation or an MCU dial-out, then the platform organizes an ad-hoc conference, and the application is joined to that conference.