Activity Schema
Verbs
The following verbs are defined by this specification:
| Name | Identifier | Description |
|---|---|---|
| add | add |
Indicates that the actor has added the object to the target. For instance, adding a photo to an album. |
| cancel | cancel |
Indicates that the actor has canceled the object. For instance, canceling a calendar event. |
| checkin | checkin |
Indicates that the actor has checked-in to the object. For instance, a person checking-in to a Place. |
| delete | delete |
Indicates that the actor has deleted the object. This implies, but does not require, the permanent destruction of the object. |
| favorite | favorite |
Indicates that the actor marked the object as an item of special interest. |
| follow | follow |
Indicates that the actor began following the activity of the object. In most cases, the object will be a Person, but it can potentially be of any type that can sensibly generate activity. Processors MAY ignore (silently drop) successive identical "follow" activities. |
| give | give |
Indicates that the actor is giving an object to the target. Examples include one person giving a badge object to another person. The object identifies the object being given. The target identifies the receiver. |
| ignore | ignore |
Indicates that the actor has ignored the object. For instance, this verb may be used when an actor has ignored a friend request, in which case the object may be the request-friend activity. |
| invite | invite |
Indicates that the actor has invited the object, typically a person object, to join or participate in the object described by the target. The target could, for instance, be an event, group or a service. |
| join | join |
Indicates that the actor has become a member of the object. This specification only defines the meaning of this verb when its object is a group, though implementors SHOULD be prepared to handle other Object types a meaning MAY be provided by extension specifications. Processors MAY ignore (silently drop) successive identical "join" activities. |
| leave | leave |
Indicates that the actor has left the object. For instance a Person leaving a Group or checking-out of a Place. |
| like | like |
Indicates that the actor marked the object as an item of special interest. The "like" verb is considered to be an alias of "favorite". The two verb are semantically identical. |
| make-friend | make-friend |
Indicates the creation of a friendship that is reciprocated by the object. Since this verb implies an activity on the part of its object, processors MUST NOT accept activities with this verb unless they are able to verify through some external means that there is in fact a reciprocated connection. For example, a processor may have received a guarantee from a particular publisher that the publisher will only use this Verb in cases where a reciprocal relationship exists. |
| play | play |
Indicates that the actor spent some time enjoying the object. For example, if the object is a video this indicates that the subject watched all or part of the video. |
| receive | receive |
Indicates that the actor is receiving an object. Examples include a person receiving a badge object. The object identifies the object being received. |
| remove | remove |
Indicates that the actor has removed the object from the target. |
| remove-friend | remove-friend |
Indicates that the actor has removed the object from the collection of friends. |
| request-friend | request-friend |
Indicates the creation of a friendship that has not yet been reciprocated by the object. |
| rsvp-maybe | rsvp-maybe |
The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator. |
| rsvp-no | rsvp-no |
The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator. |
| rsvp-yes | rsvp-yes |
The "positive RSVP" verb indicates that the actor has made a positive RSVP for an object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator. |
| save | save |
Indicates that the actor has called out the object as being of interest primarily to him- or herself. Though this action MAY be shared publicly, the implication is that the object has been saved primarily for the actor's own benefit rather than to show it to others as would be indicated by the "share" verb. |
| share | share |
Indicates that the actor has called out the object to readers. In most cases, the actor did not create the object being shared, but is instead drawing attention to it. |
| stop-following | stop-following |
Indicates that the actor has stopped following the object. |
| tag | tag |
Indicates that the actor has identified the presence of a target inside another object. For example, the actor may have specified that a particular user appears in a photo. The target of the "tag" verb gives the object in which the tag has been added. For example, if a user appears in a photo, the object is the user and the target is the photo. |
| unfavorite | unfavorite |
Indicates that the actor has removed the object from the collection of favorited items. |
| unlike | unlike |
Indicates that the actor has removed the object from the collection of liked items. |
| unsave | unsave |
Indicates that the actor has removed the object from the collection of saved items. |
| update | update |
The "update" verb indicates that the actor has modified the object. Implementors SHOULD use verbs such as "post" where the actor is adding new items to a collection or similar. Update is reserved for modifications to existing object or data such as changing a user's profile information. |
Object Types
The following object types are defined by this specification:
| Name | Identifier | Description |
|---|---|---|
| Article | article |
An article, such as a news article, knowledge base entry or similar construct |
| Audio | audio |
An item of audio content |
| Badge | badge |
A badge or award given to an entity |
| Bookmark | bookmark |
A pointer to a URL |
| Collection | collection |
A generic collection of objects of any type. |
| Comment | comment |
A textual response to another object |
| Event | event |
An event that occurs in a certain place during a particular interval of time |
| File | file |
A document or other file with no additional machine-readable semantics |
| Group | group |
A social networking group |
| Image | image |
A graphical image |
| Note | note |
A short-form text message |
| Person | person |
A user account |
| Place | place |
A location on Earth. |
| Product | product |
A commercial good or service |
| Question | question |
A question or poll |
| Review | review |
A primarily prosed-based commentary on another object |
| Service | service |
Something that provides a service to others |
| Video | video |
An item of video content |
Activity Components
The following activity components are defined by this specification:
| Name | JSON Property | Description |
|---|---|---|
| Location | location |
An object construct representing the location at which the activity occured. |
| Mood | mood |
A human-readable keyword or short phrase describing the mood of the actor at the time the activity was performed. |
| Rating | rating |
A rating given as a number between 1.0 and 5.0 inclusive with one decimal place of precision. |
| Source | source |
A reference to the original source of an object or activity. |
| Tags | tags |
A listing of the objects that have been associated with a particular object using the tag verb. |
Object Components
The following object components are defined by this specification:
| Name | JSON Property | Description |
|---|---|---|
| Location | An object construct representing the location at which the activity occured. | |
| Mood | A human-readable keyword or short phrase describing the mood of the actor at the time the activity was performed. | |
| Rating | A rating given as a number between 1.0 and 5.0 inclusive with one decimal place of precision. | |
| Source | A reference to the original source of an object or activity. | |
| Tags | A listing of the objects that have been associated with a particular object using the tag verb. |