API Docs for: 1.3.12
Show:

ConfirmAction Class

Schema.org/ConfirmAction The act of notifying someone that a future event/action is going to happen as expected.\n\nRelated actions:\n\n* [[CancelAction]]: The antonym of ConfirmAction.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

about

Thing

Schema.org/about The subject matter of the content.

actionStatus

ActionStatusType

Schema.org/actionStatus Indicates the current disposition of the Action.

additionalType

URL

Schema.org/additionalType 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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

agent

Person

Schema.org/agent The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.

alternateName

Text

Schema.org/alternateName An alias for the item.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription 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.

endTime

DateTime

Schema.org/endTime 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.\n\nNote that SchemaEvent uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

error

Thing

Schema.org/error For failed actions, more information on the cause of the failure.

event

SchemaEvent

Schema.org/event Upcoming or past event associated with this place, organization, or action.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], 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.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

inLanguage

Language

Schema.org/inLanguage The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]].

instrument

Thing

Schema.org/instrument The object that helped the agent perform the action. e.g. John wrote a book with a pen.

language

Language

Schema.org/language A sub property of instrument. The language used on this action.

location

PostalAddress

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

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

name

Text

Schema.org/name The name of the item.

object

Thing

Schema.org/object 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.

participant

Person

Schema.org/participant Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

recipient

Organization

Schema.org/recipient A sub property of participant. The participant who is at the receiving end of the action.

result

Thing

Schema.org/result The result produced in the action. e.g. John wrote a book.

sameAs

URL

Schema.org/sameAs 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.

startTime

DateTime

Schema.org/startTime 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.\n\nNote that SchemaEvent uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

target

EntryPoint

Schema.org/target Indicates a target EntryPoint for an Action.

url

URL

Schema.org/url URL of the item.