Matter · IOS API REFERENCE

MTRClusterActions

class · iOS 16.1+ · SDK 27.1

class MTRClusterActions

Members (34)

method · iOS 16.4+

disableActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

disableActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.4+

disableAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

disableAction

TypeScript

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

Swift declaration

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

method · iOS 16.4+

enableActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

enableActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.4+

enableAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

enableAction

TypeScript

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

Swift declaration

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

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterActions) | 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): (MTRClusterActions) | null

Swift declaration

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

method · iOS 16.4+

instantAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

instantAction

TypeScript

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

Swift declaration

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

method · iOS 16.4+

instantActionWithTransition

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

instantActionWithTransition

TypeScript

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

Swift declaration

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

method · iOS 16.4+

pauseActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

pauseActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.4+

pauseAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

pauseAction

TypeScript

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

Swift declaration

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

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+

readAttributeActionList

TypeScript

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

Swift declaration

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

readAttributeEndpointLists

TypeScript

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

Swift declaration

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

readAttributeSetupURL

TypeScript

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

Swift declaration

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

method · iOS 16.4+

resumeAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

resumeAction

TypeScript

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

Swift declaration

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

method · iOS 16.4+

startActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

startActionWithDuration

TypeScript

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

Swift declaration

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

method · iOS 16.4+

startAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

startAction

TypeScript

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

Swift declaration

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

method · iOS 16.4+

stopAction

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

stopAction

TypeScript

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

Swift declaration

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

Skipped declarations

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

MTRClusterActions.init()

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

All Matter types →