UIAccessibility.RequestGuidedAccessSession Method

Definition

Namespace:: UIKit

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Requests that the system enter or leave Guided Access mode.

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)]
public static void RequestGuidedAccessSession(bool enable, Action<bool> completionHandler);

[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)>]
static member RequestGuidedAccessSession : bool * Action<bool> -> unit

Parameters

enable: Boolean

true to enter Guided Access mode; false to leave it.

completionHandler: Action<Boolean>

A callback invoked when the transition completes, with a parameter indicating success.

Attributes: BindingImplAttribute

Remarks

When an application is running in Guided Access mode, it can prevent the home button from working, and can control other features of the operating system from working.

For this API call to succeed, the application must be Supervised, and the application must have been enabled for single app mode using Mobile Device Management.

Applies to