SchemaFinancialIncentive class

Represents financial incentives for goods/services offered by an organization (or individual).

Typically contains the [Schemaname] of the incentive, the [SchemaincentivizedItem], the [SchemaincentiveAmount], the [SchemaincentiveStatus], [SchemaincentiveType], the [Schemaprovider] of the incentive, and [SchemaeligibleWithSupplier].

Optionally contains criteria on whether the incentive is limited based on [SchemapurchaseType], [SchemapurchasePriceLimit], [SchemaincomeLimit], and the [SchemaqualifiedExpense]. See https://schema.org/FinancialIncentive

Inheritance

Constructors

SchemaFinancialIncentive({String? additionalType, String? alternateName, dynamic description, String? disambiguatingDescription, dynamic identifier, dynamic image, dynamic mainEntityOfPage, String? name, dynamic owner, SchemaAction? potentialAction, String? sameAs, dynamic subjectOf, String? url, dynamic areaServed, SchemaOrganization? eligibleWithSupplier, dynamic incentiveAmount, SchemaIncentiveStatus? incentiveStatus, SchemaIncentiveType? incentiveType, dynamic incentivizedItem, dynamic incomeLimit, dynamic provider, dynamic publisher, SchemaMonetaryAmount? purchasePriceLimit, SchemaPurchaseType? purchaseType, SchemaIncentiveQualifiedExpenseType? qualifiedExpense, String? validFrom, String? validThrough})
Create a new instance of SchemaFinancialIncentive

Properties

additionalType ↔ String?
//schema.org/docs/styleguide.html">style guide.
getter/setter pairinherited
alternateName ↔ String?
An alias for the item.
getter/setter pairinherited
areaServed ↔ dynamic
The geographic area where a service or offered item is provided.
getter/setter pair
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
eligibleWithSupplier ↔ SchemaOrganization?
The supplier of the incentivized item/service for which the incentive is valid for such as a utility company, merchant, or contractor.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
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
incentiveAmount ↔ dynamic
  • Use [SchemaQuantitativeValue] for absolute/percentage-based incentives applied on the price of a good/service.
  • Use [SchemaUnitPriceSpecification] for incentives based on a per-unit basis (e.g. net metering).
  • Use [SchemaLoanOrCredit] for loans/credits.
    • getter/setter pair
    incentiveStatus ↔ SchemaIncentiveStatus?
    The status of the incentive (active, on hold, retired, etc.).
    getter/setter pair
    incentiveType ↔ SchemaIncentiveType?
    The type of incentive offered (tax credit/rebate, tax deduction, tax waiver, subsidies, etc.).
    getter/setter pair
    incentivizedItem ↔ dynamic
    "Kenmore White 17" Microwave", } For multiple different incentivized items, use multiple SchemaDefinedTerm or SchemaProduct.
    getter/setter pair
    incomeLimit ↔ dynamic
    "USD", }
    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 pairinherited
    name ↔ String?
    The name of the item.
    getter/setter pairinherited
    owner ↔ dynamic
    A person or organization who owns this Thing.
    getter/setter pairinherited
    potentialAction ↔ SchemaAction?
    Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
    getter/setter pairinherited
    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
    publisher ↔ dynamic
    The publisher of the article in question.
    getter/setter pair
    purchasePriceLimit ↔ SchemaMonetaryAmount?
    Optional. The maximum price the item can have and still qualify for this offer.
    getter/setter pair
    purchaseType ↔ SchemaPurchaseType?
    Optional. The type of purchase the consumer must make in order to qualify for this incentive.
    getter/setter pair
    qualifiedExpense ↔ SchemaIncentiveQualifiedExpenseType?
    Optional. The types of expenses that are covered by the incentive. For example some incentives are only for the goods (tangible items) but the services (labor) are excluded.
    getter/setter pair
    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
    subjectOf ↔ dynamic
    A CreativeWork or Event about this Thing.
    getter/setter pairinherited
    url ↔ String?
    URL of the item.
    getter/setter pairinherited
    validFrom ↔ String?
    The date when the item becomes valid.
    getter/setter pair
    validThrough ↔ String?
    The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
    getter/setter pair

    Methods

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

    Operators

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