Matter · IOS API REFERENCE

MTRBaseClusterOnOff

class · iOS 16.1+ · SDK 27.1

class MTRBaseClusterOnOff

Members (94)

static · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeAcceptedCommandList

TypeScript

static readAttributeAcceptedCommandListWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAcceptedCommandList(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 16.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 16.1+ · Deprecated in iOS 16.4

readAttributeAttributeList

TypeScript

static readAttributeAttributeListWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAttributeList(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 16.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 16.1+ · Deprecated in iOS 16.4

readAttributeClusterRevision

TypeScript

static readAttributeClusterRevisionWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeClusterRevision(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.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 16.1+ · Deprecated in iOS 16.4

readAttributeFeatureMap

TypeScript

static readAttributeFeatureMapWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeFeatureMap(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.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 16.1+ · Deprecated in iOS 16.4

readAttributeGeneratedCommandList

TypeScript

static readAttributeGeneratedCommandListWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeGeneratedCommandList(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 16.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 16.1+ · Deprecated in iOS 16.4

readAttributeGlobalSceneControl

TypeScript

static readAttributeGlobalSceneControlWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeGlobalSceneControl(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.4+

readAttributeGlobalSceneControl

TypeScript

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

Swift declaration

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

static · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOffWaitTime

TypeScript

static readAttributeOffWaitTimeWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeOffWaitTime(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.4+

readAttributeOffWaitTime

TypeScript

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

Swift declaration

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

static · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOnOff

TypeScript

static readAttributeOnOffWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeOnOff(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.4+

readAttributeOnOff

TypeScript

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

Swift declaration

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

static · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOnTime

TypeScript

static readAttributeOnTimeWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeOnTime(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.4+

readAttributeOnTime

TypeScript

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

Swift declaration

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

static · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeStartUp

TypeScript

static readAttributeStartUpWithAttributeCacheEndpointQueueCompletionHandler(attributeCacheContainer: MTRAttributeCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeStartUp(withAttributeCache attributeCacheContainer: MTRAttributeCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 16.4+

readAttributeStartUp

TypeScript

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

Swift declaration

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

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

static initDeviceEndpointQueue(device: MTRBaseDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRBaseClusterOnOff) | null

Swift declaration

init?(device: MTRBaseDevice, endpoint: UInt16, queue: dispatch_queue_t)

init · iOS 16.4+

init

TypeScript

static initDeviceEndpointIDQueue(device: MTRBaseDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRBaseClusterOnOff) | null

Swift declaration

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

method · iOS 16.4+

off

TypeScript

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

Swift declaration

func off() async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

off

TypeScript

offCompletionHandler(completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func off() async throws

method · iOS 16.4+

offWithEffect

TypeScript

offWithEffectWithCompletion(params: MTROnOffClusterOffWithEffectParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func offWithEffect(with params: MTROnOffClusterOffWithEffectParams) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

offWithEffect

TypeScript

offWithEffectWithCompletionHandler(params: MTROnOffClusterOffWithEffectParams, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func offWithEffect(with params: MTROnOffClusterOffWithEffectParams) async throws

method · iOS 16.4+

off

TypeScript

offWithCompletion(params: (MTROnOffClusterOffParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func off(with params: MTROnOffClusterOffParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

off

TypeScript

offWithCompletionHandler(params: (MTROnOffClusterOffParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func off(with params: MTROnOffClusterOffParams?) async throws

method · iOS 16.4+

on

TypeScript

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

Swift declaration

func on() async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

on

TypeScript

onCompletionHandler(completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func on() async throws

method · iOS 16.4+

on

TypeScript

onWithCompletion(params: (MTROnOffClusterOnParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func on(with params: MTROnOffClusterOnParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

on

TypeScript

onWithCompletionHandler(params: (MTROnOffClusterOnParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func on(with params: MTROnOffClusterOnParams?) async throws

method · iOS 16.4+

onWithRecallGlobalScene

TypeScript

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

Swift declaration

func onWithRecallGlobalScene() async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

onWithRecallGlobalScene

TypeScript

onWithRecallGlobalSceneCompletionHandler(completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func onWithRecallGlobalScene() async throws

method · iOS 16.4+

onWithRecallGlobalScene

TypeScript

onWithRecallGlobalSceneWithCompletion(params: (MTROnOffClusterOnWithRecallGlobalSceneParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func onWithRecallGlobalScene(with params: MTROnOffClusterOnWithRecallGlobalSceneParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

onWithRecallGlobalScene

TypeScript

onWithRecallGlobalSceneWithCompletionHandler(params: (MTROnOffClusterOnWithRecallGlobalSceneParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func onWithRecallGlobalScene(with params: MTROnOffClusterOnWithRecallGlobalSceneParams?) async throws

method · iOS 16.4+

onWithTimedOff

TypeScript

onWithTimedOffWithCompletion(params: MTROnOffClusterOnWithTimedOffParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func onWithTimedOff(with params: MTROnOffClusterOnWithTimedOffParams) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

onWithTimedOff

TypeScript

onWithTimedOffWithCompletionHandler(params: MTROnOffClusterOnWithTimedOffParams, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func onWithTimedOff(with params: MTROnOffClusterOnWithTimedOffParams) async throws

method · iOS 16.4+

readAttributeAcceptedCommandList

TypeScript

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

Swift declaration

func readAttributeAcceptedCommandList() async throws -> [Any]

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeAcceptedCommandList

TypeScript

readAttributeAcceptedCommandListCompletionHandler(completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAcceptedCommandList() async throws -> [Any]

method · iOS 16.4+

readAttributeAttributeList

TypeScript

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

Swift declaration

func readAttributeAttributeList() async throws -> [Any]

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeAttributeList

TypeScript

readAttributeAttributeListCompletionHandler(completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAttributeList() async throws -> [Any]

method · iOS 16.4+

readAttributeClusterRevision

TypeScript

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

Swift declaration

func readAttributeClusterRevision() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeClusterRevision

TypeScript

readAttributeClusterRevisionCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeClusterRevision() async throws -> NSNumber

method · iOS 16.4+

readAttributeFeatureMap

TypeScript

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

Swift declaration

func readAttributeFeatureMap() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeFeatureMap

TypeScript

readAttributeFeatureMapCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeFeatureMap() async throws -> NSNumber

method · iOS 16.4+

readAttributeGeneratedCommandList

TypeScript

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

Swift declaration

func readAttributeGeneratedCommandList() async throws -> [Any]

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeGeneratedCommandList

TypeScript

readAttributeGeneratedCommandListCompletionHandler(completionHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeGeneratedCommandList() async throws -> [Any]

method · iOS 16.4+

readAttributeGlobalSceneControl

TypeScript

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

Swift declaration

func readAttributeGlobalSceneControl() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeGlobalSceneControl

TypeScript

readAttributeGlobalSceneControlCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeGlobalSceneControl() async throws -> NSNumber

method · iOS 16.4+

readAttributeOffWaitTime

TypeScript

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

Swift declaration

func readAttributeOffWaitTime() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOffWaitTime

TypeScript

readAttributeOffWaitTimeCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeOffWaitTime() async throws -> NSNumber

method · iOS 16.4+

readAttributeOnOff

TypeScript

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

Swift declaration

func readAttributeOnOff() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOnOff

TypeScript

readAttributeOnOffCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeOnOff() async throws -> NSNumber

method · iOS 16.4+

readAttributeOnTime

TypeScript

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

Swift declaration

func readAttributeOnTime() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeOnTime

TypeScript

readAttributeOnTimeCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeOnTime() async throws -> NSNumber

method · iOS 16.4+

readAttributeStartUp

TypeScript

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

Swift declaration

func readAttributeStartUp() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

readAttributeStartUp

TypeScript

readAttributeStartUpCompletionHandler(completionHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeStartUp() async throws -> NSNumber

method · iOS 16.1+ · Deprecated in iOS 16.4

subscribeAttributeAcceptedCommandList

TypeScript

subscribeAttributeAcceptedCommandListWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAcceptedCommandList(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeAcceptedCommandList

TypeScript

subscribeAttributeAcceptedCommandListWithSubscriptionEstablishedReportHandler(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 16.1+ · Deprecated in iOS 16.4

subscribeAttributeAttributeList

TypeScript

subscribeAttributeAttributeListWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAttributeList(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeAttributeList

TypeScript

subscribeAttributeAttributeListWithSubscriptionEstablishedReportHandler(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 16.1+ · Deprecated in iOS 16.4

subscribeAttributeClusterRevision

TypeScript

subscribeAttributeClusterRevisionWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

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

method · iOS 16.4+

subscribeAttributeClusterRevision

TypeScript

subscribeAttributeClusterRevisionWithSubscriptionEstablishedReportHandler(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 16.1+ · Deprecated in iOS 16.4

subscribeAttributeFeatureMap

TypeScript

subscribeAttributeFeatureMapWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

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

method · iOS 16.4+

subscribeAttributeFeatureMap

TypeScript

subscribeAttributeFeatureMapWithSubscriptionEstablishedReportHandler(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 16.1+ · Deprecated in iOS 16.4

subscribeAttributeGeneratedCommandList

TypeScript

subscribeAttributeGeneratedCommandListWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeGeneratedCommandList(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeGeneratedCommandList

TypeScript

subscribeAttributeGeneratedCommandListWithSubscriptionEstablishedReportHandler(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 16.1+ · Deprecated in iOS 16.4

subscribeAttributeGlobalSceneControl

TypeScript

subscribeAttributeGlobalSceneControlWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeGlobalSceneControl(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeGlobalSceneControl

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

subscribeAttributeOffWaitTime

TypeScript

subscribeAttributeOffWaitTimeWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeOffWaitTime(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeOffWaitTime

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

subscribeAttributeOnOff

TypeScript

subscribeAttributeOnOffWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeOnOff(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeOnOff

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

subscribeAttributeOnTime

TypeScript

subscribeAttributeOnTimeWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeOnTime(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeOnTime

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

subscribeAttributeStartUp

TypeScript

subscribeAttributeStartUpWithMinIntervalMaxIntervalParamsSubscriptionEstablishedReportHandler(minInterval: _Foundation_NSNumber, maxInterval: _Foundation_NSNumber, params: (MTRSubscribeParams) | null, subscriptionEstablishedHandler: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeStartUp(withMinInterval minInterval: NSNumber, maxInterval: NSNumber, params: MTRSubscribeParams?, subscriptionEstablished subscriptionEstablishedHandler: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 16.4+

subscribeAttributeStartUp

TypeScript

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

Swift declaration

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

method · iOS 16.4+

toggle

TypeScript

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

Swift declaration

func toggle() async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

toggle

TypeScript

toggleCompletionHandler(completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func toggle() async throws

method · iOS 16.4+

toggle

TypeScript

toggleWithCompletion(params: (MTROnOffClusterToggleParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func toggle(with params: MTROnOffClusterToggleParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

toggle

TypeScript

toggleWithCompletionHandler(params: (MTROnOffClusterToggleParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func toggle(with params: MTROnOffClusterToggleParams?) async throws

method · iOS 16.4+

writeAttributeOffWaitTime

TypeScript

writeAttributeOffWaitTimeWithValueCompletion(value: _Foundation_NSNumber, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOffWaitTime(withValue value: NSNumber) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeOffWaitTime

TypeScript

writeAttributeOffWaitTimeWithValueCompletionHandler(value: _Foundation_NSNumber, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOffWaitTime(withValue value: NSNumber) async throws

method · iOS 16.4+

writeAttributeOffWaitTime

TypeScript

writeAttributeOffWaitTimeWithValueParamsCompletion(value: _Foundation_NSNumber, params: (MTRWriteParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOffWaitTime(withValue value: NSNumber, params: MTRWriteParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeOffWaitTime

TypeScript

writeAttributeOffWaitTimeWithValueParamsCompletionHandler(value: _Foundation_NSNumber, params: (MTRWriteParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOffWaitTime(withValue value: NSNumber, params: MTRWriteParams?) async throws

method · iOS 16.4+

writeAttributeOnTime

TypeScript

writeAttributeOnTimeWithValueCompletion(value: _Foundation_NSNumber, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOnTime(withValue value: NSNumber) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeOnTime

TypeScript

writeAttributeOnTimeWithValueCompletionHandler(value: _Foundation_NSNumber, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOnTime(withValue value: NSNumber) async throws

method · iOS 16.4+

writeAttributeOnTime

TypeScript

writeAttributeOnTimeWithValueParamsCompletion(value: _Foundation_NSNumber, params: (MTRWriteParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOnTime(withValue value: NSNumber, params: MTRWriteParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeOnTime

TypeScript

writeAttributeOnTimeWithValueParamsCompletionHandler(value: _Foundation_NSNumber, params: (MTRWriteParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeOnTime(withValue value: NSNumber, params: MTRWriteParams?) async throws

method · iOS 16.4+

writeAttributeStartUp

TypeScript

writeAttributeStartUpWithValueCompletion(value: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeStartUp(withValue value: NSNumber?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeStartUp

TypeScript

writeAttributeStartUpWithValueCompletionHandler(value: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeStartUp(withValue value: NSNumber?) async throws

method · iOS 16.4+

writeAttributeStartUp

TypeScript

writeAttributeStartUpWithValueParamsCompletion(value: (_Foundation_NSNumber) | null, params: (MTRWriteParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeStartUp(withValue value: NSNumber?, params: MTRWriteParams?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

writeAttributeStartUp

TypeScript

writeAttributeStartUpWithValueParamsCompletionHandler(value: (_Foundation_NSNumber) | null, params: (MTRWriteParams) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func writeAttributeStartUp(withValue value: NSNumber?, params: MTRWriteParams?) async throws

Skipped declarations

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

MTRBaseClusterOnOff.init()

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

All Matter types →