UseAction: UseAction

Description Usage Arguments Value

Description

The act of applying an object to its intended purpose.

Usage

1
2
3
4
5
6
7
UseAction(id = NULL, target = NULL, startTime = NULL, result = NULL,
  participant = NULL, object = NULL, location = NULL, instrument = NULL,
  error = NULL, endTime = NULL, agent = NULL, actionStatus = NULL,
  expectsAcceptanceOf = NULL, url = NULL, sameAs = NULL,
  potentialAction = NULL, name = NULL, mainEntityOfPage = NULL,
  image = NULL, identifier = NULL, disambiguatingDescription = NULL,
  description = NULL, alternateName = NULL, additionalType = NULL)

Arguments

id

identifier for the object (URI)

target

(EntryPoint type.) Indicates a target EntryPoint for an Action.

startTime

(DateTime or DateTime type.) 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.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

result

(Thing type.) The result produced in the action. e.g. John wrote *a book*.

participant

(Person or Organization type.) Other co-agents that participated in the action indirectly. e.g. John wrote a book with *Steve*.

object

(Thing type.) 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*.

location

(Text or PostalAddress or Place or Text or PostalAddress or Place or Text or PostalAddress or Place type.) The location of for example where the event is happening, an organization is located, or where an action takes place.

instrument

(Thing type.) The object that helped the agent perform the action. e.g. John wrote a book with *a pen*.

error

(Thing type.) For failed actions, more information on the cause of the failure.

endTime

(DateTime or DateTime type.) 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*.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

agent

(Person or Organization type.) The direct performer or driver of the action (animate or inanimate). e.g. *John* wrote a book.

actionStatus

(ActionStatusType type.) Indicates the current disposition of the Action.

expectsAcceptanceOf

(Offer type.) An Offer which must be accepted before the user can perform the Action. For example, the user may need to buy a movie before being able to watch it.

url

(URL type.) URL of the item.

sameAs

(URL type.) 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.

potentialAction

(Action type.) Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

name

(Text type.) The name of the item.

mainEntityOfPage

(URL or CreativeWork type.) Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.

image

(URL or ImageObject type.) An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

identifier

(URL or Text or PropertyValue type.) 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](/docs/datamodel.html#identifierBg) for more details.

disambiguatingDescription

(Text type.) 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.

description

(Text type.) A description of the item.

alternateName

(Text type.) An alias for the item.

additionalType

(URL type.) 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.

Value

a list object corresponding to a schema:UseAction


cboettig/schemar documentation built on May 20, 2019, 4:27 p.m.