Matter · IOS API REFERENCE

MTRClusterGroups

class · iOS 16.1+ · SDK 27.1

class MTRClusterGroups

Members (22)

method · iOS 16.4+

addGroupIfIdentifying

TypeScript

addGroupIfIdentifyingWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGroupsClusterAddGroupIfIdentifyingParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func addGroupIfIdentifying(with params: MTRGroupsClusterAddGroupIfIdentifyingParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

addGroupIfIdentifying

TypeScript

addGroupIfIdentifyingWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGroupsClusterAddGroupIfIdentifyingParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func addGroupIfIdentifying(with params: MTRGroupsClusterAddGroupIfIdentifyingParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.4+

addGroup

TypeScript

addGroupWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGroupsClusterAddGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGroupsClusterAddGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addGroup(with params: MTRGroupsClusterAddGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterAddGroupResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

addGroup

TypeScript

addGroupWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGroupsClusterAddGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGroupsClusterAddGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func addGroup(with params: MTRGroupsClusterAddGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterAddGroupResponseParams

method · iOS 16.4+

getGroupMembership

TypeScript

getGroupMembershipWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGroupsClusterGetGroupMembershipParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGroupsClusterGetGroupMembershipResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func groupMembership(with params: MTRGroupsClusterGetGroupMembershipParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterGetGroupMembershipResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

getGroupMembership

TypeScript

getGroupMembershipWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGroupsClusterGetGroupMembershipParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGroupsClusterGetGroupMembershipResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func groupMembership(with params: MTRGroupsClusterGetGroupMembershipParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterGetGroupMembershipResponseParams

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterGroups) | null

Swift declaration

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

init · iOS 16.4+

init

TypeScript

static initDeviceEndpointIDQueue(device: MTRDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRClusterGroups) | null

Swift declaration

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

method · iOS 16.1+

readAttributeAcceptedCommandList

TypeScript

readAttributeAcceptedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeAcceptedCommandList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeAttributeList

TypeScript

readAttributeAttributeList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeAttributeList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeClusterRevision

TypeScript

readAttributeClusterRevision(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeClusterRevision(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeFeatureMap

TypeScript

readAttributeFeatureMap(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeFeatureMap(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeGeneratedCommandList

TypeScript

readAttributeGeneratedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeGeneratedCommandList(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.1+

readAttributeNameSupport

TypeScript

readAttributeNameSupport(params?: (MTRReadParams) | null): (Record<string, unknown>) | null

Swift declaration

func readAttributeNameSupport(with params: MTRReadParams?) -> [String : Any]?

method · iOS 16.4+

removeAllGroups

TypeScript

removeAllGroupsWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func removeAllGroups(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

removeAllGroups

TypeScript

removeAllGroupsWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func removeAllGroups(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.4+

removeAllGroups

TypeScript

removeAllGroupsWithExpectedValuesExpectedValueIntervalCompletion13012(params: (MTRGroupsClusterRemoveAllGroupsParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func removeAllGroups(with params: MTRGroupsClusterRemoveAllGroupsParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.1+ · Deprecated in iOS 16.4

removeAllGroups

TypeScript

removeAllGroupsWithExpectedValuesExpectedValueIntervalCompletionHandler43940(params: (MTRGroupsClusterRemoveAllGroupsParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func removeAllGroups(with params: MTRGroupsClusterRemoveAllGroupsParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

method · iOS 16.4+

removeGroup

TypeScript

removeGroupWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGroupsClusterRemoveGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGroupsClusterRemoveGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func removeGroup(with params: MTRGroupsClusterRemoveGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterRemoveGroupResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

removeGroup

TypeScript

removeGroupWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGroupsClusterRemoveGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGroupsClusterRemoveGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func removeGroup(with params: MTRGroupsClusterRemoveGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterRemoveGroupResponseParams

method · iOS 16.4+

viewGroup

TypeScript

viewGroupWithExpectedValuesExpectedValueIntervalCompletion(params: MTRGroupsClusterViewGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGroupsClusterViewGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func viewGroup(with params: MTRGroupsClusterViewGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterViewGroupResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

viewGroup

TypeScript

viewGroupWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRGroupsClusterViewGroupParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRGroupsClusterViewGroupResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func viewGroup(with params: MTRGroupsClusterViewGroupParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGroupsClusterViewGroupResponseParams

Skipped declarations

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

MTRClusterGroups.init()

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

All Matter types →