◆ CompareTo()
| int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.CompareTo | ( | IFiftyOneAspectPropertyMetaData | other | ) |
Compare this instance to another object that implements IFiftyOneAspectPropertyMetaData.
- Parameters
-
- other - The IFiftyOneAspectPropertyMetaData instance to compare to.
- Returns
- >0 if this instance precedes
otherin the sort order. 0 if they are equal in the sort order. <0 ifotherprecedes this instance in the sort order.
◆ Dispose() [1/2]
virtual void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Dispose ( bool disposing ) protected virtualDispose
- Parameters
-
- disposing - False if called from finalizer
◆ Dispose() [2/2]
void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Dispose ( ) Dispose
◆ Equals() [1/3]
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Equals ( IFiftyOneAspectPropertyMetaData other ) Check if this instance is equal to another object that implements IFiftyOneAspectPropertyMetaData.
- Parameters
-
- other - The IFiftyOneAspectPropertyMetaData to check for equality.
- Returns
- True if the two instances are equal. False otherwise
◆ Equals() [2/3]
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Equals ( string other ) Check if this instance is equal to a given string.
This uses a comparison with the Name property.
- Parameters
-
- other - The string to check for equality.
- Returns
- True if the two instances are equal. False otherwise
◆ Equals() [3/3]
override bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Equals ( object obj ) Check if this instance is equal to a given object.
- Parameters
-
- obj - The object to check for equality.
- Returns
- True if the two instances are equal. False otherwise
◆ GetComponent()
IComponentMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetComponent ( ) Get the component associated with this property.
- Returns
- The component associated with this property.
◆ GetDefaultValue()
IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetDefaultValue ( ) Get the default value for this property.
- Returns
- A meta-data instance for the default value.
◆ GetHashCode()
override int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetHashCode ( ) Get a hash code for this instance.
The value-space is greater than the key-space so hash collisions are possible and may need to be accounted for, depending on your use-case.
- Returns
- A hash code.
◆ GetValue()
IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetValue ( string valueName ) Get the meta-data for an individual value entry.
- Parameters
-
- valueName - the value to get the meta-data for.
- Returns
- The requested meta-data.
◆ GetValues()
IEnumerable<IValueMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetValues ( ) The values that this property can have.
Note that this is based on information in the data file so it is possible (or even likely, depending on the property) that a future data file will have different possible values.
- Returns
- The values that this property can have.
◆ ToString()
override string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ToString ( ) Return a string representation of this instance.
- Returns
Member Data Documentation
◆ Component
IComponentMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Component => GetComponent() The component associated with this property.
◆ DefaultValue
IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DefaultValue => GetDefaultValue() Get the default value for this property
◆ Element
IFlowElement FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Element => _engine Get the element that created this meta-data instance.
◆ Values
IReadOnlyList<IValueMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Values => GetValues().ToList() The values that this property can have.
Note that this is based on information in the data file so it is possible (or even likely, depending on the property) that a future data file will have different possible values.
Property Documentation
◆ Available
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Available getTrue if this property is available from the current data source.
False if not.
◆ Category
string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Category getThe category that this property belongs to.
◆ DataTiersWherePresent
IList<string> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DataTiersWherePresent getA list of the string names of the data tiers that this property is available in.
For example: 'Lite' or 'Enterprise'
◆ Description
string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Description getA description of the property
◆ DisplayOrder
byte FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DisplayOrder getA byte used to order property meta-data instances.
For example when displaying a list of properties to a user.
◆ ItemProperties
IReadOnlyList<IElementPropertyMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ItemProperties = null getGet the meta-data for any sub-properties.
◆ List
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.List getTrue if this is a 'list' property.
False if not. List properties can have multiple values on a single profile. For example, an Apple device such as the iPhone 8 has multiple model numbers - A1863, A1864, A1897, etc. Therefore the HardwareModelVariants property is a list property.
◆ Mandatory
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Mandatory getTrue if this property must be filled in.
False if it can be left blank or 'Unknown'
◆ Name
string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Name getThe name of the property.
◆ Obsolete
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Obsolete getTrue if the property is obsolete.
False otherwise. Obsolete properties are usually retained for some time for backwards compatibility but may be removed in a future release and should not be used if possible.
◆ Show
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Show getTrue if 51Degrees recommends that the property should appear in lists shown to the user.
False if not.
This is used by the 51Degrees Property Dictionary: https://51degrees.com/resources/property-dictionary and is made available for customers should they wish to make use of it.
◆ ShowValues
bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ShowValues getTrue if 51Degrees recommends that all possible values of this property can be shown to the user.
False if not. Properties that have very large lists of possible values will usually have this set to false.
This is used by the 51Degrees Property Dictionary: https://51degrees.com/resources/property-dictionary and is made available for customers should they wish to make use of it.
◆ Type
Type FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Type getThe type of the values returned by this property.
◆ Url
string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Url getA URL that will display a page with more detail about the property.