Console

LocatorTrait 

struct LocatorTrait

This trait is used to locate devices, which can be found by means of a local indicator, such as beeping, ringing, or flashing.

  • No supported events for LocatorTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by LocatorTrait.

    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 LocatorTrait.

    Declaration

    Swift

    let attributes: Google.LocatorTrait.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 LocatorTrait.

    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.LocatorTrait, rhs: Google.LocatorTrait) -> 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)

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

    Declaration

    Swift

    var supportsLocateCommand: Bool { get }

  • Locate the target device by generating a local alert.

    Declaration

    Swift

    func locate(lang: String, reportLocation: Bool) async throws

    Parameters

    lang

    Current language of query or display.
    reportLocation

    Indicates that coordinates are expected in the response and that the device should not ring.

  • The batchable version of locate command above.

    See also

    locate

    Declaration

    Swift

    func locateBatchable(lang: String, reportLocation: Bool) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsSilenceCommand: Bool { get }

  • Silence any in-progress alarms on devices that make an audible response for local alerts.

    Declaration

    Swift

    func silence() async throws

  • The batchable version of silence command above.

    See also

    silence

    Declaration

    Swift

    func silenceBatchable() throws -> BatchableCommand<Void>

  • Map containing specific capabilities related to locating a device.

    Declaration

    Swift

    struct LocatorFeature