51Degrees Pipeline .NET  4.2

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData Class Reference

Detailed Description

Meta-data relating to properties that are populated by Aspect Engines.

Inheritance diagram for FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData:

[legend]

Public Member Functions

 AspectPropertyMetaData (IAspectEngine element, string name, Type type, string category, IList< string > dataTiersWherePresent, bool available, string description="", IReadOnlyList< IElementPropertyMetaData > itemProperties=null, bool delayExecution=false, IReadOnlyList< string > evidenceProperties=null)
Constructor More...

Properties

IList< string >  DataTiersWherePresent [get]
A list of the data tiers that can be used to determine values for this property. More...
string  Description [get]
Full description of the property. More...

Constructor & Destructor Documentation

◆ AspectPropertyMetaData()

FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData.AspectPropertyMetaData ( IAspectEngine   element,
string   name,
Type   type,
string   category,
IList< string >   dataTiersWherePresent,
bool   available,
string   description = "",
IReadOnlyList< IElementPropertyMetaData >   itemProperties = null,
bool   delayExecution = false,
IReadOnlyList< string >   evidenceProperties = null  
)

Constructor

Parameters
element - The IAspectEngine that this property is associated with.
name - The name of the property. Must match the string key used to store the property value in the IAspectData instance.
type - The type of the property values.
category - The category the property belongs to.
dataTiersWherePresent - A list of the data tiers that can be used to determine values for this property.
available - True if the property is available in the results for the associated IAspectEngine, false otherwise.
description - Full description of the property.
itemProperties - The meta-data for properties that are stored in sub-items. Only relevant if this meta-data instance relates to a collection of complex objects.
delayExecution - Only relevant if Type is JavaScript. Defaults to false. If set to true then the JavaScript in this property will not be executed automatically on the client device.
evidenceProperties - The names of any JavaScript properties that, when executed, will obtain additional evidence that can help in determining the value of this property. Note that these names should include any parts after the element data key. I.e. if the complete property name is 'devices.profiles.screenwidthpixelsjavascript' then the name in this list must be 'profiles.screenwidthpixelsjavascript'

Property Documentation

◆ DataTiersWherePresent

IList<string> FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData.DataTiersWherePresent
get

A list of the data tiers that can be used to determine values for this property.

Examples values are: Lite Premium Enterprise

◆ Description

string FiftyOne.Pipeline.Engines.Data.AspectPropertyMetaData.Description
get

Full description of the property.