Matter · IOS API REFERENCE

MTRClusterChannel

class · iOS 16.1+ · SDK 27.1

class MTRClusterChannel

Members (20)

method · iOS 18.4+

cancelRecordProgram

TypeScript

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

Swift declaration

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

method · iOS 16.4+

changeByNumber

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

changeByNumber

TypeScript

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

Swift declaration

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

method · iOS 16.4+

change

TypeScript

changeWithExpectedValuesExpectedValueIntervalCompletion(params: MTRChannelClusterChangeChannelParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRChannelClusterChangeChannelResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func change(with params: MTRChannelClusterChangeChannelParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRChannelClusterChangeChannelResponseParams

method · iOS 16.1+ · Deprecated in iOS 16.4

change

TypeScript

changeWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRChannelClusterChangeChannelParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (MTRChannelClusterChangeChannelResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func change(with params: MTRChannelClusterChangeChannelParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRChannelClusterChangeChannelResponseParams

method · iOS 18.4+

getProgramGuide

TypeScript

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

Swift declaration

func programGuide(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRChannelClusterProgramGuideResponseParams

method · iOS 18.4+

getProgramGuide

TypeScript

getProgramGuideWithExpectedValuesExpectedValueIntervalCompletion10022(params: (MTRChannelClusterGetProgramGuideParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRChannelClusterProgramGuideResponseParams) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func programGuide(with params: MTRChannelClusterGetProgramGuideParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRChannelClusterProgramGuideResponseParams

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript

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

readAttributeChannelList

TypeScript

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

Swift declaration

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

readAttributeCurrentChannel

TypeScript

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

Swift declaration

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

readAttributeLineup

TypeScript

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

Swift declaration

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

method · iOS 18.4+

recordProgram

TypeScript

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

Swift declaration

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

method · iOS 16.4+

skip

TypeScript

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

Swift declaration

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

method · iOS 16.1+ · Deprecated in iOS 16.4

skip

TypeScript

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

Swift declaration

func skip(with params: MTRChannelClusterSkipChannelParams, 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.

MTRClusterChannel.init()

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

All Matter types →