Console

LockUnlockTrait 

struct LockUnlockTrait

This trait belongs to any devices that support locking and unlocking, or reporting a locked state, except door locks, which are covered by the Matter standard DoorLock cluster.

  • List of the event types that are supported by LockUnlockTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by LockUnlockTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the LockUnlockTrait.

    Declaration

    Swift

    let attributes: Google.LockUnlockTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the LockUnlockTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.LockUnlockTrait, rhs: Google.LockUnlockTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Follow up response for the lock command.

    Declaration

    Swift

    struct LockFollowUpEvent

  • Follow up response for the unlock command.

    Declaration

    Swift

    struct UnlockFollowUpEvent

  • Whether the device supports the lock command for this trait.

    Declaration

    Swift

    var supportsLockCommand: Bool { get }

  • Lock the device.

    Declaration

    Swift

    func lock(followUpToken: String) async throws

  • The batchable version of lock command above.

    See also

    lock

    Declaration

    Swift

    func lockBatchable(followUpToken: String) throws -> BatchableCommand<Void>

  • Whether the device supports the unlock command for this trait.

    Declaration

    Swift

    var supportsUnlockCommand: Bool { get }

  • Unlock the device.

    Declaration

    Swift

    func unlock(followUpToken: String) async throws

  • The batchable version of unlock command above.

    See also

    unlock

    Declaration

    Swift

    func unlockBatchable(followUpToken: String) throws -> BatchableCommand<Void>

  • The current state of the device.

    Declaration

    Swift

    enum LockState

  • The status of the lock or unlock command.

    Declaration

    Swift

    enum StatusEnum