Property class

Class representing a Property Affordance in a Thing Description.

Inheritance

• Object
• InteractionAffordance
• Property

Implemented types

• DataSchema

Annotations

• @immutable

Constructors

Property({required List<Form> forms, required DataSchema dataSchema, Map<String, DataSchema>? uriVariables, Map<String, dynamic> additionalFields = const {}, bool observable = _defaultObservableValue})

Default constructor that creates a Property from a List of forms.

const

Property.fromJson(Map<String, dynamic> json, PrefixMapping prefixMapping)

Creates a new Property from a json object.

factory

Properties

additionalFields → Map<String, dynamic>

Additional fields that could not be deserialized as class members.

no setter, override

atType → List<String>?

/// JSON-LD keyword to label the object with semantic tags (or types).

no setter, override

constant → Object?

A constant value.

no setter, override

contentEncoding → String?

Specifies the encoding used to store the contents, as specified in RFC 2045 (Section 6.1) and RFC 4648.

no setter, override

contentMediaType → String?

Specifies the MIME type of the contents of a string value, as described in RFC 2046.

no setter, override

dataSchema → DataSchema

The internal DataSchema this property is based on.

final

defaultValue → Object?

A default value if no actual value is set.

no setter, override

description → String?

The default description of this InteractionAffordance.

no setter, override

descriptions → Map<String, String>?

Multi-language descriptions of this InteractionAffordance.

no setter, override

enumeration → List<Object?>?

Restricted set of values provided as a List.

no setter, override

exclusiveMaximum → num?

Specifies a maximum numeric value, representing an exclusive upper limit.

no setter, override

exclusiveMinimum → num?

Specifies a minimum numeric value, representing an exclusive lower limit.

no setter, override

format → String?

Allows validation based on a format pattern.

no setter, override

forms → List<Form>

The basic forms which can be used for interacting with this resource.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

items → List<DataSchema>?

Used to define the characteristics of an array.

no setter, override

maximum → num?

Specifies a maximum numeric value, representing an inclusive upper limit.

no setter, override

maxItems → int?

Defines the maximum number of items that have to be in an array.

no setter, override

maxLength → int?

Specifies the maximum length of a string.

no setter, override

minimum → num?

Specifies a minimum numeric value, representing an inclusive lower limit.

no setter, override

minItems → int?

Defines the minimum number of items that have to be in an array.

no setter, override

minLength → int?

Specifies the minimum length of a string.

no setter, override

multipleOf → num?

Specifies the multipleOf value number. The value must strictly greater than 0.

no setter, override

observable → bool

A hint that indicates whether Servients hosting the Thing and Intermediaries should provide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.

final

oneOf → List<DataSchema>?

Allows the specification of multiple DataSchemas for validation.

no setter, override

pattern → String?

Provides a regular expression to express constraints of the string value.

no setter, override

properties → Map<String, DataSchema>?

Data schema nested definitions in an object.

no setter, override

readOnly → bool

Indicates if a value is read only.

no setter, override

required → List<String>?

Defines which members of the object type are mandatory, i.e. which members are mandatory in the payload that is to be sent (e.g. input of invokeaction, writeproperty) and what members will be definitely delivered in the payload that is being received (e.g. output of invokeaction, readproperty).

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String?

The default title of this InteractionAffordance.

no setter, override

titles → Map<String, String>?

Multi-language titles of this InteractionAffordance.

no setter, override

type → String?

JSON-based data type compatible with JSON Schema.

no setter, override

unit → String?

The unit of the value.

no setter, override

uriVariables → Map<String, DataSchema>?

URI template variables as defined in RFC 6570.

final, inherited

writeOnly → bool

Indicates if a value is write only.

no setter, override

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Converts this class object into a JSON value.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited