Action extends Thing

An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument.

Tags

see

http://schema.org/Action

Table of Contents

Constants

CONTEXT  = 'https://schema.org'

JSON-LD @context declaration for Schema.org.

Properties

$_from  : string|null

The metadata to indicates the edge 'from' identifier.

$_id  : null|string

The metadata identifier of the item.

$_key  : null|string

The metadata unique key identifier of the thing.

$_rev  : null|string

The metadata revision value of the thing.

$_to  : string|null

The metadata to indicates the edge 'to' identifier.

$actionProcess  : HowTo|null

Description of the process by which the action was performed.

$actionStatus  : ActionStatusType|DefinedTerm|null

Indicates the current disposition of the Action.

$active  : bool|null

The active flag.

$additionalType  : array<string|int, mixed>|string|null|object

An additionalType for the item.

$agent  : Person|Organization|string|null

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

$alternateName  : string|object|null

An alias for the item.

$created  : null|string|DateTime

Date of creation of the resource.

$description  : string|null

A short description of the item.

$disambiguatingDescription  : string|null

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  : null|string|int|DateTime

The endTime of something.

$error  : Thing|null

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

$hasPart  : string|Thing|array<string|int, mixed>|null

Indicates an item that this part of this item.

$id  : null|int|string

The unique identifier of the item.

$identifier  : string|null

The identifier of the item.

$image  : string|object|null

The image reference of this resource.

$instrument  : Thing|null

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

$isPartOf  : string|Thing|array<string|int, mixed>|null

Indicates an item that this item is part of.

$license  : string|object|null

A legal document giving official permission to do something with the resource.

$location  : Place|PostalAddress|string|VirtualLocation|null

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

$modified  : null|string|DateTime

Date on which the resource was changed.

$name  : int|string|null

The name of the item.

$object  : Thing|null

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  : array<string|int, mixed>|Person|Organization|null

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

$provider  : array<string|int, mixed>|Person|Organization|null

The service provider, service operator, or service performer; the goods producer.

$publisher  : string|array<string|int, mixed>|Person|Organization|null

The publisher of the resource.

$result  : Thing|null

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

$startTime  : null|string|int|DateTime

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.

$target  : string|EntryPoint|null

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

$url  : int|string|null

URL of the item.

$atContext  : string|null

The JSON-LD `@context` value.

$atType  : string|null

The JSON-LD `@type` value.

Methods

__construct()  : mixed

Constructor to hydrate public properties from an array or stdClass.

jsonSerialize()  : array<string|int, mixed>

Serializes the current object into a JSON-LD array.

withAtContext()  : $this

Sets the internal JSON-LD `@context` attribute.

withAtType()  : $this

Sets the internal JSON-LD `@type` attribute.

withJSONLDMeta()  : $this

Initializes both JSON-LD metadata: `@type` and `@context`.