Class TypeInfo 

[Obfuscation(Exclude = true, ApplyToMembers = true)]
[Serializable]
public class TypeInfo
Inheritance
System.Object
TypeInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: HomeSeer.PluginSdk.Devices.Identification
Assembly: PluginSdk.dll

A bundle of information describing the type of a HsDevice or HsFeature.

This is used to describe the device/feature in a manner that is easily understood by UI generation engines and other smart home platforms. When these systems can understand what this device/feature is, they are better able to tailor the experience of the user to their expectations.


Fields

View Source

_apiType

Declaration
int _apiType
Field Value
Type Description
System.Int32
View Source

_subType

Declaration
int _subType
Field Value
Type Description
System.Int32
View Source

_subTypeDesc

Declaration
string _subTypeDesc
Field Value
Type Description
System.String
View Source

_summary

Declaration
string _summary
Field Value
Type Description
System.String
View Source

_type

Declaration
int _type
Field Value
Type Description
System.Int32

Properties

View Source

ApiType

The primary type of the device/feature. This should always represent whether the item is a device or feature.

Device for devices and Feature for features

Declaration
public EApiType ApiType { get; set; }
Property Value
Type Description
EApiType
Remarks

This can only be one of a few values. It is the strictest type.

See Also
View Source

SubType

The sub-type of the AbstractHsDevice.

Declaration
public int SubType { get; set; }
Property Value
Type Description
System.Int32
Remarks

This is the least strict type field.

You can extend this and define new subtypes as needed. It is important to note that these new types will not be understood by HomeSeer and may cause HomeSeer to render them as a generic HsDevice or HsFeature. If you extend these types and would like to have HomeSeer support them you can create a pull request on GitHub.

See Also
View Source

SubTypeDescription

A human-readable string description of the configured SubType

Declaration
public string SubTypeDescription { get; set; }
Property Value
Type Description
System.String
Remarks

This must be manually set

View Source

Summary

A human-readable string summary of the entire TypeInfo

Declaration
public string Summary { get; set; }
Property Value
Type Description
System.String
Remarks

This must be manually set

View Source

Type

The EDeviceType or EFeatureType of the AbstractHsDevice

Declaration
public int Type { get; set; }
Property Value
Type Description
System.Int32
Remarks

Acceptable values can be from EDeviceType or EFeatureType. It is not as strict as ApiType, but it is stricter than SubType.

You can extend this and define new types and subtypes as needed. It is important to note that these new types will not be understood by HomeSeer and may cause HomeSeer to render them as a generic HsDevice or HsFeature. If you extend these types and would like to have HomeSeer support them you can create a pull request on GitHub.

See Also

See Also