One Logo Pool Ball
ManagedSettingsUI · IOS API REFERENCE

ShieldConfiguration

struct · iOS 15.0+ · SDK 27.1

struct ShieldConfiguration

An object that defines the appearance of a shield to display over an application or website. The system provides a default appearance for any properties you set to `nil`.

Members (11)

get · iOS 15.0+

backgroundColor

TypeScript
get backgroundColor(): (_UIKit_UIColor) | null
Swift declaration
let backgroundColor: UIColor?

A color for a shield to use in the background blur effect.

get · iOS 15.0+

primaryButtonLabel

TypeScript
get primaryButtonLabel(): (ShieldConfiguration_Label) | null
Swift declaration
let primaryButtonLabel: ShieldConfiguration.Label?

The label of the topmost rounded rectangle button.

init · iOS 26.4+

init

TypeScript
static initBackgroundBlurStyleBackgroundColorIconTitleSubtitlePrimaryButtonLabelPrimaryButtonBackgroundColorSecondaryButtonLabelSecondaryButtonSubmenuItems(backgroundBlurStyle?: (_UIKit_UIBlurEffect_Style) | null, backgroundColor?: (_UIKit_UIColor) | null, icon?: (_UIKit_UIImage) | null, title?: (ShieldConfiguration_Label) | null, subtitle?: (ShieldConfiguration_Label) | null, primaryButtonLabel?: (ShieldConfiguration_Label) | null, primaryButtonBackgroundColor?: (_UIKit_UIColor) | null, secondaryButtonLabel?: (ShieldConfiguration_Label) | null, secondaryButtonSubmenuItems?: (Array<string>) | null): ShieldConfiguration
Swift declaration
init(backgroundBlurStyle: UIBlurEffect.Style? = nil, backgroundColor: UIColor? = nil, icon: UIImage? = nil, title: ShieldConfiguration.Label? = nil, subtitle: ShieldConfiguration.Label? = nil, primaryButtonLabel: ShieldConfiguration.Label? = nil, primaryButtonBackgroundColor: UIColor? = nil, secondaryButtonLabel: ShieldConfiguration.Label? = nil, secondaryButtonSubmenuItems: [String]? = nil)

Creates a shield configuration with the specified values. The system provides a default for any options that you don't specify. - Parameters: - backgroundBlurStyle: A blur style to apply to the `backgroundColor`. - backgroundColor: A color to display in the shield's background. - icon: An icon to display on the shield. - title: A title for the shield. - subtitle: Additional text to display on the shield. - primaryButtonLabel: A label for the shield's main button. - primaryButtonBackgroundColor: A background color for the shield's main button. - secondaryButtonLabel: An additional button to display on the shield. - secondaryButtonSubmenuItems: List of items to display in the sub menu after selecting the secondary button

init · iOS 15.0+

init

TypeScript
static initBackgroundBlurStyleBackgroundColorIconTitleSubtitlePrimaryButtonLabelPrimaryButtonBackgroundColorSecondaryButtonLabel(backgroundBlurStyle?: (_UIKit_UIBlurEffect_Style) | null, backgroundColor?: (_UIKit_UIColor) | null, icon?: (_UIKit_UIImage) | null, title?: (ShieldConfiguration_Label) | null, subtitle?: (ShieldConfiguration_Label) | null, primaryButtonLabel?: (ShieldConfiguration_Label) | null, primaryButtonBackgroundColor?: (_UIKit_UIColor) | null, secondaryButtonLabel?: (ShieldConfiguration_Label) | null): ShieldConfiguration
Swift declaration
init(backgroundBlurStyle: UIBlurEffect.Style? = nil, backgroundColor: UIColor? = nil, icon: UIImage? = nil, title: ShieldConfiguration.Label? = nil, subtitle: ShieldConfiguration.Label? = nil, primaryButtonLabel: ShieldConfiguration.Label? = nil, primaryButtonBackgroundColor: UIColor? = nil, secondaryButtonLabel: ShieldConfiguration.Label? = nil)

Creates a shield configuration with the specified values. The system provides a default for any options that you don't specify. - Parameters: - backgroundBlurStyle: A blur style to apply to the `backgroundColor`. - backgroundColor: A color to display in the shield's background. - icon: An icon to display on the shield. - title: A title for the shield. - subtitle: Additional text to display on the shield. - primaryButtonLabel: A label for the shield's main button. - primaryButtonBackgroundColor: A background color for the shield's main button. - secondaryButtonLabel: An additional button to display on the shield.

get · iOS 15.0+

backgroundBlurStyle

TypeScript
get backgroundBlurStyle(): (_UIKit_UIBlurEffect_Style) | null
Swift declaration
let backgroundBlurStyle: UIBlurEffect.Style?

A blur style to apply to the background of the shield.

get · iOS 15.0+

secondaryButtonLabel

TypeScript
get secondaryButtonLabel(): (ShieldConfiguration_Label) | null
Swift declaration
let secondaryButtonLabel: ShieldConfiguration.Label?

The label of the optional secondary button. Unlike the primary button, this button is borderless and has no background. If this is `nil`, then the shield doesn't have a secondary button.

get · iOS 26.4+

secondaryButtonSubmenuItems

TypeScript
get secondaryButtonSubmenuItems(): (Array<string>) | null
Swift declaration
let secondaryButtonSubmenuItems: [String]?
get · iOS 15.0+

primaryButtonBackgroundColor

TypeScript
get primaryButtonBackgroundColor(): (_UIKit_UIColor) | null
Swift declaration
let primaryButtonBackgroundColor: UIColor?

The color to fill the contents of the rounded rectangle primary button.

get · iOS 15.0+

icon

TypeScript
get icon(): (_UIKit_UIImage) | null
Swift declaration
let icon: UIImage?

An icon to display in the center of the shield.

get · iOS 15.0+

title

TypeScript
get title(): (ShieldConfiguration_Label) | null
Swift declaration
let title: ShieldConfiguration.Label?

The title of the shield to display below the icon.

get · iOS 15.0+

subtitle

TypeScript
get subtitle(): (ShieldConfiguration_Label) | null
Swift declaration
let subtitle: ShieldConfiguration.Label?

The subtitle for a shield to display below the title. Use a `subtitle` to provide more information, such as the reason for shielding the content.

Skipped declarations

No declarations were skipped in this snapshot.

All ManagedSettingsUI types →