Share via

Conference Manager Session Object

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The IUccConferenceManagerSession object provides all the functionality necessary to manage conferences. With this object you can schedule, configure, and delete conferences. In addition, you can get the available multipoint control unit (MCU) configured on your conference Focus server. You can get a list of all conferences you have scheduled that have not expired. This list is useful when you want to reconfigure a previously scheduled conference.

Note

A conference manager session is not a conference session. The conference session object (IUccConferenceSession) is used to participate in an active conference while the conference manager session is used to schedule and configure a conference.

Conference Manager Session Methods

  • CreateConferenceInformation creates an interface that provides access to conference properties used to configure a conference. It also returns a IUccConferenceInformation interface.
  • DeleteConference deletes a conference. You provide a conference ID as an argument to this method.
  • GetAvailableMCUs gets a list of MCUs configured on the Focus server. This list is used when configuring a conference with the conference information interface.
  • GetConference gets a single conference. It is called when you want to reconfigure a conference. You provide a conference ID as an argument to this method.
  • GetConferenceList gets a list of all the conferences the local user has scheduled. The list is limited to conferences that have not expired.
  • ModifyConference updates the conference you have reconfigured on the Focus server. The IUccConferenceInformation interface returned with the OnGetConference conference manager session event is returned to the Focus Factory module as an argument to the ModifyConference method.
  • ScheduleConference creates a new conference on the Focus Factory module. The conference is scheduled and can be joined when Office Communications Server completes the request. You set the expiration date of the conference when you configure it using the conference information interface. The Subject property of the IUccConferenceInformation object should describe the conference in a way that allows a reader to distinguish one conference from another. You can include a string representing the start date and time in the subject for this purpose.

Conference Manager Session Events

  • The OnDeleteConference event is raised when the Focus server complete a request to delete a conference using the DeleteConference method. The EventData object returned by this event provides information about the success or failure of the request. For more information, see IUccOperationProgressEvent.
  • The OnGetAvailableMCUs event is raised when the Focus server returns a list of the MCUs available to provide media content for a conference. The request for an MCU list is made by calling GetAvailableMCUs. The IUccOperationProgressEvent interface contains the provided list.
  • The OnGetConference event is raised when a requested conference is returned by the Focus Factory module. The Properties property of the IUccOperationProgressEvent provides a IUccConferenceInformation interface and conference URI. This conference information interface is updated as needed and passed back to the Focus server with a call to ModifyConference.
  • The OnGetConferenceList event is raised when the Focus Factory module returns a list of conferences the local user has scheduled. The list is limited to conferences that have not expired.
  • The OnModifyConference event is raised when the Focus Factory module processes the local client request to update a conference on Office Communications Server. The IsComplete property of the IUccOperationProgressEvent interface should be read to determine whether the operation is complete. A completed operation might not be a successful operation. For this reason, you should read the StatusCode property. A value of zero or greater indicates success.
  • The OnScheduleConference event is raised when the Focus Factory module processes the local client request to schedule a conference. The callback function you create for this event is a good place to trigger an invitation process for users you want to participate in the conference as well as create a IUccConferenceSession to enter the conference yourself. The EventData argument to the callback function provides the conference URI of the conference.

Note

The invited user must pass the URI of the conference as an argument to the Enter method. Additionally, you can require the invited user provide a conference key. Unified Communications Client API does not provide a method to transmit these data items to potential conference participants. A good way to do this is to create e-mail functionality in your code that is called in this event handler.

See Also

Concepts

Conference Manager Creation
Programming Patterns with Conference Scheduling Objects