Matter · IOS API REFERENCE

MTRClusterBooleanStateConfiguration

class · iOS 17.6+ · SDK 27.1

class MTRClusterBooleanStateConfiguration

Members (18)

method · iOS 17.6+

enableDisableAlarm

TypeScript

enableDisableAlarm(params: MTRBooleanStateConfigurationClusterEnableDisableAlarmParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func enableDisableAlarm(with params: MTRBooleanStateConfigurationClusterEnableDisableAlarmParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

init · iOS 17.6+

init

TypeScript

static init(device: MTRDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRClusterBooleanStateConfiguration) | null

Swift declaration

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

method · iOS 17.6+

readAttributeAcceptedCommandList

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeAlarmsActive

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeAlarmsEnabled

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeAlarmsSupported

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeAlarmsSuppressed

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeAttributeList

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeClusterRevision

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeCurrentSensitivityLevel

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeDefaultSensitivityLevel

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeFeatureMap

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeGeneratedCommandList

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeSensorFault

TypeScript

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

Swift declaration

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

method · iOS 17.6+

readAttributeSupportedSensitivityLevels

TypeScript

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

Swift declaration

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

method · iOS 17.6+

suppressAlarm

TypeScript

suppressAlarm(params: MTRBooleanStateConfigurationClusterSuppressAlarmParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func suppressAlarm(with params: MTRBooleanStateConfigurationClusterSuppressAlarmParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 17.6+

writeAttributeCurrentSensitivityLevel

TypeScript

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

Swift declaration

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

method · iOS 17.6+

writeAttributeCurrentSensitivityLevel

TypeScript

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

Swift declaration

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

MTRClusterBooleanStateConfiguration.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All Matter types →