addPlan(request:properties:completionHandler:)
Starts the provisioning process with optional properties for the specified eSIM.
Declaration
func addPlan(request: CTCellularPlanProvisioningRequest, properties: CTCellularPlanProperties?, completionHandler: @escaping @Sendable (CTCellularPlanProvisioningAddPlanResult) -> Void)func addPlan(request: CTCellularPlanProvisioningRequest, properties: CTCellularPlanProperties?) async -> CTCellularPlanProvisioningAddPlanResultParameters
- request:
A Ctcellularplanprovisioningrequest that identifies the eSIM to download.
- properties:
An optional parameter for Ctcellularplanproperties. Use to specify the voice capability and region your eSIM supports.
- completionHandler:
A completion handler that executes after processing the request. The parameter passed to the completion handler indicates whether the request succeeded, failed, or ended in an unknown state.
Overview
Provide the system the information needed for the existing API to perform an install with a CTCellularPlanProvisioningRequest. By providing the request and properties object together, the system can pair the information together.
Once your app calls this method, an iOS wizard guides the person through the process of installing and configuration an eSIM.
The person may send your app to the background prior to completing eSIM installation. To ensure your app has an opportunity to execute the completion handler and get the result of the installation, use beginBackgroundTask(expirationHandler:) to perform the eSIM installation as a background task.