Matter · IOS API REFERENCE

MTRClusterNetworkCommissioning

class · iOS 16.1+ · SDK 27.1

class MTRClusterNetworkCommissioning

Members (33)

method · iOS 16.4+

addOrUpdateThreadNetwork

TypeScript

addOrUpdateThreadNetworkWithExpectedValuesExpectedValueIntervalCompletion(params: MTRNetworkCommissioningClusterAddOrUpdateThreadNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addOrUpdateThreadNetwork(with params: MTRNetworkCommissioningClusterAddOrUpdateThreadNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

addOrUpdateThreadNetwork

TypeScript

addOrUpdateThreadNetworkWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRNetworkCommissioningClusterAddOrUpdateThreadNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addOrUpdateThreadNetwork(with params: MTRNetworkCommissioningClusterAddOrUpdateThreadNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.4+

addOrUpdateWiFiNetwork

TypeScript

addOrUpdateWiFiNetworkWithExpectedValuesExpectedValueIntervalCompletion(params: MTRNetworkCommissioningClusterAddOrUpdateWiFiNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addOrUpdateWiFiNetwork(with params: MTRNetworkCommissioningClusterAddOrUpdateWiFiNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

addOrUpdateWiFiNetwork

TypeScript

addOrUpdateWiFiNetworkWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRNetworkCommissioningClusterAddOrUpdateWiFiNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addOrUpdateWiFiNetwork(with params: MTRNetworkCommissioningClusterAddOrUpdateWiFiNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.4+

connectNetwork

TypeScript

connectNetworkWithExpectedValuesExpectedValueIntervalCompletion(params: MTRNetworkCommissioningClusterConnectNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterConnectNetworkResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func connectNetwork(with params: MTRNetworkCommissioningClusterConnectNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterConnectNetworkResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

connectNetwork

TypeScript

connectNetworkWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRNetworkCommissioningClusterConnectNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterConnectNetworkResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func connectNetwork(with params: MTRNetworkCommissioningClusterConnectNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterConnectNetworkResponseParams

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterNetworkCommissioning) | 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): (MTRClusterNetworkCommissioning) | 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+

readAttributeClusterRevision

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeConnectMaxTimeSeconds

TypeScript

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

Swift declaration

func readAttributeConnectMaxTimeSeconds(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+

readAttributeInterfaceEnabled

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeLastConnectErrorValue

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeLastNetworkID

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeLastNetworkingStatus

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeMaxNetworks

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeNetworks

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeScanMaxTimeSeconds

TypeScript

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

Swift declaration

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

method · iOS 18.4+

readAttributeSupportedThreadFeatures

TypeScript

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

Swift declaration

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

method · iOS 18.4+

readAttributeSupportedWiFiBands

TypeScript

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

Swift declaration

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

method · iOS 18.4+

readAttributeThreadVersion

TypeScript

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

Swift declaration

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

method · iOS 16.4+

removeNetwork

TypeScript

removeNetworkWithExpectedValuesExpectedValueIntervalCompletion(params: MTRNetworkCommissioningClusterRemoveNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func removeNetwork(with params: MTRNetworkCommissioningClusterRemoveNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

removeNetwork

TypeScript

removeNetworkWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRNetworkCommissioningClusterRemoveNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func removeNetwork(with params: MTRNetworkCommissioningClusterRemoveNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.4+

reorderNetwork

TypeScript

reorderNetworkWithExpectedValuesExpectedValueIntervalCompletion(params: MTRNetworkCommissioningClusterReorderNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func reorderNetwork(with params: MTRNetworkCommissioningClusterReorderNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

reorderNetwork

TypeScript

reorderNetworkWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRNetworkCommissioningClusterReorderNetworkParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterNetworkConfigResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func reorderNetwork(with params: MTRNetworkCommissioningClusterReorderNetworkParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterNetworkConfigResponseParams

method · iOS 17.4+

scanNetworks

TypeScript

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

Swift declaration

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

method · iOS 16.4+

scanNetworks

TypeScript

scanNetworksWithExpectedValuesExpectedValueIntervalCompletion49554(params: (MTRNetworkCommissioningClusterScanNetworksParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRNetworkCommissioningClusterScanNetworksResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func scanNetworks(with params: MTRNetworkCommissioningClusterScanNetworksParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterScanNetworksResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

scanNetworks

TypeScript

scanNetworksWithExpectedValuesExpectedValueIntervalCompletionHandler(params: (MTRNetworkCommissioningClusterScanNetworksParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRNetworkCommissioningClusterScanNetworksResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func scanNetworks(with params: MTRNetworkCommissioningClusterScanNetworksParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRNetworkCommissioningClusterScanNetworksResponseParams

method · iOS 16.1+

writeAttributeInterfaceEnabled

TypeScript

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

Swift declaration

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

method · iOS 16.1+

writeAttributeInterfaceEnabled

TypeScript

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

Swift declaration

func writeAttributeInterfaceEnabled(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.

MTRClusterNetworkCommissioning.init()

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

All Matter types →