One Logo Pool Ball
Matter · IOS API REFERENCE

MTRBaseClusterServiceArea

class · iOS 18.4+ · SDK 27.1

class MTRBaseClusterServiceArea

Members (36)

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+

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+

readAttributeCurrentArea

TypeScript
static readAttributeCurrentAreaWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeCurrentArea(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber
static · iOS 18.4+

readAttributeEstimatedEndTime

TypeScript
static readAttributeEstimatedEndTimeWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeEstimatedEndTime(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+

readAttributeProgress

TypeScript
static readAttributeProgressWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeProgress(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]
static · iOS 18.4+

readAttributeSelectedAreas

TypeScript
static readAttributeSelectedAreasWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeSelectedAreas(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]
static · iOS 18.4+

readAttributeSupportedAreas

TypeScript
static readAttributeSupportedAreasWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeSupportedAreas(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]
static · iOS 18.4+

readAttributeSupportedMaps

TypeScript
static readAttributeSupportedMapsWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func readAttributeSupportedMaps(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]
init · iOS 18.4+

init

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

readAttributeClusterRevision

TypeScript
readAttributeClusterRevisionCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeClusterRevision() async throws -> NSNumber
method · iOS 18.4+

readAttributeCurrentArea

TypeScript
readAttributeCurrentAreaCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeCurrentArea() async throws -> NSNumber
method · iOS 18.4+

readAttributeEstimatedEndTime

TypeScript
readAttributeEstimatedEndTimeCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeEstimatedEndTime() 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+

readAttributeProgress

TypeScript
readAttributeProgressCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeProgress() async throws -> [Any]
method · iOS 18.4+

readAttributeSelectedAreas

TypeScript
readAttributeSelectedAreasCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeSelectedAreas() async throws -> [Any]
method · iOS 18.4+

readAttributeSupportedAreas

TypeScript
readAttributeSupportedAreasCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeSupportedAreas() async throws -> [Any]
method · iOS 18.4+

readAttributeSupportedMaps

TypeScript
readAttributeSupportedMapsCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func readAttributeSupportedMaps() async throws -> [Any]
method · iOS 18.4+

selectAreas

TypeScript
selectAreas(params: MTRServiceAreaClusterSelectAreasParams, completion: ((arg0: (MTRServiceAreaClusterSelectAreasResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func selectAreas(with params: MTRServiceAreaClusterSelectAreasParams) async throws -> MTRServiceAreaClusterSelectAreasResponseParams
method · iOS 18.4+

skip

TypeScript
skip(params: MTRServiceAreaClusterSkipAreaParams, completion: ((arg0: (MTRServiceAreaClusterSkipAreaResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func skip(with params: MTRServiceAreaClusterSkipAreaParams) async throws -> MTRServiceAreaClusterSkipAreaResponseParams
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+

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+

subscribeAttributeCurrentArea

TypeScript
subscribeAttributeCurrentArea(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeCurrentArea(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)
method · iOS 18.4+

subscribeAttributeEstimatedEndTime

TypeScript
subscribeAttributeEstimatedEndTime(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeEstimatedEndTime(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+

subscribeAttributeProgress

TypeScript
subscribeAttributeProgress(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeProgress(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)
method · iOS 18.4+

subscribeAttributeSelectedAreas

TypeScript
subscribeAttributeSelectedAreas(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeSelectedAreas(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)
method · iOS 18.4+

subscribeAttributeSupportedAreas

TypeScript
subscribeAttributeSupportedAreas(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeSupportedAreas(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)
method · iOS 18.4+

subscribeAttributeSupportedMaps

TypeScript
subscribeAttributeSupportedMaps(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func subscribeAttributeSupportedMaps(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.

MTRBaseClusterServiceArea.init()

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

All Matter types →