One Logo Pool Ball
Matter · IOS API REFERENCE

MTRClusterModeSelect

class · iOS 16.1+ · SDK 27.1

class MTRClusterModeSelect

Members (19)

method · iOS 16.4+

changeToMode

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

changeToMode

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

init

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

readAttributeCurrentMode

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

readAttributeDescription

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

readAttributeOnMode

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

readAttributeStandardNamespace

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

readAttributeStartUpMode

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

readAttributeSupportedModes

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

writeAttributeOnMode

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

writeAttributeOnMode

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

writeAttributeStartUpMode

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

writeAttributeStartUpMode

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

MTRClusterModeSelect.init()

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

All Matter types →