WidgetKit · IOS API REFERENCE

WidgetInfo

struct · iOS 14.0+ · SDK 27.1

@preconcurrency struct WidgetInfo

A structure that contains information about user-configured widgets.

Members (5)

get · iOS 14.0+

configuration

TypeScript

get configuration(): (_Intents_INIntent) | null

Swift declaration

let configuration: INIntent?

A SiriKit intent that contains user-edited values.

get · iOS 14.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 14.0+

id

TypeScript

get id(): WidgetInfo

Swift declaration

var id: WidgetInfo { get }

The stable identity of the widget.

get · iOS 14.0+

kind

TypeScript

get kind(): string

Swift declaration

let kind: String

The string specified during creation of the widget's configuration.

get · iOS 14.0+

family

TypeScript

get family(): WidgetFamily

Swift declaration

let family: WidgetFamily

The size of the widget: small, medium, or large.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

WidgetInfo.widgetConfigurationIntent(of:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

All WidgetKit types →