Protocol

UIGuidedAccessRestrictionDelegate

A set of methods you use to add custom restrictions for the Guided Access feature in iOS.

Declaration

@protocol UIGuidedAccessRestrictionDelegate

Overview

Custom restrictions are represented by string identifiers provided by the developer in the guidedAccessRestrictionIdentifiers method. Each identifier represents an operation in the app that the developer wishes to allow users to restrict using Guided Access. The default for all operations is allow. Users can deny operations using the normal Guided Access user interface. See http://support.apple.com/kb/HT5509 for a description of how to enable and configure Guided Access on iOS.

Apps describe their custom restrictions by implementing the textForGuidedAccessRestrictionWithIdentifier: and detailTextForGuidedAccessRestrictionWithIdentifier: methods to return appropriate localized, human-readable strings.

For example, a photo editing app might allow users to disable deleting photos. The app would return an identifier representing this restriction in its guidedAccessRestrictionIdentifiers method. It would also implement textForGuidedAccessRestrictionWithIdentifier: to provide a human-readable description of the restriction. Finally, the app would implement guidedAccessRestrictionWithIdentifier:didChangeState: to notice when a user indicates that they want to enable the restriction. When the app sees the state change to “deny”, it would configure itself to prevent the deletion of photos by any means. Similarly, when the app sees the state change to “allow”, it would configure itself to allow photo deletion.

Apps can use the UIGuidedAccessRestrictionStateForIdentifier function to check the state of a restriction at any time.

Topics

Identifying Custom Guided Access Restrictions

guidedAccessRestrictionIdentifiers

Returns an array of strings identifying custom restrictions.

Required.

- textForGuidedAccessRestrictionWithIdentifier:

Returns a succinct description of the restriction for the provided identifier.

Required.

- detailTextForGuidedAccessRestrictionWithIdentifier:

Returns more detailed information about the restriction for the provided identifier.

Implementing Restrictions

- guidedAccessRestrictionWithIdentifier:didChangeState:

Tells the delegate that the restriction associated with the identifier has changed state.

Required.

Constants

UIGuidedAccessRestrictionState

The state of a restriction, either allow or deny.

Relationships

Inherits From

See Also

Guided Access

UIGuidedAccessRestrictionStateForIdentifier

Returns the restriction state for the specified guided access restriction.