Matter · IOS API REFERENCE

MTRClusterIdentify

class · iOS 16.1+ · SDK 27.1

class MTRClusterIdentify

Members (15)

method · iOS 16.4+

identify

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

identify

TypeScript

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

Swift declaration

func identify(with params: MTRIdentifyClusterIdentifyParams, 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): (MTRClusterIdentify) | 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): (MTRClusterIdentify) | 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+

readAttributeIdentifyTime

TypeScript

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

Swift declaration

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

method · iOS 16.1+

readAttributeIdentifyType

TypeScript

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

Swift declaration

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

method · iOS 16.4+

triggerEffect

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

triggerEffect

TypeScript

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

Swift declaration

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

method · iOS 16.1+

writeAttributeIdentifyTime

TypeScript

writeAttributeIdentifyTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void

Swift declaration

func writeAttributeIdentifyTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)

method · iOS 16.1+

writeAttributeIdentifyTime

TypeScript

writeAttributeIdentifyTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void

Swift declaration

func writeAttributeIdentifyTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)

Skipped declarations

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

MTRClusterIdentify.init()

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

All Matter types →