51Degrees Device Detection .NET
4.4
Data class that contains meta-data relating to a specific property.
See the Specification
| IComponentMetaData | GetComponent ()
Get the component associated with this property. More...
|
| IEnumerable< IValueMetaData > | GetValues ()
The values that this property can have. More...
|
| IValueMetaData | GetValue (string valueName)
Get the meta-data for an individual value entry. More...
|
| IValueMetaData | GetDefaultValue ()
Get the default value for this property. More...
|
| bool | Equals (IFiftyOneAspectPropertyMetaData other)
Check if this instance is equal to another object that implements IFiftyOneAspectPropertyMetaData. More...
|
| bool | Equals (string other)
Check if this instance is equal to a given string. More...
|
| void | Dispose ()
Dispose More...
|
| int | CompareTo (IFiftyOneAspectPropertyMetaData other)
Compare this instance to another object that implements IFiftyOneAspectPropertyMetaData. More...
|
| override string | ToString ()
Return a string representation of this instance. More...
|
| override bool | Equals (object obj)
Check if this instance is equal to a given object. More...
|
| override int | GetHashCode ()
Get a hash code for this instance. More...
|
| IComponentMetaData | Component => GetComponent()
The component associated with this property. More...
|
| IReadOnlyList< IValueMetaData > | Values => GetValues().ToList()
The values that this property can have. More...
|
| IValueMetaData | DefaultValue => GetDefaultValue()
Get the default value for this property More...
|
| IFlowElement | Element => _engine
Get the element that created this meta-data instance. More...
|
| IReadOnlyDictionary< string, IElementPropertyMetaData > | ItemPropertyDictionary => null |
| string | Url [get]
A URL that will display a page with more detail about the property. More...
|
| byte | DisplayOrder [get]
A byte used to order property meta-data instances. More...
|
| bool | Mandatory [get]
True if this property must be filled in. More...
|
| bool | List [get]
True if this is a 'list' property. More...
|
| bool | Obsolete [get]
True if the property is obsolete. More...
|
| bool | Show [get]
True if 51Degrees recommends that the property should appear in lists shown to the user. More...
|
| bool | ShowValues [get]
True if 51Degrees recommends that all possible values of this property can be shown to the user. More...
|
| string | Description [get]
A description of the property More...
|
| IList< string > | DataTiersWherePresent [get]
A list of the string names of the data tiers that this property is available in. More...
|
| bool | Available [get]
True if this property is available from the current data source. More...
|
| string | Name [get]
The name of the property. More...
|
| string | Category [get]
The category that this property belongs to. More...
|
| Type | Type [get]
The type of the values returned by this property. More...
|
| IReadOnlyList< IElementPropertyMetaData > | ItemProperties = null [get]
Get the meta-data for any sub-properties. More...
|
| int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.CompareTo | ( | IFiftyOneAspectPropertyMetaData | other | ) |
Compare this instance to another object that implements IFiftyOneAspectPropertyMetaData.
other in the sort order. 0 if they are equal in the sort order. <0 if other precedes this instance in the sort order. | virtual void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Dispose | ( | bool | disposing | ) |
Dispose
| void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Dispose | ( | ) |
Dispose
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Equals | ( | IFiftyOneAspectPropertyMetaData | other | ) |
Check if this instance is equal to another object that implements IFiftyOneAspectPropertyMetaData.
| 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.
| override bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Equals | ( | object | obj | ) |
Check if this instance is equal to a given object.
| IComponentMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetComponent | ( | ) |
Get the component associated with this property.
| IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetDefaultValue | ( | ) |
Get the default value for this property.
| 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.
| IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.GetValue | ( | string | valueName | ) |
Get the meta-data for an individual value entry.
| 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.
| override string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ToString | ( | ) |
Return a string representation of this instance.
| IComponentMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Component => GetComponent() |
The component associated with this property.
| IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DefaultValue => GetDefaultValue() |
Get the default value for this property
| IFlowElement FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Element => _engine |
Get the element that created this meta-data instance.
| 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.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Available |
True if this property is available from the current data source.
False if not.
| string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Category |
The category that this property belongs to.
| IList<string> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DataTiersWherePresent |
A list of the string names of the data tiers that this property is available in.
For example: 'Lite' or 'Enterprise'
| string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Description |
A description of the property
| byte FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.DisplayOrder |
A byte used to order property meta-data instances.
For example when displaying a list of properties to a user.
| IReadOnlyList<IElementPropertyMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ItemProperties = null |
Get the meta-data for any sub-properties.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.List |
True 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.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Mandatory |
True if this property must be filled in.
False if it can be left blank or 'Unknown'
| string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Name |
The name of the property.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Obsolete |
True 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.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Show |
True 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.
| bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.ShowValues |
True 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 FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Type |
The type of the values returned by this property.
| string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.PropertyMetaDataHash.Url |
A URL that will display a page with more detail about the property.