# Implementing a virtual conference extension Support adding a virtual conference room to an event in Calendar. ## Overview This sample code project demonstrates how to implement a virtual conference extension using [`EKVirtualConferenceProvider`](/documentation/EventKit/EKVirtualConferenceProvider). With this extension, people can add a virtual conference room to an event in Calendar, by selecting the room from a list in the event’s Location field. The sample code extension uses a single target that supports iOS and macOS. ### Configure the sample code project To configure the sample code project, do the following in Xcode: 1. Open the sample in the latest version of Xcode. 1. For all targets in the sample project, choose your team from the Team menu in the Signing & Capabilities pane to let Xcode automatically manage your provisioning profile. For more information, see “Set the bundle ID” and “Assign the project to a team” in . ### Add a virtual conference extension target to your project To create a virtual conference extension, add a virtual conference extension target to your new or existing Xcode project. To add a virtual conference extension target, follow these steps: 1. Choose File > New > Target. 1. In the sheet that appears, choose the platform your app supports. For instance, select the Virtual Conference template under the iOS platform. If your app supports an additional platform such as macOS, add the platform as a destination to the created extension. For more information, see “Configure the supported destinations for a target” in . 1. Scroll down to the Application Extension section. 1. Select the Virtual Conference template. 1. Click Next. 1. Specify the name of your extension and leave the other values set to their defaults. 1. Click Finish. ### Review the generated virtual conference extension files The Virtual Conference template creates an `Info.plist` file and the `VirtualConferenceProvider` class. The `Info.plist` file includes an `NSExtensionPointIdentifier` key and an `NSExtensionPrincipalClass` key under the `NSExtension` key: ``` NSExtension NSExtensionPointIdentifier com.apple.calendar.virtualconference NSExtensionPrincipalClass $(PRODUCT_MODULE_NAME).VirtualConferenceProvider ``` `NSExtensionPointIdentifier` identifies the virtual conference extension. `NSExtensionPrincipalClass` specifies a custom subclass of `EKVirtualConferenceProvider`. If you change the name of your custom subclass, update `NSExtensionPrincipalClass` with the new name. `VirtualConferenceProvider`, a subclass of [`EKVirtualConferenceProvider`](/documentation/EventKit/EKVirtualConferenceProvider), provides an initial code that supports creating and adding a single conference room to an event in Calendar. `VirtualConferenceProvider` implements the [`fetchAvailableRoomTypes(completionHandler:)`](/documentation/EventKit/EKVirtualConferenceProvider/fetchAvailableRoomTypes(completionHandler:)) and [`fetchVirtualConference(identifier:completionHandler:)`](/documentation/EventKit/EKVirtualConferenceProvider/fetchVirtualConference(identifier:completionHandler:)) methods. The former creates and returns a list with one conference room, and the latter creates and returns information about a virtual conference. You can build and run the project before you customize the extension code. To customize the extension, the sample project extension overrides `fetchAvailableRoomTypes(completionHandler:)` and `fetchVirtualConference(identifier:completionHandler:)`. ### Provide room details The sample project extension provides a personal room and a one-time room that people can select in the calendar event to schedule a virtual conference. It creates an [`EKVirtualConferenceRoomTypeDescriptor`](/documentation/EventKit/EKVirtualConferenceRoomTypeDescriptor) object for each room. Each descriptor specifies a title and a unique identifier for the room: ```swift let personalRoom = EKVirtualConferenceRoomTypeDescriptor(title: "Personal Room", identifier: "personal-room") let oneTimeRoom = EKVirtualConferenceRoomTypeDescriptor(title: "One-Time Room", identifier: "onetime-room") ``` Then the sample project extension modifies the [`fetchAvailableRoomTypes(completionHandler:)`](/documentation/EventKit/EKVirtualConferenceProvider/fetchAvailableRoomTypes(completionHandler:)) method to return a list that contains these rooms: ```swift override func fetchAvailableRoomTypes() async throws -> [EKVirtualConferenceRoomTypeDescriptor] { // Create the different room types the app supports. let personalRoom = EKVirtualConferenceRoomTypeDescriptor(title: "Personal Room", identifier: "personal-room") let oneTimeRoom = EKVirtualConferenceRoomTypeDescriptor(title: "One-Time Room", identifier: "onetime-room") // A list of virtual rooms people can select in the calendar event. return [personalRoom, oneTimeRoom] } ``` ### Create a conference descriptor The sample project extension calls a custom method to set up a virtual conference descriptor for each of the rooms it provides. It creates a list of URL descriptors, including an HTTP URL universal link for joining the conference and an optional secondary URL for dialing in to the conference: ```swift /* The sample project extension provides a primary URL to join this conference and an optional alternate URL to let people dial in to the conference. */ var urlDescriptors = [EKVirtualConferenceURLDescriptor(title: "Join Meeting", url: url)] if let alternateURL { urlDescriptors.append(EKVirtualConferenceURLDescriptor(title: "Audio Only", url: alternateURL)) } ``` Then the sample project extension creates an [`EKVirtualConferenceDescriptor`](/documentation/EventKit/EKVirtualConferenceDescriptor) object that takes a specified name, the list of URL descriptors, and conference details: ```swift // A descriptor that includes a title, a list of URL descriptors, and information about the conference. let virtualConferenceDescriptor = EKVirtualConferenceDescriptor(title: title, urlDescriptors: urlDescriptors, conferenceDetails: details) ``` ### Provide conference details After a person selects the personal room or one-time room from the list in the calendar event, the system calls the [`fetchVirtualConference(identifier:completionHandler:)`](/documentation/EventKit/EKVirtualConferenceProvider/fetchVirtualConference(identifier:completionHandler:)) method to fetch details about the room using its unique identifier. The sample project extension uses this identifier to determine which virtual conference descriptor to create and provide. For example, if the identifier identifies the personal room, the sample project extension creates and configures a virtual conference descriptor that includes a name, a URL for joining the conference, and a generic message about the conference. If the identifier identifies the one-time room, the sample project extension creates and configures a virtual conference descriptor that includes a name, a URL for joining the conference, a phone number for dialing in to the conference, and reading material for the conference. ```swift override func fetchVirtualConference(identifier: EKVirtualConferenceRoomTypeIdentifier) async throws -> EKVirtualConferenceDescriptor { let meetingID = UUID().uuidString.prefix(8).lowercased() // The identifier determines which conference the sample project extension sets up and returns. switch identifier { case "personal-room": let personalRoomDescriptor = createVirtualConferenceDescriptor(with: "Personal Room", url: URL(string: "https://www.personal.example.com/\(meetingID)")!, details: "Please join the meeting in my personal room.") return personalRoomDescriptor case "onetime-room": let details = "For the topic, see the documentation at https://developer.apple.com/documentation/eventkit/ekvirtualconferenceprovider" let oneTimeRoomDescriptor = createVirtualConferenceDescriptor(with: "One-Time Room", url: URL(string: "https://www.team.example.com/\(meetingID)")!, alternateURL: URL(string: "tel:1-408-555-0100"), details: details) return oneTimeRoomDescriptor // If the identifier is unknown, the sample project extension throws an error to indicate an invalid room. default: throw VirtualConferenceSampleError.invalidRoom(identifier) } } ``` --- Copyright © 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)