One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterOnOff

class · iOS 16.1+ · SDK 27.1

class MTRClusterOnOff

Members (38)

init · iOS 16.1+ · Deprecated in iOS 16.4

init

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

offWithEffect

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

offWithEffect

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

off

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

off

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

off

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

off

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

on

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

on

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

on

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

on

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

onWithRecallGlobalScene

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

onWithRecallGlobalScene

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

onWithRecallGlobalScene

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

onWithRecallGlobalScene

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

onWithTimedOff

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

onWithTimedOff

TypeScript
onWithTimedOffWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTROnOffClusterOnWithTimedOffParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func onWithTimedOff(with params: MTROnOffClusterOnWithTimedOffParams, 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+

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+

readAttributeGlobalSceneControl

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

readAttributeOffWaitTime

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

readAttributeOnOff

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

readAttributeOnTime

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

readAttributeStartUp

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

toggle

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

toggle

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

toggle

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

toggle

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

writeAttributeOffWaitTime

TypeScript
writeAttributeOffWaitTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOffWaitTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOffWaitTime

TypeScript
writeAttributeOffWaitTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOffWaitTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOnTime

TypeScript
writeAttributeOnTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOnTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOnTime

TypeScript
writeAttributeOnTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOnTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeStartUp

TypeScript
writeAttributeStartUpWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeStartUp(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeStartUp

TypeScript
writeAttributeStartUpWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeStartUp(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.

MTRClusterOnOff.init()

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

All Matter types →