Console

DeviceTypeMetadata 

struct DeviceTypeMetadata
 
extension DeviceTypeMetadata : Equatable, Hashable, Sendable

Additional information about a device type.

  • Undocumented

    Declaration

    Swift

    typealias Builder = ([any Trait]?) -> DeviceTypeMetadata

  • Whether this is the primary type for the device.

    This conveys whether this is the primary functionality of the device. For example, a device that is both a light and a speaker would have isPrimaryType set to true for the light type, but false for the speaker type.

    Declaration

    Swift

    let isPrimaryType: Bool

  • Aggregated connectivity information for this device type, based on the connectivity of its traits.

    Declaration

    Swift

    let sourceConnectivity: SourceConnectivity

  • The ID of the object backing this device type.

    Declaration

    Swift

    var objectID: String { get }

  • The tags of the part. Part tags are used to identify a specific part within a device if there are multiple parts of the same type.

    Declaration

    Swift

    var tags: Set<SemanticTag> { get }

  • The name of this part / device type. Applicable only to multifacet devices.

    Declaration

    Swift

    var name: String? { get }

  • Change the name of this device part.

    Throws

    HomeError.bulk containing all mapped InteractionProxy.writeError errors.

    Declaration

    Swift

    func setName(_ name: String) async throws -> Bool

    Parameters

    name

    The new name for the part.

    Return Value

    true if the name was updated successfully, false otherwise.

  • The ID of the part, if this device type corresponds to a part.

    Declaration

    Swift

    var partID: PartID { get }

  • 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)

  • 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: DeviceTypeMetadata, rhs: DeviceTypeMetadata) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.