Share via

ConferenceSession.BeginModifyConferenceConfiguration Method (ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, ModifyConferenceConfigurationOptions, AsyncCallback, Object)

  • Article

Modifies conference configuration.

Namespace:  Microsoft.Rtc.Collaboration
Assembly:  Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)

Syntax

'Declaration
Public Function BeginModifyConferenceConfiguration ( _
    accessLevel As ConferenceAccessLevel, _
    lobbyBypass As LobbyBypass, _
    automaticLeaderAssignment As AutomaticLeaderAssignment, _
    options As ModifyConferenceConfigurationOptions, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ConferenceSession
Dim accessLevel As ConferenceAccessLevel
Dim lobbyBypass As LobbyBypass
Dim automaticLeaderAssignment As AutomaticLeaderAssignment
Dim options As ModifyConferenceConfigurationOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginModifyConferenceConfiguration(accessLevel, _
    lobbyBypass, automaticLeaderAssignment, _
    options, userCallback, state)

public IAsyncResult BeginModifyConferenceConfiguration(
    ConferenceAccessLevel accessLevel,
    LobbyBypass lobbyBypass,
    AutomaticLeaderAssignment automaticLeaderAssignment,
    ModifyConferenceConfigurationOptions options,
    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 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.
ArgumentException

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 ConferenceSession.GetAllowedAccessLevels() 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.

See Also

Reference

ConferenceSession Class

ConferenceSession Members

BeginModifyConferenceConfiguration Overload

Microsoft.Rtc.Collaboration Namespace