Contents

requestGuidedAccessSession(enabled:completionHandler:)

Transitions the app to or from Single App mode asynchronously.

Declaration

@MainActor static func requestGuidedAccessSession(enabled enable: Bool, completionHandler: @escaping @MainActor @Sendable (Bool) -> Void)

Parameters

  • enable:

    Specify True to put the device into Single App mode for this app or False to exit Single App mode.

  • completionHandler:

    The block that notifies your app of the success or failure of the operation. This block takes the following parameter:

    didSucceed

    If True, the app transitioned to or from Single App mode successfully. If False, the app or device is not eligible for Single App mode or there was some other error.

Discussion

You can use this method to lock your app into Single App mode and to release it from that mode later. For example, a test-taking app might enter this mode at the beginning of a test and exit it when the user completes the test. Entering Single App mode is supported only for devices that are supervised using Mobile Device Management (MDM), and the app itself must be enabled for this mode by MDM. You must balance each call to enter Single App mode with a call to exit that mode.

Because entering or exiting Single App mode might take some time, this method executes asynchronously and notifies you of the results using the completionHandler block.

See Also

Convenience functions