Matter · IOS API REFERENCE

MTRClusterGeneralCommissioning

class · iOS 16.1+ · SDK 27.1

class MTRClusterGeneralCommissioning

Members (22)

method · iOS 16.4+

armFailSafe

TypeScript

armFailSafeWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGeneralCommissioningClusterArmFailSafeParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGeneralCommissioningClusterArmFailSafeResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func armFailSafe(with params: MTRGeneralCommissioningClusterArmFailSafeParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterArmFailSafeResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

armFailSafe

TypeScript

armFailSafeWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGeneralCommissioningClusterArmFailSafeParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGeneralCommissioningClusterArmFailSafeResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func armFailSafe(with params: MTRGeneralCommissioningClusterArmFailSafeParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterArmFailSafeResponseParams

method · iOS 16.4+

commissioningComplete

TypeScript

commissioningCompleteWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGeneralCommissioningClusterCommissioningCompleteResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func commissioningComplete(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterCommissioningCompleteResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

commissioningComplete

TypeScript

commissioningCompleteWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGeneralCommissioningClusterCommissioningCompleteResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func commissioningComplete(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterCommissioningCompleteResponseParams

method · iOS 16.4+

commissioningComplete

TypeScript

commissioningCompleteWithExpectedValuesExpectedValueIntervalCompletion45818(params: (MTRGeneralCommissioningClusterCommissioningCompleteParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGeneralCommissioningClusterCommissioningCompleteResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func commissioningComplete(with params: MTRGeneralCommissioningClusterCommissioningCompleteParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterCommissioningCompleteResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

commissioningComplete

TypeScript

commissioningCompleteWithExpectedValuesExpectedValueIntervalCompletionHandler11542(params: (MTRGeneralCommissioningClusterCommissioningCompleteParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGeneralCommissioningClusterCommissioningCompleteResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func commissioningComplete(with params: MTRGeneralCommissioningClusterCommissioningCompleteParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterCommissioningCompleteResponseParams

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterGeneralCommissioning) | null

Swift declaration

init?(device: MTRDevice, endpoint: UInt16, queue: dispatch_queue_t)

init · iOS 16.4+

init

TypeScript

static initDeviceEndpointIDQueue(device: MTRDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRClusterGeneralCommissioning) | null

Swift declaration

init?(device: MTRDevice, endpointID: NSNumber, queue: dispatch_queue_t)

method · iOS 16.1+

readAttributeAcceptedCommandList

TypeScript

readAttributeAcceptedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeAcceptedCommandList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeAttributeList

TypeScript

readAttributeAttributeList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeAttributeList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeBasicCommissioningInfo

TypeScript

readAttributeBasicCommissioningInfo(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeBasicCommissioningInfo(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeBreadcrumb

TypeScript

readAttributeBreadcrumb(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeBreadcrumb(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeClusterRevision

TypeScript

readAttributeClusterRevision(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeClusterRevision(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeFeatureMap

TypeScript

readAttributeFeatureMap(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeFeatureMap(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeGeneratedCommandList

TypeScript

readAttributeGeneratedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeGeneratedCommandList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeLocationCapability

TypeScript

readAttributeLocationCapability(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeLocationCapability(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeRegulatoryConfig

TypeScript

readAttributeRegulatoryConfig(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeRegulatoryConfig(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeSupportsConcurrentConnection

TypeScript

readAttributeSupportsConcurrentConnection(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeSupportsConcurrentConnection(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.4+

setRegulatoryConfigWith

TypeScript

setRegulatoryConfigWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGeneralCommissioningClusterSetRegulatoryConfigParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGeneralCommissioningClusterSetRegulatoryConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func setRegulatoryConfigWith(_ params: MTRGeneralCommissioningClusterSetRegulatoryConfigParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterSetRegulatoryConfigResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

setRegulatoryConfigWith

TypeScript

setRegulatoryConfigWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGeneralCommissioningClusterSetRegulatoryConfigParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGeneralCommissioningClusterSetRegulatoryConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func setRegulatoryConfigWith(_ params: MTRGeneralCommissioningClusterSetRegulatoryConfigParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralCommissioningClusterSetRegulatoryConfigResponseParams

method · iOS 16.1+

writeAttributeBreadcrumb

TypeScript

writeAttributeBreadcrumbWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void

Swift declaration

func writeAttributeBreadcrumb(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)

method · iOS 16.1+

writeAttributeBreadcrumb

TypeScript

writeAttributeBreadcrumbWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void

Swift declaration

func writeAttributeBreadcrumb(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)

Skipped declarations

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

MTRClusterGeneralCommissioning.init()

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

All Matter types →