Matter · IOS API REFERENCE

MTRBaseClusterMessages

class · iOS 18.4+ · SDK 27.1

class MTRBaseClusterMessages

Members (24)

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+

readAttributeActiveMessageIDs

TypeScript

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

Swift declaration

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

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+

readAttributeMessages

TypeScript

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

Swift declaration

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

method · iOS 18.4+

cancelRequest

TypeScript

cancelRequest(params: MTRMessagesClusterCancelMessagesRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelRequest(with params: MTRMessagesClusterCancelMessagesRequestParams) async throws

init · iOS 18.4+

init

TypeScript

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

Swift declaration

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

method · iOS 18.4+

presentRequest

TypeScript

presentRequest(params: MTRMessagesClusterPresentMessagesRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func presentRequest(with params: MTRMessagesClusterPresentMessagesRequestParams) async throws

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+

readAttributeActiveMessageIDs

TypeScript

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

Swift declaration

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

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+

readAttributeMessages

TypeScript

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

Swift declaration

func readAttributeMessages() async throws -> [Any]

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+

subscribeAttributeActiveMessageIDs

TypeScript

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

Swift declaration

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

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+

subscribeAttributeMessages

TypeScript

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

Swift declaration

func subscribeAttributeMessages(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.

MTRBaseClusterMessages.init()

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

All Matter types →