SchemaDefinedRegion class

A DefinedRegion is a geographic area defined by potentially arbitrary (rather than political, administrative or natural geographical) criteria. Properties are provided for defining a region by reference to sets of postal codes.

Examples: a delivery destination when shopping. Region where regional pricing is configured.

Requirement 1: Country: US States: "NY", "CA"

Requirement 2: Country: US PostalCode Set: { 94000-94585, 97000, 97999, 13000, 13599} { 12345, 12345, 78945, 78945, } Region = state, canton, prefecture, autonomous community... See https://schema.org/DefinedRegion

Inheritance
Implemented types

Constructors

SchemaDefinedRegion({SchemaPropertyValue? additionalProperty, String? additionalType, dynamic address, SchemaAggregateRating? aggregateRating, String? alternateName, SchemaLocationFeatureSpecification? amenityFeature, String? branchCode, SchemaPlace? containedIn, SchemaPlace? containedInPlace, SchemaPlace? containsPlace, dynamic description, String? disambiguatingDescription, SchemaEvent? event, SchemaEvent? events, String? faxNumber, dynamic geo, dynamic geoContains, dynamic geoCoveredBy, dynamic geoCovers, dynamic geoCrosses, dynamic geoDisjoint, dynamic geoEquals, dynamic geoIntersects, dynamic geoOverlaps, dynamic geoTouches, dynamic geoWithin, String? globalLocationNumber, SchemaCertification? hasCertification, bool? hasDriveThroughService, String? hasGS1DigitalLink, dynamic hasMap, dynamic identifier, dynamic image, bool? isAccessibleForFree, String? isicV4, dynamic keywords, dynamic latitude, dynamic longitude, dynamic mainEntityOfPage, String? map, String? maps, int? maximumAttendeeCapacity, String? name, SchemaOpeningHoursSpecification? openingHoursSpecification, dynamic owner, dynamic photo, dynamic photos, SchemaAction? potentialAction, bool? publicAccess, SchemaReview? review, SchemaReview? reviews, String? sameAs, String? slogan, bool? smokingAllowed, SchemaOpeningHoursSpecification? specialOpeningHoursSpecification, dynamic subjectOf, String? telephone, String? tourBookingPage, String? url, dynamic addressCountry, dynamic addressRegion, String? postalCode, String? postalCodePrefix, SchemaPostalCodeRangeSpecification? postalCodeRange})
Create a new instance of SchemaDefinedRegion

Properties

additionalProperty ↔ SchemaPropertyValue?
A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
getter/setter pairinherited
additionalType ↔ String?
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
getter/setter pairinherited
address ↔ dynamic
Physical address of the item.
getter/setter pairinherited
addressCountry ↔ dynamic
The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example "US". For backward compatibility, a 3-letter ISO 3166-1 alpha-3 country code such as "SGP" or a full country name such as "Singapore" can also be used.
getter/setter pair
addressRegion ↔ dynamic
The region in which the locality is, and which is in the country. For example, California or another appropriate first-level Administrative division such as the Province in Italy or Region in Germany.
getter/setter pair
aggregateRating ↔ SchemaAggregateRating?
The overall rating, based on a collection of reviews or ratings, of the item.
getter/setter pairinherited
alternateName ↔ String?
An alias for the item.
getter/setter pairinherited
amenityFeature ↔ SchemaLocationFeatureSpecification?
An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
getter/setter pairinherited
branchCode ↔ String?
A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
getter/setter pairinherited
containedIn ↔ SchemaPlace?
The basic containment relation between a place and one that contains it.
getter/setter pairinherited
containedInPlace ↔ SchemaPlace?
The basic containment relation between a place and one that contains it.
getter/setter pairinherited
containsPlace ↔ SchemaPlace?
The basic containment relation between a place and another that it contains.
getter/setter pairinherited
description ↔ dynamic
A description of the item.
getter/setter pairinherited
disambiguatingDescription ↔ String?
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
getter/setter pairinherited
event ↔ SchemaEvent?
Upcoming or past event associated with this place, organization, or action.
getter/setter pairinherited
events ↔ SchemaEvent?
Upcoming or past events associated with this place or organization.
getter/setter pairinherited
faxNumber ↔ String?
The fax number.
getter/setter pairinherited
geo ↔ dynamic
The geo coordinates of the place.
getter/setter pairinherited
geoContains ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM.
getter/setter pairinherited
geoCoveredBy ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM.
getter/setter pairinherited
geoCovers ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM.
getter/setter pairinherited
geoCrosses ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM.
getter/setter pairinherited
geoDisjoint ↔ dynamic
Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.)
getter/setter pairinherited
geoEquals ↔ dynamic
Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
getter/setter pairinherited
geoIntersects ↔ dynamic
Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM.
getter/setter pairinherited
geoOverlaps ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM.
getter/setter pairinherited
geoTouches ↔ dynamic
Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.)
getter/setter pairinherited
geoWithin ↔ dynamic
Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM.
getter/setter pairinherited
globalLocationNumber ↔ String?
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
getter/setter pairinherited
hasCertification ↔ SchemaCertification?
Certification information about a product, organization, service, place, or person.
getter/setter pairinherited
hasDriveThroughService ↔ bool?
Indicates whether some facility (e.g. SchemaFoodEstablishment, SchemaCovidTestingFacility) offers a service that can be used by driving through in a car. In the case of SchemaCovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.
getter/setter pairinherited
The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a SchemaProduct or an SchemaOrganization, and for the correct granularity. In particular, for products:
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
hasMap ↔ dynamic
A URL to a map of the place.
getter/setter pairinherited
identifier ↔ dynamic
The identifier property represents any kind of identifier for any kind of SchemaThing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
getter/setter pairinherited
image ↔ dynamic
An image of the item. This can be a SchemaURL or a fully described SchemaImageObject.
getter/setter pairinherited
isAccessibleForFree ↔ bool?
A flag to signal that the item, event, or place is accessible for free.
getter/setter pairinherited
isicV4 ↔ String?
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
getter/setter pairinherited
keywords ↔ dynamic
Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
getter/setter pairinherited
latitude ↔ dynamic
The latitude of a location. For example 37.42242 (WGS 84).
getter/setter pairinherited
An associated logo.
getter/setter pairinherited
longitude ↔ dynamic
The longitude of a location. For example -122.08585 (WGS 84).
getter/setter pairinherited
mainEntityOfPage ↔ dynamic
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
getter/setter pairinherited
map ↔ String?
A URL to a map of the place.
getter/setter pairinherited
maps ↔ String?
A URL to a map of the place.
getter/setter pairinherited
maximumAttendeeCapacity ↔ int?
The total number of individuals that may attend an event or venue.
getter/setter pairinherited
name ↔ String?
The name of the item.
getter/setter pairinherited
openingHoursSpecification ↔ SchemaOpeningHoursSpecification?
The opening hours of a certain place.
getter/setter pairinherited
owner ↔ dynamic
A person or organization who owns this Thing.
getter/setter pairinherited
photo ↔ dynamic
A photograph of this place.
getter/setter pairinherited
photos ↔ dynamic
Photographs of this place.
getter/setter pairinherited
postalCode ↔ String?
The postal code. For example, 94043.
getter/setter pair
postalCodePrefix ↔ String?
A defined range of postal codes indicated by a common textual prefix. Used for non-numeric systems such as UK.
getter/setter pair
postalCodeRange ↔ SchemaPostalCodeRangeSpecification?
A defined range of postal codes.
getter/setter pair
potentialAction ↔ SchemaAction?
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
getter/setter pairinherited
publicAccess ↔ bool?
A flag to signal that the SchemaPlace is open to public visitors. If this property is omitted there is no assumed default boolean value.
getter/setter pairinherited
review ↔ SchemaReview?
A review of the item.
getter/setter pairinherited
reviews ↔ SchemaReview?
Review of the item.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sameAs ↔ String?
URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
getter/setter pairinherited
slogan ↔ String?
A slogan or motto associated with the item.
getter/setter pairinherited
smokingAllowed ↔ bool?
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
getter/setter pairinherited
specialOpeningHoursSpecification ↔ SchemaOpeningHoursSpecification?
The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by SchemaopeningHoursSpecification or SchemaopeningHours.
getter/setter pairinherited
subjectOf ↔ dynamic
A CreativeWork or Event about this Thing.
getter/setter pairinherited
telephone ↔ String?
The telephone number.
getter/setter pairinherited
tourBookingPage ↔ String?
A page providing information on how to book a tour of some SchemaPlace, such as an SchemaAccommodation or SchemaApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
getter/setter pairinherited
url ↔ String?
URL of the item.
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJsonLd() → Map<String, dynamic>
Serialize SchemaDefinedRegion to JSON-LD
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited