One Logo Pool Ball
Matter · IOS API REFERENCE

MTRSetupPayload

class · iOS 16.1+ · SDK 27.1

class MTRSetupPayload

Members (40)

static · iOS 16.1+ · Deprecated in iOS 18.4

generateRandomPIN

TypeScript
static generateRandomPIN(): number
Swift declaration
class func generateRandomPIN() -> Int
static · iOS 16.2+

generateRandomSetupPasscode

TypeScript
static generateRandomSetupPasscode(): _Foundation_NSNumber
Swift declaration
class func generateRandomSetupPasscode() -> NSNumber
static · iOS 18.4+

isValidSetupPasscode

TypeScript
static isValidSetupPasscode(setupPasscode: _Foundation_NSNumber): boolean
Swift declaration
class func isValidSetupPasscode(_ setupPasscode: NSNumber) -> Bool
static · iOS 16.1+ · Deprecated in iOS 16.4

new

TypeScript
static new(): MTRSetupPayload
Swift declaration
class func new() -> Self
init · iOS 16.2+ · Deprecated in iOS 17.6

init

TypeScript
static initOnboardingPayload(onboardingPayload: string): MTRSetupPayload
Swift declaration
init(onboardingPayload: String) throws
method · iOS 17.6+

addOrReplaceVendorElement

TypeScript
addOrReplaceVendorElement(element: MTROptionalQRCodeInfo): void
Swift declaration
func addOrReplaceVendorElement(_ element: MTROptionalQRCodeInfo)
method · iOS 16.1+ · Deprecated in iOS 17.6

getAllOptionalVendorData

TypeScript
getAllOptionalVendorData(): Array<MTROptionalQRCodeInfo>
Swift declaration
func getAllOptionalVendorData() throws -> [MTROptionalQRCodeInfo]
init · iOS 17.6+

init

TypeScript
static initPayload(payload: string): (MTRSetupPayload) | null
Swift declaration
init?(payload: String)
init · iOS 16.2+

init

TypeScript
static initSetupPasscodeDiscriminator(setupPasscode: _Foundation_NSNumber, discriminator: _Foundation_NSNumber): MTRSetupPayload
Swift declaration
init(setupPasscode: NSNumber, discriminator: NSNumber)
method · iOS 16.1+

manualEntryCode

TypeScript
manualEntryCode(): (string) | null
Swift declaration
func manualEntryCode() -> String?
method · iOS 17.6+

qrCodeString

TypeScript
qrCodeString(): (string) | null
Swift declaration
func qrCodeString() -> String?
method · iOS 16.2+ · Deprecated in iOS 17.6

qrCodeString

TypeScript
qrCodeString72627(): { $ret: (string) | null; $out: { "error": (_Foundation_NSError) | null } }
Swift declaration
func qrCodeString(_ error: NSErrorPointer) -> String?

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

method · iOS 17.6+

removeVendorElement

TypeScript
removeVendorElement(tag: _Foundation_NSNumber): void
Swift declaration
func removeVendorElement(withTag tag: NSNumber)
method · iOS 17.6+

vendorElement

TypeScript
vendorElement(tag: _Foundation_NSNumber): (MTROptionalQRCodeInfo) | null
Swift declaration
func vendorElement(withTag tag: NSNumber) -> MTROptionalQRCodeInfo?
get · iOS 16.1+

commissioningFlow

TypeScript
get commissioningFlow(): MTRCommissioningFlow
Swift declaration
var commissioningFlow: MTRCommissioningFlow { get set }
set · iOS 16.1+

commissioningFlow

TypeScript
set commissioningFlow(value: MTRCommissioningFlow)
Swift declaration
var commissioningFlow: MTRCommissioningFlow { get set }
get · iOS 26.2+

isConcatenated

TypeScript
get isConcatenated(): boolean
Swift declaration
var isConcatenated: Bool { get }
get · iOS 16.4+

discoveryCapabilities

TypeScript
get discoveryCapabilities(): MTRDiscoveryCapabilities
Swift declaration
var discoveryCapabilities: MTRDiscoveryCapabilities { get set }
set · iOS 16.4+

discoveryCapabilities

TypeScript
set discoveryCapabilities(value: MTRDiscoveryCapabilities)
Swift declaration
var discoveryCapabilities: MTRDiscoveryCapabilities { get set }
get · iOS 16.1+

discriminator

TypeScript
get discriminator(): _Foundation_NSNumber
Swift declaration
@NSCopying var discriminator: NSNumber { get set }
set · iOS 16.1+

discriminator

TypeScript
set discriminator(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var discriminator: NSNumber { get set }
get · iOS 16.1+

hasShortDiscriminator

TypeScript
get hasShortDiscriminator(): boolean
Swift declaration
var hasShortDiscriminator: Bool { get set }
set · iOS 16.1+

hasShortDiscriminator

TypeScript
set hasShortDiscriminator(value: boolean)
Swift declaration
var hasShortDiscriminator: Bool { get set }
get · iOS 16.1+

productID

TypeScript
get productID(): _Foundation_NSNumber
Swift declaration
@NSCopying var productID: NSNumber { get set }
set · iOS 16.1+

productID

TypeScript
set productID(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var productID: NSNumber { get set }
get · iOS 16.1+ · Deprecated in iOS 16.4

rendezvousInformation

TypeScript
get rendezvousInformation(): (_Foundation_NSNumber) | null
Swift declaration
@NSCopying var rendezvousInformation: NSNumber? { get set }
set · iOS 16.1+ · Deprecated in iOS 16.4

rendezvousInformation

TypeScript
set rendezvousInformation(value: (_Foundation_NSNumber) | null)
Swift declaration
@NSCopying var rendezvousInformation: NSNumber? { get set }
get · iOS 16.1+

serialNumber

TypeScript
get serialNumber(): (string) | null
Swift declaration
var serialNumber: String? { get set }
set · iOS 16.1+

serialNumber

TypeScript
set serialNumber(value: (string) | null)
Swift declaration
var serialNumber: String? { get set }
get · iOS 16.1+ · Deprecated in iOS 16.4

setUpPINCode

TypeScript
get setUpPINCode(): _Foundation_NSNumber
Swift declaration
@NSCopying var setUpPINCode: NSNumber { get set }
set · iOS 16.1+ · Deprecated in iOS 16.4

setUpPINCode

TypeScript
set setUpPINCode(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var setUpPINCode: NSNumber { get set }
get · iOS 16.4+

setupPasscode

TypeScript
get setupPasscode(): _Foundation_NSNumber
Swift declaration
@NSCopying var setupPasscode: NSNumber { get set }
set · iOS 16.4+

setupPasscode

TypeScript
set setupPasscode(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var setupPasscode: NSNumber { get set }
get · iOS 26.2+

subPayloads

TypeScript
get subPayloads(): Array<MTRSetupPayload>
Swift declaration
var subPayloads: [MTRSetupPayload] { get set }
set · iOS 26.2+

subPayloads

TypeScript
set subPayloads(value: Array<MTRSetupPayload>)
Swift declaration
var subPayloads: [MTRSetupPayload] { get set }
get · iOS 17.6+

vendorElements

TypeScript
get vendorElements(): Array<MTROptionalQRCodeInfo>
Swift declaration
var vendorElements: [MTROptionalQRCodeInfo] { get }
get · iOS 16.1+

vendorID

TypeScript
get vendorID(): _Foundation_NSNumber
Swift declaration
@NSCopying var vendorID: NSNumber { get set }
set · iOS 16.1+

vendorID

TypeScript
set vendorID(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var vendorID: NSNumber { get set }
get · iOS 16.1+

version

TypeScript
get version(): _Foundation_NSNumber
Swift declaration
@NSCopying var version: NSNumber { get set }
set · iOS 16.1+

version

TypeScript
set version(value: _Foundation_NSNumber)
Swift declaration
@NSCopying var version: NSNumber { get set }

Skipped declarations

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

MTRSetupPayload.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

All Matter types →