ManagedSettings · IOS API REFERENCE

ManagedSettingsStore

class · iOS 15.0+ · SDK 27.1

class ManagedSettingsStore

A data store that applies settings to the current user or device. The Managed Settings data store groups settings according to function. Each group contains relevant data about its associated settings, for example, a default value and minimum and maximum possible values. ### Configure Settings Use the settings objects to inspect your application's current configurations as well as apply new configurations. Changing the value of a setting to `nil` deletes your app's configuration for that setting from the device. The system doesn't guarantee that the settings you specify govern the device's behavior. The system is responsible for determining its effective state based on all the settings it receives. ### Examine Effective Settings In a few cases, you can also access the effective settings. For example, a media app can access the effective rating settings to filter the content it offers, even though it doesn't provide configurations for these or any other settings. Subscribe to ``ManagedSettingsStore/$effectiveMaximumTVShowRating`` or ``ManagedSettingsStore/$effectiveMaximumMovieRating`` to determine what TV shows or movies to offer.

Members (41)

get · iOS 15.0+

appStore

TypeScript

get appStore(): AppStoreSettings

Swift declaration

var appStore: AppStoreSettings

Settings that affect the App Store.

set · iOS 15.0+

appStore

TypeScript

set appStore(value: AppStoreSettings)

Swift declaration

var appStore: AppStoreSettings

Settings that affect the App Store.

method · iOS 26.5+

deleteStore

TypeScript

deleteStore(): void

Swift declaration

func deleteStore()

Deletes this store

method · iOS 16.0+

clearAllSettings

TypeScript

clearAllSettings(): void

Swift declaration

func clearAllSettings()

Clears all settings for this store.

get · iOS 15.0+

gameCenter

TypeScript

get gameCenter(): GameCenterSettings

Swift declaration

var gameCenter: GameCenterSettings

Settings that affect Game Center.

set · iOS 15.0+

gameCenter

TypeScript

set gameCenter(value: GameCenterSettings)

Swift declaration

var gameCenter: GameCenterSettings

Settings that affect Game Center.

get · iOS 15.0+

webContent

TypeScript

get webContent(): WebContentSettings

Swift declaration

var webContent: WebContentSettings

Settings that affect web content.

set · iOS 15.0+

webContent

TypeScript

set webContent(value: WebContentSettings)

Swift declaration

var webContent: WebContentSettings

Settings that affect web content.

get · iOS 15.0+

application

TypeScript

get application(): ApplicationSettings

Swift declaration

var application: ApplicationSettings

Settings that affect applications.

set · iOS 15.0+

application

TypeScript

set application(value: ApplicationSettings)

Swift declaration

var application: ApplicationSettings

Settings that affect applications.

get · iOS 15.0+

dateAndTime

TypeScript

get dateAndTime(): DateAndTimeSettings

Swift declaration

var dateAndTime: DateAndTimeSettings

Settings that affect the date and time.

set · iOS 15.0+

dateAndTime

TypeScript

set dateAndTime(value: DateAndTimeSettings)

Swift declaration

var dateAndTime: DateAndTimeSettings

Settings that affect the date and time.

static · iOS 26.5+

deleteStores

TypeScript

static deleteStores(storeNames: Array<ManagedSettingsStore_Name>): void

Swift declaration

static func deleteStores(_ storeNames: Set<ManagedSettingsStore.Name>)

Deletes the given stores configured by your app if they exist - Parameters: - storeNames: The names of the stores to delete

get · iOS 15.0+

effectiveMaximumMovieRating

TypeScript

get effectiveMaximumMovieRating(): number

Swift declaration

@Published<Int> var effectiveMaximumMovieRating: Int { get }

The movie rating constraint that is active on this device. An authorized app can use the Family Controls framework to apply a ``MediaSettings/maximumMovieRating-swift.property`` to the device. If no `maximumMovieRating` settings are active, then the value of this property is the default value of ``MediaSettings/maximumMovieRating-swift.type.property``. The system publishes changes dynamically.

get · iOS 15.0+

$effectiveMaximumMovieRating

TypeScript

get $effectiveMaximumMovieRating(): _Combine_Published_Publisher<number>

Swift declaration

var $effectiveMaximumMovieRating: Published<Int>.Publisher { get }

get · iOS 26.0+

effectiveDenyExplicitContent

TypeScript

get effectiveDenyExplicitContent(): boolean

Swift declaration

@Published<Bool> var effectiveDenyExplicitContent: Bool { get }

The deny explicit content constraint that is active on this device. An authorized app can query whether or not explicit content is allowed on the device.

get · iOS 15.0+

effectiveMaximumTVShowRating

TypeScript

get effectiveMaximumTVShowRating(): number

Swift declaration

@Published<Int> var effectiveMaximumTVShowRating: Int { get }

The TV rating constraint that is active on this device. An authorized app can use the Family Controls framework to apply a ``MediaSettings/maximumTVShowRating-swift.property`` to the device. If no `maximumTVShowRating` settings are active, then the value of this property is the default value of ``MediaSettings/maximumTVShowRating-swift.type.property``. The system publishes changes dynamically.

get · iOS 15.0+

$effectiveDenyExplicitContent

TypeScript

get $effectiveDenyExplicitContent(): _Combine_Published_Publisher<boolean>

Swift declaration

var $effectiveDenyExplicitContent: Published<Bool>.Publisher { get }

get · iOS 15.0+

$effectiveMaximumTVShowRating

TypeScript

get $effectiveMaximumTVShowRating(): _Combine_Published_Publisher<number>

Swift declaration

var $effectiveMaximumTVShowRating: Published<Int>.Publisher { get }

get · iOS 15.0+

siri

TypeScript

get siri(): SiriSettings

Swift declaration

var siri: SiriSettings

Settings that affect Siri.

set · iOS 15.0+

siri

TypeScript

set siri(value: SiriSettings)

Swift declaration

var siri: SiriSettings

Settings that affect Siri.

get · iOS 15.0+

media

TypeScript

get media(): MediaSettings

Swift declaration

var media: MediaSettings

Settings that affect media.

set · iOS 15.0+

media

TypeScript

set media(value: MediaSettings)

Swift declaration

var media: MediaSettings

Settings that affect media.

init · iOS 16.0+

init

TypeScript

static initNamed(name: ManagedSettingsStore_Name): ManagedSettingsStore

Swift declaration

convenience init(named name: ManagedSettingsStore.Name)

Creates a new instance of a store with a custom name. - Parameters: - name: A unique name for the store. Each store contains the settings that the client app applies. If the client app doesn't explicitly apply a setting, the default value is `nil`. Using `.default` is akin to calling `ManagedSettingsStore()`.

get · iOS 15.0+

safari

TypeScript

get safari(): SafariSettings

Swift declaration

var safari: SafariSettings

Settings that affect Safari's search results and cookie policies.

set · iOS 15.0+

safari

TypeScript

set safari(value: SafariSettings)

Swift declaration

var safari: SafariSettings

Settings that affect Safari's search results and cookie policies.

get · iOS 15.0+

shield

TypeScript

get shield(): ShieldSettings

Swift declaration

var shield: ShieldSettings

Settings that affect what activities the system covers with a shielding view on this device.

set · iOS 15.0+

shield

TypeScript

set shield(value: ShieldSettings)

Swift declaration

var shield: ShieldSettings

Settings that affect what activities the system covers with a shielding view on this device.

get · iOS 26.5+

stores

TypeScript

static get stores(): Array<ManagedSettingsStore_Name>

Swift declaration

static var stores: Set<ManagedSettingsStore.Name> { get }

Get the name of all the stores configured by your app

get · iOS 15.0+

account

TypeScript

get account(): AccountSettings

Swift declaration

var account: AccountSettings

Settings that affect accounts.

set · iOS 15.0+

account

TypeScript

set account(value: AccountSettings)

Swift declaration

var account: AccountSettings

Settings that affect accounts.

static · iOS 26.5+

refresh

TypeScript

static refresh(tokens: Array<Token<Application>>): { $ret: null; $out: { "tokens": Array<Token<Application>> } }

Swift declaration

static func refresh(_ tokens: inout [ApplicationToken]) throws

Refresh expired ApplicationTokens - Parameters: - tokens: The application tokens to refresh

Omit the output parameters from the call. The result contains $ret and $out, with tokens inside $out.

static · iOS 26.5+

refresh

TypeScript

static refresh97087(tokens: Array<Token<ActivityCategory>>): { $ret: null; $out: { "tokens": Array<Token<ActivityCategory>> } }

Swift declaration

static func refresh(_ tokens: inout [ActivityCategoryToken]) throws

Refresh expired ActivityCategoryTokens - Parameters: - tokens: The activity category tokens to refresh

Omit the output parameters from the call. The result contains $ret and $out, with tokens inside $out.

static · iOS 26.5+

refresh

TypeScript

static refresh85832(tokens: Array<Token<WebDomain>>): { $ret: null; $out: { "tokens": Array<Token<WebDomain>> } }

Swift declaration

static func refresh(_ tokens: inout [WebDomainToken]) throws

Refresh expired WebDomainTokens - Parameters: - tokens: The web domain tokens to refresh

Omit the output parameters from the call. The result contains $ret and $out, with tokens inside $out.

get · iOS 15.0+

cellular

TypeScript

get cellular(): CellularSettings

Swift declaration

var cellular: CellularSettings

Settings that affect cellular networking.

set · iOS 15.0+

cellular

TypeScript

set cellular(value: CellularSettings)

Swift declaration

var cellular: CellularSettings

Settings that affect cellular networking.

get · iOS 26.5+

isActive

TypeScript

get isActive(): boolean

Swift declaration

var isActive: Bool { get set }

Property that controls whether the store is active An inactive store is not included in the effective settings calculation. Defaults to true.

set · iOS 26.5+

isActive

TypeScript

set isActive(value: boolean)

Swift declaration

var isActive: Bool { get set }

Property that controls whether the store is active An inactive store is not included in the effective settings calculation. Defaults to true.

get · iOS 15.0+

passcode

TypeScript

get passcode(): PasscodeSettings

Swift declaration

var passcode: PasscodeSettings

Settings that affect the device passcode.

set · iOS 15.0+

passcode

TypeScript

set passcode(value: PasscodeSettings)

Swift declaration

var passcode: PasscodeSettings

Settings that affect the device passcode.

init · iOS 15.0+

init

TypeScript

static init(): ManagedSettingsStore

Swift declaration

init()

Creates a new instance of a store. Each store contains the settings that the client app applies. If the client app doesn't explicitly apply a setting, the default value is `nil`.

Skipped declarations

No declarations were skipped in this snapshot.

All ManagedSettings types →