ConferenceSession.BeginJoin Method

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginJoin(AsyncCallback, Object)	Obsolete. This method will be removed from future versions. Instead, use BeginJoin(ConferenceJoinOptions, AsyncCallback, Object) to join a conference. Creates and joins an ad-hoc conference.
BeginJoin(ConferenceJoinInformation, AsyncCallback, Object)	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.
BeginJoin(ConferenceJoinOptions, AsyncCallback, Object)	Joins a conference based on the provided join options.
BeginJoin(MeetNowOptions, AsyncCallback, Object)	Creates and joins an ad hoc conference conference with the widest possible audience.
BeginJoin(String, ConferenceJoinOptions, AsyncCallback, Object)	Joins a conference based on the provided conference URI and join options.

BeginJoin(AsyncCallback, Object)

Caution

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)

This method will be removed from future versions. Instead, use BeginJoin(ConferenceJoinOptions, AsyncCallback, Object) to join a conference. Creates and joins an ad-hoc conference.

public:
 IAsyncResult ^ BeginJoin(AsyncCallback ^ userCallback, System::Object ^ state);

[System.Obsolete("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 (AsyncCallback userCallback, object state);

member this.BeginJoin : AsyncCallback * obj -> IAsyncResult

Public Function BeginJoin (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Attributes

ObsoleteAttribute

Exceptions

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 derivatives.

The platform schedules a conference valid for 8 hours with an MCU for all the available MCU factories. However, the audio-video MCU will only be scheduled if inband provisioning data for the endpoint is available and indicates that the endpoint owner is provisioned for audio.

BeginJoin(ConferenceJoinInformation, AsyncCallback, Object)

Caution

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)

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.

public:
 IAsyncResult ^ BeginJoin(Microsoft::Rtc::Collaboration::ConferenceJoinInformation ^ information, AsyncCallback ^ userCallback, System::Object ^ state);

[System.Obsolete("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 (Microsoft.Rtc.Collaboration.ConferenceJoinInformation information, AsyncCallback userCallback, object state);

member this.BeginJoin : Microsoft.Rtc.Collaboration.ConferenceJoinInformation * AsyncCallback * obj -> IAsyncResult

Public Function BeginJoin (information As ConferenceJoinInformation, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

information

ConferenceJoinInformation

Information to customize the join operation.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Attributes

ObsoleteAttribute

Exceptions

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.

BeginJoin(ConferenceJoinOptions, AsyncCallback, Object)

Joins a conference based on the provided join options.

public:
 IAsyncResult ^ BeginJoin(Microsoft::Rtc::Collaboration::ConferenceJoinOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginJoin (Microsoft.Rtc.Collaboration.ConferenceJoinOptions options, AsyncCallback userCallback, object state);

member this.BeginJoin : Microsoft.Rtc.Collaboration.ConferenceJoinOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginJoin (options As ConferenceJoinOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

options

ConferenceJoinOptions

Options to customize joining a conference. Could be set to null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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.

BeginJoin(MeetNowOptions, AsyncCallback, Object)

Creates and joins an ad hoc conference conference with the widest possible audience.

public:
 IAsyncResult ^ BeginJoin(Microsoft::Rtc::Collaboration::MeetNowOptions ^ meetNowOptions, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginJoin (Microsoft.Rtc.Collaboration.MeetNowOptions meetNowOptions, AsyncCallback userCallback, object state);

member this.BeginJoin : Microsoft.Rtc.Collaboration.MeetNowOptions * AsyncCallback * obj -> IAsyncResult

Parameters

meetNowOptions

MeetNowOptions

Options to customize joining a conference. Could be set to null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the operation is not valid at the given conference session state.

Remarks

Applications can customize joining a conference by passing a MeetNowOptions instance.

BeginJoin(String, ConferenceJoinOptions, AsyncCallback, Object)

Joins a conference based on the provided conference URI and join options.

public:
 IAsyncResult ^ BeginJoin(System::String ^ conferenceUri, Microsoft::Rtc::Collaboration::ConferenceJoinOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginJoin (string conferenceUri, Microsoft.Rtc.Collaboration.ConferenceJoinOptions options, AsyncCallback userCallback, object state);

member this.BeginJoin : string * Microsoft.Rtc.Collaboration.ConferenceJoinOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginJoin (conferenceUri As String, options As ConferenceJoinOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

conferenceUri

String

The URI of the conference to join.

options

ConferenceJoinOptions

Options to customize joining a conference. Could be set to null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the operation is not valid at the given conference session state or if the application attempted to join a difference conference after it received a conference invitation or an Mcu dial-out.

ArgumentException

Thrown when the supplied conferenceUri is null or empty.

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.

An application may land in the lobby depending on how it joined the conference and the current conference settings. An application joining a conference as trusted will never land in the conference lobby.

When an application lands in the lobby, the State will be transitioned to InLobby and the State will be also transitioned to InLobby. The userCallback will not be invoked until the application has either been admitted into the conference by a leader, removed from the lobby by a leader or left the lobby.

If the application was admitted into the conference, the EndJoin(IAsyncResult) method will not throw any exceptions. The State will be transitioned to Conferenced and the State will be transitioned to Connected. On the other hand, if the application was removed from the lobby by a conference leader, the EndJoin(IAsyncResult) method will throw a ConferenceFailureException with Reason set to set to UserDenied or UserRemoved.

When an application leaves the lobby by calling BeginTerminate(AsyncCallback, Object), then the EndJoin(IAsyncResult) method will throw an OperationFailureException. An OperationTimeoutException will be thrown if the application lobby wait period expired.

Lobby participants receive limited information about the conference, therefore not all the ConferenceSession properties are populated while in the lobby. Also, lobby participants do not receive any information about other participants in the conference or waiting in the lobby and they are not able to perform any operations on the conference like modifying the conference access level.