Matter · IOS API REFERENCE

MTRBaseClusterICDManagement

class · iOS 18.4+ · SDK 27.1

class MTRBaseClusterICDManagement

Members (49)

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+

readAttributeActiveModeDuration

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeActiveModeThreshold

TypeScript

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

Swift declaration

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

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+

readAttributeClientsSupportedPerFabric

TypeScript

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

Swift declaration

class func readAttributeClientsSupportedPerFabric(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+

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+

readAttributeICDCounter

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeIdleModeDuration

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeMaximumCheckInBackOff

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeOperatingMode

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeRegisteredClients

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeUserActiveModeTriggerHint

TypeScript

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

Swift declaration

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

static · iOS 18.4+

readAttributeUserActiveModeTriggerInstruction

TypeScript

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

Swift declaration

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

init · iOS 18.4+

init

TypeScript

static init(device: MTRBaseDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRBaseClusterICDManagement) | 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+

readAttributeActiveModeDuration

TypeScript

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

Swift declaration

func readAttributeActiveModeDuration() async throws -> NSNumber

method · iOS 18.4+

readAttributeActiveModeThreshold

TypeScript

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

Swift declaration

func readAttributeActiveModeThreshold() async throws -> NSNumber

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+

readAttributeClientsSupportedPerFabric

TypeScript

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

Swift declaration

func readAttributeClientsSupportedPerFabric() 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+

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+

readAttributeICDCounter

TypeScript

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

Swift declaration

func readAttributeICDCounter() async throws -> NSNumber

method · iOS 18.4+

readAttributeIdleModeDuration

TypeScript

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

Swift declaration

func readAttributeIdleModeDuration() async throws -> NSNumber

method · iOS 18.4+

readAttributeMaximumCheckInBackOff

TypeScript

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

Swift declaration

func readAttributeMaximumCheckInBackOff() async throws -> NSNumber

method · iOS 18.4+

readAttributeOperatingMode

TypeScript

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

Swift declaration

func readAttributeOperatingMode() async throws -> NSNumber

method · iOS 18.4+

readAttributeRegisteredClients

TypeScript

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

Swift declaration

func readAttributeRegisteredClients(with params: MTRReadParams?) async throws -> [Any]

method · iOS 18.4+

readAttributeUserActiveModeTriggerHint

TypeScript

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

Swift declaration

func readAttributeUserActiveModeTriggerHint() async throws -> NSNumber

method · iOS 18.4+

readAttributeUserActiveModeTriggerInstruction

TypeScript

readAttributeUserActiveModeTriggerInstructionCompletion(completion: ((arg0: (string) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeUserActiveModeTriggerInstruction() async throws -> String

method · iOS 18.4+

registerClient

TypeScript

registerClient(params: MTRICDManagementClusterRegisterClientParams, completion: ((arg0: (MTRICDManagementClusterRegisterClientResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func registerClient(with params: MTRICDManagementClusterRegisterClientParams) async throws -> MTRICDManagementClusterRegisterClientResponseParams

method · iOS 18.4+

stayActiveRequest

TypeScript

stayActiveRequest(params: MTRICDManagementClusterStayActiveRequestParams, completion: ((arg0: (MTRICDManagementClusterStayActiveResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func stayActiveRequest(with params: MTRICDManagementClusterStayActiveRequestParams) async throws -> MTRICDManagementClusterStayActiveResponseParams

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+

subscribeAttributeActiveModeDuration

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeActiveModeThreshold

TypeScript

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

Swift declaration

func subscribeAttributeActiveModeThreshold(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (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+

subscribeAttributeClientsSupportedPerFabric

TypeScript

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

Swift declaration

func subscribeAttributeClientsSupportedPerFabric(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+

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+

subscribeAttributeICDCounter

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeIdleModeDuration

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeMaximumCheckInBackOff

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeOperatingMode

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeRegisteredClients

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeUserActiveModeTriggerHint

TypeScript

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

Swift declaration

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

method · iOS 18.4+

subscribeAttributeUserActiveModeTriggerInstruction

TypeScript

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

Swift declaration

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

method · iOS 18.4+

unregisterClient

TypeScript

unregisterClient(params: MTRICDManagementClusterUnregisterClientParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func unregisterClient(with params: MTRICDManagementClusterUnregisterClientParams) async throws

Skipped declarations

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

MTRBaseClusterICDManagement.init()

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

All Matter types →