One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterAdministratorCommissioning

class · iOS 16.1+ · SDK 27.1

class MTRClusterAdministratorCommissioning

Members (18)

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript
static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterAdministratorCommissioning) | 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): (MTRClusterAdministratorCommissioning) | null
Swift declaration
init?(device: MTRDevice, endpointID: NSNumber, queue: dispatch_queue_t)
method · iOS 16.4+

openBasicCommissioningWindow

TypeScript
openBasicCommissioningWindowWithExpectedValuesExpectedValueIntervalCompletion(params: MTRAdministratorCommissioningClusterOpenBasicCommissioningWindowParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func openBasicCommissioningWindow(with params: MTRAdministratorCommissioningClusterOpenBasicCommissioningWindowParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

openBasicCommissioningWindow

TypeScript
openBasicCommissioningWindowWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRAdministratorCommissioningClusterOpenBasicCommissioningWindowParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func openBasicCommissioningWindow(with params: MTRAdministratorCommissioningClusterOpenBasicCommissioningWindowParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

openWindow

TypeScript
openWindowWithExpectedValuesExpectedValueIntervalCompletion(params: MTRAdministratorCommissioningClusterOpenCommissioningWindowParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func openWindow(with params: MTRAdministratorCommissioningClusterOpenCommissioningWindowParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

openWindow

TypeScript
openWindowWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRAdministratorCommissioningClusterOpenCommissioningWindowParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func openWindow(with params: MTRAdministratorCommissioningClusterOpenCommissioningWindowParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
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+

readAttributeAdminFabricIndex

TypeScript
readAttributeAdminFabricIndex(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAdminFabricIndex(with params: MTRReadParams?) -> [String : Any]?
method · iOS 16.1+

readAttributeAdminVendorId

TypeScript
readAttributeAdminVendorId(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAdminVendorId(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+

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+

readAttributeWindowStatus

TypeScript
readAttributeWindowStatus(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeWindowStatus(with params: MTRReadParams?) -> [String : Any]?
method · iOS 16.4+

revokeCommissioning

TypeScript
revokeCommissioningWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func revokeCommissioning(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

revokeCommissioning

TypeScript
revokeCommissioningWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func revokeCommissioning(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

revokeCommissioning

TypeScript
revokeCommissioningWithExpectedValuesExpectedValueIntervalCompletion93650(params: (MTRAdministratorCommissioningClusterRevokeCommissioningParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func revokeCommissioning(with params: MTRAdministratorCommissioningClusterRevokeCommissioningParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

revokeCommissioning

TypeScript
revokeCommissioningWithExpectedValuesExpectedValueIntervalCompletionHandler87022(params: (MTRAdministratorCommissioningClusterRevokeCommissioningParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func revokeCommissioning(with params: MTRAdministratorCommissioningClusterRevokeCommissioningParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

Skipped declarations

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

MTRClusterAdministratorCommissioning.init()

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

All Matter types →