RemoveProperties

Type Alias RemoveProperties 

Source
pub type RemoveProperties = ActorAndObjectOptOthers;
Expand description

Properties for the Remove activity

Aliased Type§

pub struct RemoveProperties {
    pub actor: Value,
    pub object: Value,
    pub origin: Option<Value>,
    pub target: Option<Value>,
}

Fields§

§actor: Value

Describes one or more entities that either performed or are expected to perform the activity.

Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.

  • Range: Object | Link
  • Functional: false
§object: Value

When used within an Activity, describes the direct object of the activity.

For instance, in the activity “John added a movie to his wishlist”, the object of the activity is the movie added.

  • Range: Object | Link
  • Functional: false
§origin: Option<Value>

Describes an indirect object of the activity from which the activity is directed.

The precise meaning of the origin is the object of the English preposition “from”. For instance, in the activity “John moved an item to List B from List A”, the origin of the activity is “List A”.

  • Range: Object | Link
  • Functional: false
§target: Option<Value>

Describes the indirect object, or target, of the activity.

The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition “to”. For instance, in the activity “John added a movie to his wishlist”, the target of the activity is John’s wishlist. An activity can have more than one target

  • Range: Object | Link
  • Functional: false