SchemaWebAPI class

An application programming interface accessible over Web/Internet technologies. See https://schema.org/WebAPI

Constructors

SchemaWebAPI({dynamic documentation, SchemaAggregateRating? aggregateRating, dynamic areaServed, SchemaAudience? audience, SchemaServiceChannel? availableChannel, String? award, dynamic brand, dynamic broker, dynamic category, SchemaCertification? hasCertification, SchemaOfferCatalog? hasOfferCatalog, SchemaOpeningHoursSpecification? hoursAvailable, dynamic isRelatedTo, dynamic isSimilarTo, dynamic logo, dynamic offers, SchemaThing? produces, dynamic provider, String? providerMobility, SchemaReview? review, dynamic serviceArea, SchemaAudience? serviceAudience, SchemaThing? serviceOutput, dynamic serviceType, String? slogan, String? termsOfService, String? additionalType, String? alternateName, dynamic description, String? disambiguatingDescription, dynamic identifier, dynamic image, dynamic mainEntityOfPage, String? name, SchemaAction? potentialAction, String? sameAs, dynamic subjectOf, String? url})

Create a new instance of SchemaWebAPI

Properties

additionalType ↔ String?

//schema.org/docs/styleguide.html">style guide.

getter/setter pair

aggregateRating ↔ SchemaAggregateRating?

The overall rating, based on a collection of reviews or ratings, of the item.

getter/setter pair

alternateName ↔ String?

An alias for the item.

getter/setter pair

areaServed ↔ dynamic

The geographic area where a service or offered item is provided.

getter/setter pair

audience ↔ SchemaAudience?

An intended audience, i.e. a group for whom something was created.

getter/setter pair

availableChannel ↔ SchemaServiceChannel?

A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).

getter/setter pair

award ↔ String?

An award won by or for this item.

getter/setter pair

brand ↔ dynamic

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

getter/setter pair

broker ↔ dynamic

An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

getter/setter pair

category ↔ dynamic

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

getter/setter pair

description ↔ dynamic

A description of the item.

getter/setter pair

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 pair

documentation ↔ dynamic

Further documentation describing the Web API in more detail.

getter/setter pair

hasCertification ↔ SchemaCertification?

Certification information about a product, organization, service, place, or person.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasOfferCatalog ↔ SchemaOfferCatalog?

Indicates an OfferCatalog listing for this Organization, Person, or Service.

getter/setter pair

hoursAvailable ↔ SchemaOpeningHoursSpecification?

The hours during which this service or contact is available.

getter/setter pair

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 pair

image ↔ dynamic

An image of the item. This can be a SchemaURL or a fully described SchemaImageObject.

getter/setter pair

isRelatedTo ↔ dynamic

A pointer to another, somehow related product (or multiple products).

getter/setter pair

isSimilarTo ↔ dynamic

A pointer to another, functionally similar product (or multiple products).

getter/setter pair

logo ↔ dynamic

An associated logo.

getter/setter pair

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 pair

name ↔ String?

The name of the item.

getter/setter pair

offers ↔ dynamic

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use SchemabusinessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a SchemaDemand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.

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 pair

produces ↔ SchemaThing?

The tangible thing generated by the service, e.g. a passport, permit, etc.

getter/setter pair

provider ↔ dynamic

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

getter/setter pair

providerMobility ↔ String?

Indicates the mobility of a provided service (e.g. 'static', 'dynamic').

getter/setter pair

review ↔ SchemaReview?

A review of the item.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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 pair

serviceArea ↔ dynamic

The geographic area where the service is provided.

getter/setter pair

serviceAudience ↔ SchemaAudience?

The audience eligible for this service.

getter/setter pair

serviceOutput ↔ SchemaThing?

The tangible thing generated by the service, e.g. a passport, permit, etc.

getter/setter pair

serviceType ↔ dynamic

The type of service being offered, e.g. veterans' benefits, emergency relief, etc.

getter/setter pair

slogan ↔ String?

A slogan or motto associated with the item.

getter/setter pair

subjectOf ↔ dynamic

A CreativeWork or Event about this Thing.

getter/setter pair

termsOfService ↔ String?

Human-readable terms of service documentation.

getter/setter pair

url ↔ String?

URL of the item.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJsonLd() → Map<String, dynamic>

Serialize SchemaWebAPI to JSON-LD

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited