One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterOperationalState

class · iOS 17.4+ · SDK 27.1

class MTRClusterOperationalState

Members (20)

init · iOS 17.4+

init

TypeScript
static init(device: MTRDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRClusterOperationalState) | null
Swift declaration
init?(device: MTRDevice, endpointID: NSNumber, queue: dispatch_queue_t)
method · iOS 17.4+

pause

TypeScript
pauseWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func pause(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

pause

TypeScript
pauseWithExpectedValuesExpectedValueIntervalCompletion14906(params: (MTROperationalStateClusterPauseParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func pause(with params: MTROperationalStateClusterPauseParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

readAttributeAcceptedCommandList

TypeScript
readAttributeAcceptedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAcceptedCommandList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeAttributeList

TypeScript
readAttributeAttributeList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAttributeList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeClusterRevision

TypeScript
readAttributeClusterRevision(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeClusterRevision(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeCountdownTime

TypeScript
readAttributeCountdownTime(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeCountdownTime(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeCurrentPhase

TypeScript
readAttributeCurrentPhase(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeCurrentPhase(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeFeatureMap

TypeScript
readAttributeFeatureMap(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeFeatureMap(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeGeneratedCommandList

TypeScript
readAttributeGeneratedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeGeneratedCommandList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeOperationalError

TypeScript
readAttributeOperationalError(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeOperationalError(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeOperationalStateList

TypeScript
readAttributeOperationalStateList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeOperationalStateList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributeOperationalState

TypeScript
readAttributeOperationalState(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeOperationalState(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

readAttributePhaseList

TypeScript
readAttributePhaseList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributePhaseList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 17.4+

resume

TypeScript
resumeWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func resume(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

resume

TypeScript
resumeWithExpectedValuesExpectedValueIntervalCompletion71789(params: (MTROperationalStateClusterResumeParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func resume(with params: MTROperationalStateClusterResumeParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

start

TypeScript
startWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func start(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

start

TypeScript
startWithExpectedValuesExpectedValueIntervalCompletion20768(params: (MTROperationalStateClusterStartParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func start(with params: MTROperationalStateClusterStartParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

stop

TypeScript
stopWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func stop(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams
method · iOS 17.4+

stop

TypeScript
stopWithExpectedValuesExpectedValueIntervalCompletion33760(params: (MTROperationalStateClusterStopParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTROperationalStateClusterOperationalCommandResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func stop(with params: MTROperationalStateClusterStopParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTROperationalStateClusterOperationalCommandResponseParams

Skipped declarations

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

MTRClusterOperationalState.init()

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

All Matter types →