RealityFoundation · IOS API REFERENCE

Entity.ConfigurationCatalog.ConfigurationSet

struct · iOS 18.0+ · SDK 27.1

struct ConfigurationSet

A collection of alternatives to choose from. For example, a configuration set might contain configurations named `small`, `medium`, and `big` to represent a choice of sizes.

Members (5)

get · iOS 18.0+

defaultConfiguration

TypeScript

get defaultConfiguration(): Promise<Entity_ConfigurationCatalog_Configuration>

Swift declaration

var defaultConfiguration: Entity.ConfigurationCatalog.Configuration { get }

The default configuration, if you don't explicitly set one.

get · iOS 18.0+

configurations

TypeScript

get configurations(): Promise<Record<string, Entity_ConfigurationCatalog_Configuration>>

Swift declaration

var configurations: [String : Entity.ConfigurationCatalog.Configuration] { get }

The alternative configurations that are available in a set. The keys are configuration IDs, and the values are the corresponding configurations.

init · iOS 18.0+

init

TypeScript

static initIdConfigurationsDefaultConfigurationId(id: string, configurations: Record<string, Entity_ConfigurationCatalog_Configuration>, defaultConfigurationId?: (string) | null): Promise<Entity_ConfigurationCatalog_ConfigurationSet>

Swift declaration

init(id: String, configurations: [String : Entity.ConfigurationCatalog.Configuration], defaultConfigurationId: String? = nil) throws

Creates a configuration set from an ID, a dictionary of configurations, and a default configuration ID. - Parameters: - id: The ID of the configuration set that's unique across all other configuration sets. - configurations: A dictionary of configurations you can choose from. Each key needs to match the ID of the configuration value it maps to. - defaultConfigurationId: The ID of one of the configuration elements in the `configurations` parameter, which is the default configuration the entity initializer applies if you don't choose a configuration from the set. - Returns: A configuration set containing the configurations.

init · iOS 18.0+

init

TypeScript

static initIdConfigurationsDefaultConfigurationId72167(id: string, configurations: Array<Entity_ConfigurationCatalog_Configuration>, defaultConfigurationId?: (string) | null): Promise<Entity_ConfigurationCatalog_ConfigurationSet>

Swift declaration

init(id: String, configurations: [Entity.ConfigurationCatalog.Configuration], defaultConfigurationId: String? = nil) throws

Creates a configuration set from an ID, an array of configurations, and a default configuration ID. - Parameters: - id: The ID of the configuration set that's unique across all other configuration sets. - configurations: An array of configurations you can choose from. The configuration set stores the array in the ``configurations`` property and doesn't preserve the order of the array. - defaultConfigurationId: The ID of one of the configuration elements in the `configurations` parameter, which is the default configuration the entity initializer applies if you don't choose a configuration from the set. - Returns: A configuration set containing the configurations.

get · iOS 18.0+

id

TypeScript

get id(): Promise<string>

Swift declaration

var id: String { get }

A name that identifies the configuration set.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →