Matter · IOS API REFERENCE

MTRBaseClusterWaterHeaterManagement

class · iOS 18.4+ · SDK 27.1

class MTRBaseClusterWaterHeaterManagement

Members (37)

static · iOS 18.4+

readAttributeAcceptedCommandList

TypeScript

static readAttributeAcceptedCommandListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAcceptedCommandList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeAttributeList

TypeScript

static readAttributeAttributeListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAttributeList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeBoostState

TypeScript

static readAttributeBoostStateWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeBoostState(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeClusterRevision

TypeScript

static readAttributeClusterRevisionWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeClusterRevision(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeEstimatedHeatRequired

TypeScript

static readAttributeEstimatedHeatRequiredWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeEstimatedHeatRequired(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeFeatureMap

TypeScript

static readAttributeFeatureMapWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeFeatureMap(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeGeneratedCommandList

TypeScript

static readAttributeGeneratedCommandListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeGeneratedCommandList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeHeatDemand

TypeScript

static readAttributeHeatDemandWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeHeatDemand(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeHeaterTypes

TypeScript

static readAttributeHeaterTypesWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeHeaterTypes(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeTankPercentage

TypeScript

static readAttributeTankPercentageWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeTankPercentage(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeTankVolume

TypeScript

static readAttributeTankVolumeWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeTankVolume(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

method · iOS 18.4+

boost

TypeScript

boost(params: MTRWaterHeaterManagementClusterBoostParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func boost(with params: MTRWaterHeaterManagementClusterBoostParams) async throws

method · iOS 18.4+

cancelBoost

TypeScript

cancelBoostCompletion(completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelBoost() async throws

method · iOS 18.4+

cancelBoost

TypeScript

cancelBoostWithCompletion(params: (MTRWaterHeaterManagementClusterCancelBoostParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelBoost(with params: MTRWaterHeaterManagementClusterCancelBoostParams?) async throws

init · iOS 18.4+

init

TypeScript

static init(device: MTRBaseDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRBaseClusterWaterHeaterManagement) | null

Swift declaration

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

method · iOS 18.4+

readAttributeAcceptedCommandList

TypeScript

readAttributeAcceptedCommandListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAcceptedCommandList() async throws -> [Any]

method · iOS 18.4+

readAttributeAttributeList

TypeScript

readAttributeAttributeListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAttributeList() async throws -> [Any]

method · iOS 18.4+

readAttributeBoostState

TypeScript

readAttributeBoostStateCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeBoostState() async throws -> NSNumber

method · iOS 18.4+

readAttributeClusterRevision

TypeScript

readAttributeClusterRevisionCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeClusterRevision() async throws -> NSNumber

method · iOS 18.4+

readAttributeEstimatedHeatRequired

TypeScript

readAttributeEstimatedHeatRequiredCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeEstimatedHeatRequired() async throws -> NSNumber

method · iOS 18.4+

readAttributeFeatureMap

TypeScript

readAttributeFeatureMapCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeFeatureMap() async throws -> NSNumber

method · iOS 18.4+

readAttributeGeneratedCommandList

TypeScript

readAttributeGeneratedCommandListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeGeneratedCommandList() async throws -> [Any]

method · iOS 18.4+

readAttributeHeatDemand

TypeScript

readAttributeHeatDemandCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeHeatDemand() async throws -> NSNumber

method · iOS 18.4+

readAttributeHeaterTypes

TypeScript

readAttributeHeaterTypesCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeHeaterTypes() async throws -> NSNumber

method · iOS 18.4+

readAttributeTankPercentage

TypeScript

readAttributeTankPercentageCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeTankPercentage() async throws -> NSNumber

method · iOS 18.4+

readAttributeTankVolume

TypeScript

readAttributeTankVolumeCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeTankVolume() async throws -> NSNumber

method · iOS 18.4+

subscribeAttributeAcceptedCommandList

TypeScript

subscribeAttributeAcceptedCommandList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAcceptedCommandList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeAttributeList

TypeScript

subscribeAttributeAttributeList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAttributeList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeBoostState

TypeScript

subscribeAttributeBoostState(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeBoostState(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeClusterRevision

TypeScript

subscribeAttributeClusterRevision(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeClusterRevision(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeEstimatedHeatRequired

TypeScript

subscribeAttributeEstimatedHeatRequired(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeEstimatedHeatRequired(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeFeatureMap

TypeScript

subscribeAttributeFeatureMap(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeFeatureMap(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeGeneratedCommandList

TypeScript

subscribeAttributeGeneratedCommandList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeGeneratedCommandList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeHeatDemand

TypeScript

subscribeAttributeHeatDemand(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeHeatDemand(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeHeaterTypes

TypeScript

subscribeAttributeHeaterTypes(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeHeaterTypes(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeTankPercentage

TypeScript

subscribeAttributeTankPercentage(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeTankPercentage(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeTankVolume

TypeScript

subscribeAttributeTankVolume(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeTankVolume(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

Skipped declarations

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

MTRBaseClusterWaterHeaterManagement.init()

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

All Matter types →