SchemaBuyAction class

The act of giving money to a seller in exchange for goods or services rendered. An agent buys an object, product, or service from a seller for a price. Reciprocal of SellAction. See https://schema.org/BuyAction

Constructors

SchemaBuyAction({dynamic seller, dynamic vendor, SchemaWarrantyPromise? warrantyPromise, dynamic price, String? priceCurrency, SchemaPriceSpecification? priceSpecification, SchemaActionStatusType? actionStatus, dynamic agent, String? endTime, SchemaThing? error, SchemaThing? instrument, dynamic location, SchemaThing? object, dynamic participant, dynamic provider, SchemaThing? result, String? startTime, dynamic target, 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 SchemaBuyAction

Properties

actionStatus ↔ SchemaActionStatusType?

Indicates the current disposition of the Action.

getter/setter pair

additionalType ↔ String?

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

getter/setter pair

agent ↔ dynamic

The direct performer or driver of the action (animate or inanimate). E.g. John wrote a book.

getter/setter pair

alternateName ↔ String?

An alias for the item.

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

endTime ↔ String?

The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

getter/setter pair

error ↔ SchemaThing?

For failed actions, more information on the cause of the failure.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

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

instrument ↔ SchemaThing?

The object that helped the agent perform the action. E.g. John wrote a book with a pen.

getter/setter pair

location ↔ dynamic

The location of, for example, where an event is happening, where an organization is located, or where an action takes place.

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

object ↔ SchemaThing?

The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read a book.

getter/setter pair

participant ↔ dynamic

Other co-agents that participated in the action indirectly. E.g. John wrote a book with Steve.

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

price ↔ dynamic

//www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.

getter/setter pair

priceCurrency ↔ String?

//en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".

getter/setter pair

priceSpecification ↔ SchemaPriceSpecification?

One or more detailed price specifications, indicating the unit price and delivery or payment charges.

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

result ↔ SchemaThing?

The result produced in the action. E.g. John wrote a book.

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

seller ↔ dynamic

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.

getter/setter pair

startTime ↔ String?

The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

getter/setter pair

subjectOf ↔ dynamic

A CreativeWork or Event about this Thing.

getter/setter pair

target ↔ dynamic

Indicates a target EntryPoint, or url, for an Action.

getter/setter pair

url ↔ String?

URL of the item.

getter/setter pair

vendor ↔ dynamic

'vendor' is an earlier term for 'seller'.

getter/setter pair

warrantyPromise ↔ SchemaWarrantyPromise?

The warranty promise(s) included in the offer.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJsonLd() → Map<String, dynamic>

Serialize SchemaBuyAction to JSON-LD

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited