Edit

Share via


ConferenceSession.BeginModifyConferenceConfiguration Method

Definition

Overloads

BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, AsyncCallback, Object)

Modifies conference configuration.

BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, ModifyConferenceConfigurationOptions, AsyncCallback, Object)

Modifies conference configuration.

BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, AsyncCallback, Object)

Modifies conference configuration.

public:
 IAsyncResult ^ BeginModifyConferenceConfiguration(Microsoft::Rtc::Collaboration::ConferenceAccessLevel accessLevel, Microsoft::Rtc::Collaboration::LobbyBypass lobbyBypass, Microsoft::Rtc::Collaboration::AutomaticLeaderAssignment automaticLeaderAssignment, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginModifyConferenceConfiguration (Microsoft.Rtc.Collaboration.ConferenceAccessLevel accessLevel, Microsoft.Rtc.Collaboration.LobbyBypass lobbyBypass, Microsoft.Rtc.Collaboration.AutomaticLeaderAssignment automaticLeaderAssignment, AsyncCallback userCallback, object state);
member this.BeginModifyConferenceConfiguration : Microsoft.Rtc.Collaboration.ConferenceAccessLevel * Microsoft.Rtc.Collaboration.LobbyBypass * Microsoft.Rtc.Collaboration.AutomaticLeaderAssignment * AsyncCallback * obj -> IAsyncResult

Parameters

accessLevel
ConferenceAccessLevel

The new access level.

lobbyBypass
LobbyBypass

New lobby bypass setting.

automaticLeaderAssignment
AutomaticLeaderAssignment

The new automatic leader assignment setting.

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

An IAsyncResult that references the asynchronous operation.

Exceptions

Thrown when the operation is not valid in the current conference session state or the joined conference is one that has been migrated from earlier server version and is running in compatibility mode.

Thrown when an argument passed has an invalid value.

Remarks

A conference leader can allow specific types of users to bypass the lobby and get admitted directly into the conference although under normal conditions those users are placed in the lobby. As an example, a conference leader may allow participants joining over the phone to bypass the lobby. Note however, if the conference current access level is Locked, all new users joining the conference - regardless of any bypass setting - are placed in the conference lobby.

Conference access level determines which users are admitted into the conference or placed in the lobby. When a conference is first activated (by the first user attempting to the join the conference), the initial access level applied is whatever level that was set by the organizer (i.e. at scheduling time). Any changes to the access level performed by this method are lost after the conference is deactivated.

Applications should call the GetAllowedAccessLevels() method before calling this method to retrieve the allowed access levels the conference could be changed to.

Note: An application may not wish to change all configuration settings at once. In this case it can use the properties on conference session to get the current cached value of the setting to prevent the setting from being changed. In some cases where two leaders are making changes in a short time interval, it may be possible that the cached version of the setting does not reflect the most current value at the server, and could overwrite the value as set by another leader. The setting would have to then be reapplied.

This operation can only be performed by a conference leader.

Applies to

BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, ModifyConferenceConfigurationOptions, AsyncCallback, Object)

Modifies conference configuration.

public:
 IAsyncResult ^ BeginModifyConferenceConfiguration(Microsoft::Rtc::Collaboration::ConferenceAccessLevel accessLevel, Microsoft::Rtc::Collaboration::LobbyBypass lobbyBypass, Microsoft::Rtc::Collaboration::AutomaticLeaderAssignment automaticLeaderAssignment, Microsoft::Rtc::Collaboration::ModifyConferenceConfigurationOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginModifyConferenceConfiguration (Microsoft.Rtc.Collaboration.ConferenceAccessLevel accessLevel, Microsoft.Rtc.Collaboration.LobbyBypass lobbyBypass, Microsoft.Rtc.Collaboration.AutomaticLeaderAssignment automaticLeaderAssignment, Microsoft.Rtc.Collaboration.ModifyConferenceConfigurationOptions options, AsyncCallback userCallback, object state);
member this.BeginModifyConferenceConfiguration : Microsoft.Rtc.Collaboration.ConferenceAccessLevel * Microsoft.Rtc.Collaboration.LobbyBypass * Microsoft.Rtc.Collaboration.AutomaticLeaderAssignment * Microsoft.Rtc.Collaboration.ModifyConferenceConfigurationOptions * AsyncCallback * obj -> IAsyncResult

Parameters

accessLevel
ConferenceAccessLevel

The new access level.

lobbyBypass
LobbyBypass

New lobby bypass setting.

automaticLeaderAssignment
AutomaticLeaderAssignment

The new automatic leader assignment setting.

options
ModifyConferenceConfigurationOptions

Options to customize the operation. Could be 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

An IAsyncResult that references the asynchronous operation.

Exceptions

Thrown when the operation is not valid in the current conference session state or the joined conference is one that has been migrated from earlier server version and is running in compatibility mode.

Thrown when an argument passed has an invalid value.

Remarks

A conference leader can allow specific types of users to bypass the lobby and get admitted directly into the conference although under normal conditions those users are placed in the lobby. As an example, a conference leader may allow participants joining over the phone to bypass the lobby. Note however, if the conference current access level is Locked, all new users joining the conference - regardless of any bypass setting - are placed in the conference lobby.

Conference access level determines which users are admitted into the conference or placed in the lobby. When a conference is first activated (by the first user attempting to the join the conference), the initial access level applied is whatever level that was set by the organizer (i.e. at scheduling time). Any changes to the access level performed by this method are lost after the conference is deactivated.

Applications should call the GetAllowedAccessLevels() methodbefore calling this method to retrieve the allowed access levels the conference could be changed to.

Note: An application may not wish to change all configuration settings at once. In this case it can use the properties on conference session to get the current cached value of the setting to prevent the setting from being changed. In some cases where two leaders are making changes in a short time interval, it may be possible that the cached version of the setting does not reflect the most current value at the server, and could overwrite the value as set by another leader. The setting would have to then be reapplied.

This operation can only be performed by a conference leader.

Applies to