Matter · IOS API REFERENCE

MTRBaseClusterOperationalState

class · iOS 17.4+ · SDK 27.1

class MTRBaseClusterOperationalState

Members (42)

static · iOS 17.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 17.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 17.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 17.4+

readAttributeCountdownTime

TypeScript

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

Swift declaration

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

static · iOS 17.4+

readAttributeCurrentPhase

TypeScript

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

Swift declaration

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

static · iOS 17.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 17.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 17.4+

readAttributeOperationalError

TypeScript

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

Swift declaration

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

static · iOS 17.4+

readAttributeOperationalStateList

TypeScript

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

Swift declaration

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

static · iOS 17.4+

readAttributeOperationalState

TypeScript

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

Swift declaration

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

static · iOS 17.4+

readAttributePhaseList

TypeScript

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

Swift declaration

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

init · iOS 17.4+

init

TypeScript

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

Swift declaration

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

method · iOS 17.4+

pause

TypeScript

pauseCompletion(completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func pause() async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

pause

TypeScript

pauseWithCompletion(params: (MTROperationalStateClusterPauseParams) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func pause(with params: MTROperationalStateClusterPauseParams?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

readAttributeAcceptedCommandList

TypeScript

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

Swift declaration

func readAttributeAcceptedCommandList() async throws -> [Any]

method · iOS 17.4+

readAttributeAttributeList

TypeScript

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

Swift declaration

func readAttributeAttributeList() async throws -> [Any]

method · iOS 17.4+

readAttributeClusterRevision

TypeScript

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

Swift declaration

func readAttributeClusterRevision() async throws -> NSNumber

method · iOS 17.4+

readAttributeCountdownTime

TypeScript

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

Swift declaration

func readAttributeCountdownTime() async throws -> NSNumber

method · iOS 17.4+

readAttributeCurrentPhase

TypeScript

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

Swift declaration

func readAttributeCurrentPhase() async throws -> NSNumber

method · iOS 17.4+

readAttributeFeatureMap

TypeScript

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

Swift declaration

func readAttributeFeatureMap() async throws -> NSNumber

method · iOS 17.4+

readAttributeGeneratedCommandList

TypeScript

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

Swift declaration

func readAttributeGeneratedCommandList() async throws -> [Any]

method · iOS 17.4+

readAttributeOperationalError

TypeScript

readAttributeOperationalErrorCompletion(completion: ((arg0: (MTROperationalStateClusterErrorStateStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeOperationalError() async throws -> MTROperationalStateClusterErrorStateStruct

method · iOS 17.4+

readAttributeOperationalStateList

TypeScript

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

Swift declaration

func readAttributeOperationalStateList() async throws -> [Any]

method · iOS 17.4+

readAttributeOperationalState

TypeScript

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

Swift declaration

func readAttributeOperationalState() async throws -> NSNumber

method · iOS 17.4+

readAttributePhaseList

TypeScript

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

Swift declaration

func readAttributePhaseList() async throws -> [Any]

method · iOS 17.4+

resume

TypeScript

resumeCompletion(completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func resume() async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

resume

TypeScript

resumeWithCompletion(params: (MTROperationalStateClusterResumeParams) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func resume(with params: MTROperationalStateClusterResumeParams?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

start

TypeScript

startCompletion(completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func start() async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

start

TypeScript

startWithCompletion(params: (MTROperationalStateClusterStartParams) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func start(with params: MTROperationalStateClusterStartParams?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

stop

TypeScript

stopCompletion(completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func stop() async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.4+

stop

TypeScript

stopWithCompletion(params: (MTROperationalStateClusterStopParams) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func stop(with params: MTROperationalStateClusterStopParams?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams

method · iOS 17.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 17.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 17.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 17.4+

subscribeAttributeCountdownTime

TypeScript

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

Swift declaration

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

method · iOS 17.4+

subscribeAttributeCurrentPhase

TypeScript

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

Swift declaration

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

method · iOS 17.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 17.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 17.4+

subscribeAttributeOperationalError

TypeScript

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

Swift declaration

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

method · iOS 17.4+

subscribeAttributeOperationalStateList

TypeScript

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

Swift declaration

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

method · iOS 17.4+

subscribeAttributeOperationalState

TypeScript

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

Swift declaration

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

method · iOS 17.4+

subscribeAttributePhaseList

TypeScript

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

Swift declaration

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

Skipped declarations

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

MTRBaseClusterOperationalState.init()

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

All Matter types →