One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterWindowCovering

class · iOS 16.1+ · SDK 27.1

class MTRClusterWindowCovering

Members (51)

method · iOS 16.4+

downOrClose

TypeScript
downOrCloseWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func downOrClose(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

downOrClose

TypeScript
downOrCloseWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func downOrClose(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

downOrClose

TypeScript
downOrCloseWithExpectedValuesExpectedValueIntervalCompletion52569(params: (MTRWindowCoveringClusterDownOrCloseParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func downOrClose(with params: MTRWindowCoveringClusterDownOrCloseParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

downOrClose

TypeScript
downOrCloseWithExpectedValuesExpectedValueIntervalCompletionHandler67487(params: (MTRWindowCoveringClusterDownOrCloseParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func downOrClose(with params: MTRWindowCoveringClusterDownOrCloseParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

goToLiftPercentage

TypeScript
goToLiftPercentageWithExpectedValuesExpectedValueIntervalCompletion(params: MTRWindowCoveringClusterGoToLiftPercentageParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToLiftPercentage(with params: MTRWindowCoveringClusterGoToLiftPercentageParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

goToLiftPercentage

TypeScript
goToLiftPercentageWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRWindowCoveringClusterGoToLiftPercentageParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToLiftPercentage(with params: MTRWindowCoveringClusterGoToLiftPercentageParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

goToLiftValue

TypeScript
goToLiftValueWithExpectedValuesExpectedValueIntervalCompletion(params: MTRWindowCoveringClusterGoToLiftValueParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToLiftValue(with params: MTRWindowCoveringClusterGoToLiftValueParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

goToLiftValue

TypeScript
goToLiftValueWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRWindowCoveringClusterGoToLiftValueParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToLiftValue(with params: MTRWindowCoveringClusterGoToLiftValueParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

goToTiltPercentage

TypeScript
goToTiltPercentageWithExpectedValuesExpectedValueIntervalCompletion(params: MTRWindowCoveringClusterGoToTiltPercentageParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToTiltPercentage(with params: MTRWindowCoveringClusterGoToTiltPercentageParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

goToTiltPercentage

TypeScript
goToTiltPercentageWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRWindowCoveringClusterGoToTiltPercentageParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToTiltPercentage(with params: MTRWindowCoveringClusterGoToTiltPercentageParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

goToTiltValue

TypeScript
goToTiltValueWithExpectedValuesExpectedValueIntervalCompletion(params: MTRWindowCoveringClusterGoToTiltValueParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToTiltValue(with params: MTRWindowCoveringClusterGoToTiltValueParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

goToTiltValue

TypeScript
goToTiltValueWithExpectedValuesExpectedValueIntervalCompletionHandler(params: MTRWindowCoveringClusterGoToTiltValueParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func goToTiltValue(with params: MTRWindowCoveringClusterGoToTiltValueParams, 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): (MTRClusterWindowCovering) | 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): (MTRClusterWindowCovering) | 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+

readAttributeConfigStatus

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

readAttributeCurrentPositionLiftPercent100ths

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

readAttributeCurrentPositionLiftPercentage

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

readAttributeCurrentPositionLift

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

readAttributeCurrentPositionTiltPercent100ths

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

readAttributeCurrentPositionTiltPercentage

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

readAttributeCurrentPositionTilt

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

readAttributeEndProductType

TypeScript
readAttributeEndProductType(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeEndProductType(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+

readAttributeInstalledClosedLimitLift

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

readAttributeInstalledClosedLimitTilt

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

readAttributeInstalledOpenLimitLift

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

readAttributeInstalledOpenLimitTilt

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

readAttributeMode

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

readAttributeNumberOfActuationsLift

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

readAttributeNumberOfActuationsTilt

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

readAttributeOperationalStatus

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

readAttributePhysicalClosedLimitLift

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

readAttributePhysicalClosedLimitTilt

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

readAttributeSafetyStatus

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

readAttributeTargetPositionLiftPercent100ths

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

readAttributeTargetPositionTiltPercent100ths

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

readAttributeType

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

stopMotion

TypeScript
stopMotionWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func stopMotion(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

stopMotion

TypeScript
stopMotionWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func stopMotion(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

stopMotion

TypeScript
stopMotionWithExpectedValuesExpectedValueIntervalCompletion3570(params: (MTRWindowCoveringClusterStopMotionParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func stopMotion(with params: MTRWindowCoveringClusterStopMotionParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

stopMotion

TypeScript
stopMotionWithExpectedValuesExpectedValueIntervalCompletionHandler18542(params: (MTRWindowCoveringClusterStopMotionParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func stopMotion(with params: MTRWindowCoveringClusterStopMotionParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

upOrOpen

TypeScript
upOrOpenWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func upOrOpen(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

upOrOpen

TypeScript
upOrOpenWithExpectedValuesExpectedValueIntervalCompletionHandler(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func upOrOpen(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.4+

upOrOpen

TypeScript
upOrOpenWithExpectedValuesExpectedValueIntervalCompletion75512(params: (MTRWindowCoveringClusterUpOrOpenParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func upOrOpen(with params: MTRWindowCoveringClusterUpOrOpenParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+ · Deprecated in iOS 16.4

upOrOpen

TypeScript
upOrOpenWithExpectedValuesExpectedValueIntervalCompletionHandler92512(params: (MTRWindowCoveringClusterUpOrOpenParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func upOrOpen(with params: MTRWindowCoveringClusterUpOrOpenParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 16.1+

writeAttributeMode

TypeScript
writeAttributeModeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeMode(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeMode

TypeScript
writeAttributeModeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeMode(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.

MTRClusterWindowCovering.init()

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

All Matter types →