Skip to content

Latest commit

 

History

History
2961 lines (2847 loc) · 95.5 KB

activity-schema.md

File metadata and controls

2961 lines (2847 loc) · 95.5 KB
Raw

Activity Streams - Base Schema

This document presents a base set of Object types and Verbs for use with Activity Streams.

Introduction

This document presents a base set of object types and verbs for use with Activity Streams.

Notational Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119][RFC2119].

This specification allows the use of IRIs RFC3987. Every URI RFC3986 is also an IRI, so a URI MAY be used wherever an IRI is named. When an IRI that is not also a URI is given for dereferencing, it MUST be mapped to a URI using the steps in Section 3.1 of RFC3987. When an IRI is serving as an identifier, it MUST NOT be so mapped.

Unless otherwise specified, all properties specifying date and time values MUST conform to the "date-time" production in RFC3339. In addition, an uppercase "T" character MUST be used to separate date and time, and an uppercase "Z" character MUST be present in the absence of a numeric time zone offset.

Verbs

This specification defines the following core verbs in addition to the default post verb that is defined in Section 6 of [activitystreams][activitystreams]:
VerbDescriptionExample
accept Indicates that that the actor has accepted the object. For instance, a person accepting an award, or accepting an assignment. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "accept",
    "object": {
      "objectType": "job", 
      "displayName": "Director of Marketing"},
    "title": "Sally accepted the Director of Marketing job."
  }
access Indicates that the actor has accessed the object. For instance, a person accessing a room, or accessing a file. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "access",
    "object": {
      "objectType": "file", 
      "displayName": "4Q2012 Sales Forecast.xls"},
    "published": "2012-12-12T12:12:12Z",
    "title": "Joe accessed the file \"4Q2012 Sales Forecast.xls\""
  }
acknowledge Indicates that the actor has acknowledged the object. This effectively signals that the actor is aware of the object's existence. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "acknowledge",
    "object": {
      "objectType": "issue", 
      "displayName": "#123: There is a problem with the build"},
    "Sally acknowledged Issue #123"
  }
add Indicates that the actor has added the object to the target. For instance, adding a photo to an album. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "add",
    "object": {
      "objectType": "image", 
      "displayName": "My cat", 
      "fullImage": {
        "url": "http://example.org/cat.jpg"
      }
    },
    "target": {
      "objectType": "collection",
      "displayName": "Joe's Photo Album",
      "objectTypes": ["image"]
    }
  }
agree Indicates that the actor agrees with the object. For example, a person agreeing with an argument, or expressing agreement with a particular issue. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "agree",
    "object": {
      "objectType": "article", 
      "displayName": "Some Random Article Online"}
  }
append Indicates that the actor has appended the object to the target. For instance, a person appending a new record to a database. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "append",
    "object": {
      "content": "This is some text"
    }
    "target": {
      "objectType": "file", 
      "displayName": "log.txt"}
  }
approve Indicates that the actor has approved the object. For instance, a manager might approve a travel request. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "approve",
    "object": {
      "objectType": "task", 
      "actor": {"displayName": "Joe"},
      "verb": "join",
      "object": {
        "objectType":"group", 
        "displayName": "Administrators"}
    }
  }
archive Indicates that the actor has archived the object. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "archive",
    "object": {
      "objectType": "file", 
      "displayName": "4Q2012 Sales Forecast.xls"}
  }
assign Indicates that the actor has assigned the object to the target. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "assign",
    "object": {
      "objectType": "issue", 
      "displayName": "Issue #123: Some Issue"},
    "target": {
      "objectType": "person",
      "displayName": "Joe"
    },
    "title": "Sally assigned Issue #123 to Joe"
  }
at Indicates that the actor is currently located at the object. For instance, a person being at a specific physical location. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "at",
    "object": {
      "objectType": "place",
      "displayName": "Acme, Co."
    }
  }
attach Indicates that the actor has attached the object to the target.For instance, a person attaching a file to a wiki page or an email. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Sally"},
    "verb": "attach",
    "object": {
      "objectType": "binary",
      "data": "dGhpcyBpcyB1bmNvbXByZXNzZWQgZGF0YQo="
    },
    "target": {
      "objectType": "issue",
      "displayName": "Issue #123"
    },
    "title": "Sally added an attachment to Issue #123"
  }
attend Indicates that the actor has attended the object. For instance, a person attending a meeting. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "attend",
  "object": {
    "objectType": "event",
    "displayName": "Sally's Meeting"
  }
}
author Indicates that the actor has authored the object. Note that this is a more specific form of the verb "create". 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "author",
  "object": {
    "objectType": "file",
    "displayName": "4Q2012 Sales Forecast.xls"
  }
}
authorize Indicates that the actor has authorized the object. If a target is specified, it means that the authorization is specifically in regards to the target. For instance, a service can authorize a person to access a given application; in which case the actor is the service, the object is the person, and the target is the application. In contrast, a person can authorize a request; in which case the actor is the person and the object is the request and there might be no explicit target. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "authorize",
  "object": {
    "objectType": "task",
    "actor": {
      "objectType": "person",
      "displayName": "Sally"
    },
    "verb": "access",
    "object": {
      "objectType": "place",
      "displayName": "Joe's Home"
    }
  }
}
borrow Indicates that the actor has borrowed the object. If a target is specified, it identifies the entity from which the object was borrowed. For instance, if a person borrows a book from a library, the person is the actor, the book is the object and the library is the target. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "borrow",
  "object": {
    "objectType": "book",
    "displayName": "Cloud Atlas"
  },
  "target": {
    "objectType": "person",
    "displayName": "Joe"
  },
  "title": "Sally borrowed the book 'Cloud Atlas' from Joe"
}
build Indicates that the actor has built the object. For example, if a person builds a model or compiles code. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "build",
  "object": {
    "objectType": "application",
    "displayName": "MyApp Builder 12345"
  }
}
cancel Indicates that the actor has canceled the object. For instance, canceling a calendar event. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "cancel",
  "object": {
    "objectType": "offer",
    "displayName": "Free Money!"
  },
  "title": "Sally cancelled the offer for free money."
}
close Indicates that the actor has closed the object. For instance, the object could represent a ticket being tracked in an issue management system. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "close",
  "object": {
    "objectType": "issue",
    "displayName": "Issue #123"
  },
  "title": "Joe closed issue #123"
}
complete Indicates that the actor has completed the object. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "complete",
  "object": {
    "objectType": "process",
    "displayName": "Some long process"
  }
}
confirm Indicates that the actor has confirmed or agrees with the object. For instance, a software developer might confirm an issue reported against a product. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "confirm",
  "object": {
    "objectType": "issue",
    "displayName": "Issue #123"
  },
  "title": "Joe confirmed issue #123"
}
consume Indicates that the actor has consumed the object. The specific meaning is dependent largely on the object's type. For instance, an actor may "consume" an audio object, indicating that the actor has listened to it; or an actor may "consume" a book, indicating that the book has been read. As such, the "consume" verb is a more generic form of other more specific verbs such as "read" and "play". 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "consume",
  "object": {
    "objectType": "product",
    "displayName": "Some amazing product"
  }
}
checkin Indicates that the actor has checked-in to the object. For instance, a person checking-in to a Place. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "checkin",
  "object": {
    "objectType": "place",
    "displayName": "Acme, Co"
  },
  "title": "Joe checked in at Acme, Co"
}
create Indicates that the actor has created the object. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "create",
  "object": {
    "objectType": "product",
    "displayName": "Some amazing product"
  }
}
delete Indicates that the actor has deleted the object. This implies, but does not require, the permanent destruction of the object. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "delete",
  "object": {
    "objectType": "file",
    "displayName": "4Q2012 Sales Forecast.xls"
  },
  "title": "Joe is probably going to get fired."
}
deliver Indicates that the actor has delivered the object. For example, delivering a package. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "deliver",
  "object": {
    "objectType": "note",
    "displayName": "Bad News",
    "content": "Joe deleted the sales forecast"
  },
  "target": {
    "objectType": "person",
    "displayName": "Joe's Boss"
  }
}
deny Indicates that the actor has denied the object. For example, a manager may deny a travel request. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "deny",
  "object": {
    "objectType": "task",
    "actor": {
      "objectType": "person",
      "displayName": "Joe"
    },
    "verb": "delete",
    "object": {
      "objectType": "file",
      "displayName": "4Q2012 Sales Forecast.xls"
    }
  }
}
disagree Indicates that the actor disagrees with the object. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "disagree",
  "object": {
    "actor": {
      "objectType": "person", 
      "displayName": "Joe"},
    "verb": "deny",
    "object": {
      "objectType": "task",
      "actor": {
        "objectType": "person",
        "displayName": "Joe"
      },
      "verb": "delete",
      "object": {
        "objectType": "file",
        "displayName": "4Q2012 Sales Forecast.xls"
      }
    }
  }
}
dislike Indicates that the actor dislikes the object. Note that the "dislike" verb is distinct from the "unlike" verb which assumes that the object had been previously "liked". 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "dislike",
  "object": {
    "objectType": "person",
    "displayName": "Sally"
  }
}
experience Indicates that the actor has experienced the object in some manner. Note that, depending on the specific object types used for both the actor and object, the meaning of this verb can overlap that of the "consume" and "play" verbs. For instance, a person might "experience" a movie; or "play" the movie; or "consume" the movie. The "experience" verb can be considered a more generic form of other more specific verbs as "consume", "play", "watch", "listen", and "read" 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally"},
  "verb": "experience",
  "object": {
    "objectType": "event",
    "displayName": "Disciplinary Action for Joe"
  }
}
favorite Indicates that the actor marked the object as an item of special interest. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe's Boss"},
  "verb": "favorite",
  "object": {
    "objectType": "person",
    "displayName": "Sally"
  }
}
find Indicates that the actor has found the object. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "find",
  "object": {
    "objectType": "application",
    "displayName": "Unapproved Software Application"
  },
  "location": {
    "objectType": "place",
    "displayName": "Sally's Computer"
  }
}
flag-as-inappropriate Indicates that the actor has flagged the object as being inappropriate for some reason. When using this verb, the context property can be used to provide additional detail about why the object has been flagged. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Sally's Boss"},
  "verb": "flag-as-inappropriate",
  "object": {
    "objectType": "application",
    "displayName": "Unapproved Software Application",
    "location": {
      "displayName": "Sally's Computer"
    }
  },
  "context": {
    "objectType": "issue",
    "displayName": "Issue #125",
    "types": ["http://example.org/violation-of-corporate-policy"]
  }
}
follow Indicates that the actor began following the activity of the object. In most cases, the objectType 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. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe"},
  "verb": "follow",
  "object": {
    "objectType": "issue",
    "displayName": "Issue #125"
  }
}
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. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Joe's Boss"},
  "verb": "give",
  "object": {
    "objectType": "note",
    "displayName": "Notice of Employment Termination"
  },
  "target": {
    "objectType": "collection",
    "items": [
      {
        "objectType": "person",
        "displayName": "Joe"
      },
      {
        "objectType": "person",
        "displayName": "Sally"
      }
    ]
  }
}
host Indicates that the actor is hosting the object. As in hosting an event, or hosting a service. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Bob"},
  "verb": "host",
  "object": {
    "objectType": "event",
    "displayName": "Job Interview"
  }
}
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. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Laura"},
  "verb": "ignore",
  "object": {
    "objectType": "note",
    "displayName": "Joe's request for his job back."
  }
}
insert Indicates that the actor has inserted the object into the target. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Bob"},
  "verb": "insert",
  "object": {
    "objectType": "note",
    "displayName": "Notes about Employee Disciplinary Actions"
  },
  "target": {
    "objectType": "file",
    "displayName": "2013 Corporate Policy Updates.doc"
  }
}
install Indicates that the actor has installed the object, as in installing an application. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Laura"},
  "verb": "install",
  "object": {
    "objectType": "application",
    "displayName": "Approved Software Scanning Tool",
    "location": {
      "displayName": "All computers in Building A"
    }
  }
}
interact Indicates that the actor has interacted with the object. For instance, when one person interacts with another. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Bob"},
  "verb": "interact",
  "object": {
    "objectType": "person",
    "displayName": "Laura"
  },
  "title": "Bob called Laura."
}
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. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Laura"},
  "verb": "invite",
  "object": {
    "objectType": "person",
    "displayName": "Mark"
  },
  "target": {
    "objectType": "event",
    "displayName": "Job Interview"
  }
}
join Indicates that the actor has become a member of the object. This specification only defines the meaning of this verb when the object of the Activity has an objectType of group, though implementors need to be prepared to handle other types of objects. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Mark"},
  "verb": "join",
  "object": {
    "objectType": "organization",
    "displayName": "Acme, Co"
  }
}
leave Indicates that the actor has left the object. For instance, a Person leaving a Group or checking-out of a Place. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Mark"},
  "verb": "leave",
  "object": {
    "objectType": "organization",
    "displayName": "Other, Co"
  }
}
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. 
{
  "actor": {
    "objectType": "person", 
    "displayName": "Laura"},
  "verb": "like",
  "object": {
    "actor": {
      "objectType": "person", 
      "displayName": "Mark"},
    "verb": "join",
    "object": {
      "objectType": "organization",
      "displayName": "Acme, Co"
    }
  }
}
listen Indicates that the actor has listened to the object. This is typically only applicable for objects representing audio content, such as music, an audio-book, or a radio broadcast. The "listen" verb is a more specific form of the "consume", "experience" and "play" verbs. 
  {
    "actor": {
      "objectType": "person", 
      "displayName": "Mark"},
    "verb": "listen",
    "object": {
      "objectType": "audio",
      "displayName": "Welcome to the Company (Podcast).mp3"
    }
  }
lose Indicates that the actor has lost the object. For instance, if a person loses a game. 
  {
    "actor": {
      "objectType": "organization",
      "displayName": "New York Yankees"
    },
    "verb": "lose",
    "object": {
      "objectType": "game",
      "displayName": "World Series"
    }
  }
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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "make-friend",
    "object": {
      "objectType": "person",
      "displayName": "Laura"
    }
  }
open Indicates that the actor has opened the object. For instance, the object could represent a ticket being tracked in an issue management system. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "open",
    "object": {
      "objectType": "issue",
      "displayName": "Issue #126"
    }
  }
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. The "play" verb is a more specific form of the "consume" verb. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "play",
    "object": {
      "objectType": "audio",
      "displayName": "Call Me Maybe"
    }
  }
present Indicates that the actor has presented the object. For instance, when a person gives a presentation at a conference. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "present",
    "object": {
      "objectType": "file",
      "displayName": "1Q2013 Sales Forecast.ppt"
    }
  }
purchase Indicates that the actor has purchased the object. If a target is specified, in indicates the entity from which the object was purchased. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "purchase",
    "object": {
      "objectType": "video",
      "displayName": "The Avengers"
    },
    "title": "Mark purchased the movie, The Avengers"
  }
qualify Indicates that the actor has qualified for the object. If a target is specified, it indicates the context within which the qualification applies. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "qualify",
    "object": {
      "objectType": "offer",
      "displayName": "Free Money!"
    }
  }
read Indicates that the actor read the object. This is typically only applicable for objects representing printed or written content, such as a book, a message or a comment. The "read" verb is a more specific form of the "consume", "experience" and "play" verbs. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "read",
    "object": {
      "objectType": "book",
      "displayName": "Cloud Atlas"
    }
  }
receive Indicates that the actor is receiving an object. Examples include a person receiving a badge object. The object identifies the object being received. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "receive",
    "object": {
      "objectType": "badge",
      "displayName": "Most Checkins in 24 hours"
    },
    "title": "Laura was awarded a badge 
      for \"Most Checkins in 24 hours\""
  }
reject Indicates that the actor has rejected the object. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "reject",
    "object": {
      "objectType": "issue",
      "displayName": "Issue #126"
    }
  }
remove Indicates that the actor has removed the object from the target. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "remove",
    "object": {
      "objectType": "image",
      "displayName": "Cat Photo",
      "fullImage": {
        "url": "http://example.org/cats.jpg"
      }
    },
    "target": {
      "objectType": "collection",
      "displayName": "Cat Photo Album",
      "objectTypes": ["image"]
    }
  }
remove-friend Indicates that the actor has removed the object from the collection of friends. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "remove-friend",
    "object": {
      "objectType": "person",
      "displayName": "Laura"
    }
  }
replace Indicates that the actor has replaced the target with the object. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "replace",
    "object": {
      "objectType": "file",
      "displayName": "Updated 1Q2014 Sales Forecast.xls"
    },
    "target": {
      "objectType": "file",
      "displayName": "1Q2014 Sales Forecast.xls"
    }
  }
request Indicates that the actor has requested the object. If a target is specified, it indicates the entity from which the object is being requested. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "request",
    "object": {
      "objectType": "task",
      "actor": {
        "objectType": "person",
        "displayName": "Mark"
      },
      "verb": "join", 
      "object": {
        "objectType": "event",
        "displayName": "The Big Meeting"
      }
    }
  }
request-friend Indicates the creation of a friendship that has not yet been reciprocated by the object. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "request-friend",
    "object": {
      "objectType": "person",
      "displayName": "Laura"
    }
  }
resolve Indicates that the actor has resolved the object. For instance, the object could represent a ticket being tracked in an issue management system. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "resolve",
    "object": {
      "objectType": "issue",
      "displayName": "Issue #126"
    }
  }
return Indicates that the actor has returned the object. If a target is specified, it indicates the entity to which the object was returned. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "return",
    "object": {
      "objectType": "book",
      "displayName": "Cloud Atlas"
    },
    "target": {
      "objectType": "person",
      "displayName": "Laura"
    }
  }
retract Indicates that the actor has retracted the object. For instance, if an actor wishes to retract a previously published activity, the object would be the previously published activity that is being retracted. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "retract",
    "object": {
      "actor": {
        "objectType": "person",
        "displayName": "Mark"
      },
      "verb": "return",
      "object": {
        "objectType": "book",
        "displayName": "Cloud Atlas"
      },
      "target": {
        "objectType": "person",
        "displayName": "Laura"
      }
    }
  }
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 need to be prepared to handle other object types. 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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "rsvp-maybe",
    "object": {
      "objectType": "event",
      "displayName": "The Big Meeting"
    },
    "title": "Laura might attend The Big Meeting"
  }
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 need to be prepared to handle other object types. 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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "rsvp-no",
    "object": {
      "objectType": "event",
      "displayName": "The Big Meeting"
    },
    "title": "Mark will not attend the Big Meeting"
  }
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 need to be prepared to handle other object types. 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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "rsvp-yes",
    "object": {
      "objectType": "event",
      "displayName": "The Big Meeting"
    },
    "title": "Laura will attend the Big Meeting"
  }
satisfy Indicates that the actor has satisfied the object. If a target is specified, it indicate the context within which the object was satisfied. For instance, if a person satisfies the requirements for a particular challenge, the person is the actor; the requirement is the object; and the challenge is the target. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "satisfy",
    "object": {
      "objectType": "http://example.org/condition",
      "displayName": "Some Condition"
    },
    "target": {
      "objectType": "http://example.org/parole",
      "displayName": "Terms of Parole"
    },
    "title": "Mark has satisfied a condition of his parole."
  }
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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "save",
    "object": {
      "objectType": "note",
      "displayName": "A note about something important"
    },
    "target": {
      "objectType": "collection",
      "displayName": "Laura's Reading List"
    },
    "title": "Laura saved the note to her reading list"
  }
schedule Indicates that the actor has scheduled the object. For instance, scheduling a meeting. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "schedule",
    "object": {
      "objectType": "event",
      "displayName": "The Big Meeting"
    }
  }
search Indicates that the actor is or has searched for the object. If a target is specified, it indicates the context within which the search is or has been conducted. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "search",
    "object": {
      "objectType": "place",
      "displayName": "Big Hotel",
      "address": {
        "locality": "New York",
        "region": "NY"
      }
    },
    "title": "Laura searched for a hotel in New York City, NY"
  }
sell Indicates that the actor has sold the object. If a target is specified, it indicates the entity to which the object was sold. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "sell",
    "object": {
      "objectType": "product",
      "displayName": "A cool product"
    },
    "target": {
      "objectType": "person",
      "displayName": "Laura"
    }
  }
send Indicates that the actor has sent the object. If a target is specified, it indicates the entity to which the object was sent. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "send",
    "object": {
      "objectType": "note",
      "content": "Thank you for the cool product."
    },
    "target": {
      "objectType": "person",
      "displayName": "Mark"
    }
  }
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. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "share",
    "object": {
      "objectType": "note",
      "displayName": "An important note"
    },
    "title": "Mark shared an important note."
  }
sponsor Indicates that the actor has sponsored the object. If a target is specified, it indicates the context within which the sponsorship is offered. For instance, a company can sponsor an event; or an individual can sponsor a project; etc. 
  {
    "actor": {
      "objectType": "organization",
      "displayName": "Acme, Co"
    },
    "verb": "sponsor",
    "object": {
      "objectType": "game",
      "displayName": "World Series"
    },
    "title": "Acme, Co sponsored the World Series"
  }
start Indicates that the actor has started the object. For instance, when a person starts a project. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "start",
    "object": {
      "objectType": "process",
      "displayName": "A Long Running Process"
    }
  }
stop-following Indicates that the actor has stopped following the object. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "stop-following",
    "object": {
      "objectType": "person",
      "displayName": "Mark"
    }
  }
submit Indicates that the actor has submitted the object. If a target is specified, it indicates the entity to which the object was submitted. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "submit",
    "object": {
      "objectType": "issue",
      "displayName": "Issue #127"
    }
  }
tag Indicates that the actor has associated the object with the target. For example, if the actor specifies that a particular user appears in a photo. the object is the user and the target is the photo. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "tag",
    "object": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "target": {
      "objectType": "image",
      "displayName": "Pictures of my cats"
    }
  }
terminate Indicates that the actor has terminated the object. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "terminate",
    "object": {
      "objectType": "process",
      "displayName": "A long running process"
    }
  }
tie Indicates that the actor has neither won or lost the object. This verb is generally only applicable when the object represents some form of competition, such as a game. 
  {
    "actor": {
      "objectType": "collection",
      "items": [
        {
          "objectType": "organization",
          "displayName": "New York Giants"
        },
        {
          "objectType": "organization",
          "displayName": "Oakland Raiders"
        }
      ]
    },
    "verb": "tie",
    "object": {
      "objectType": "game",
      "displayName": "Super Bowl"
    }
  }
unfavorite Indicates that the actor has removed the object from the collection of favorited items. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "unfavorite",
    "object": {
      "objectType": "article",
      "displayName": "Some article"
    }
  }
unlike Indicates that the actor has removed the object from the collection of liked items. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "unlike",
    "object": {
      "objectType": "article",
      "displayName": "Some article"
    }
  }
unsatisfy Indicates that the actor has not satisfied the object. If a target is specified, it indicates the context within which the object was not satisfied. For instance, if a person fails to satisfy the requirements of some particular challenge, the person is the actor; the requirement is the object and the challenge is the target. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "unsatisfy",
    "object": {
      "objectType": "http://example.org/condition",
      "displayName": "Some Condition"
    },
    "target": {
      "objectType": "http://example.org/parole",
      "displayName": "Terms of Parole"
    },
    "title": "Mark has not satisfied a condition of his parole."
  }
unsave Indicates that the actor has removed the object from the collection of saved items. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "unsave",
    "object": {
      "objectType": "article",
      "displayName": "Some article"
    }
  }
unshare Indicates that the actor is no longer sharing the object. If a target is specified, it indicates the entity with whom the object is no longer being shared. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "unshare",
    "object": {
      "objectType": "article",
      "displayName": "Some article"
    }
  }
update The "update" verb indicates that the actor has modified the object. Use of the "update" verb is generally reserved to indicate modifications to existing objects or data such as changing an existing user's profile information. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "update",
    "object": {
      "objectType": "article",
      "displayName": "Some article"
    }
  }
use Indicates that the actor has used the object in some manner. 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Laura"
    },
    "verb": "use",
    "object": {
      "objectType": "product",
      "displayName": "A cool product"
    }
  }
watch Indicates that the actor has watched the object. This verb is typically applicable only when the object represents dynamic, visible content such as a movie, a television show or a public performance. This verb is a more specific form of the verbs "experience", "play" and "consume". 
  {
    "actor": {
      "objectType": "person",
      "displayName": "Mark"
    },
    "verb": "watch",
    "object": {
      "objectType": "video",
      "displayName": "Some random movie"
    }
  }
win Indicates that the actor has won the object. This verb is typically applicable only when the object represents some form of competition, such as a game. 
  {
    "actor": {
      "objectType": "organization",
      "displayName": "Arizona Diamond Backs"
    },
    "verb": "win",
    "object": {
      "objectType": "game",
      "displayName": "World Series"
    }
  }

Object Types

The table contains the core set of common objectTypes in addition to the "activity" objectType defined in Section 7 of [activitystreams][activitystreams].

All Activity Stream Objects inherit the same fundamental set of basic properties as defined in section 3.4 of activitystreams. In addition to these, objects of any specific type are permitted to introduce additional optional or required properties that are meaningful to objects of that type.

Object TypeDescription
alert Represents any kind of significant notification.
application Represents any kind of software application.
article Represents objects such as news articles, knowledge base entries, or other similar construct. Such objects generally consist of paragraphs of text, in some cases incorporating embedded media such as photos and inline hyperlinks to other resources.
audio Represents audio content of any kind. Objects of this type MAY contain an additional property as specified here.
badge Represents a badge or award granted to an object (typically a person object)
binary Objects of this type are used to carry arbirary Base64-encoded binary data within an Activity Stream object. It is primarily intended to attach binary data to other types of objects through the use of the attachments property. Objects of this type will contain the additional properties specified here.
bookmark Represents a pointer to some URL -- typically a web page. In most cases, bookmarks are specific to a given user and contain metadata chosen by that user. Bookmark Objects are similar in principle to the concept of bookmarks or favorites in a web browser. A bookmark represents a pointer to the URL, not the URL or the associated resource itself. Objects of this type SHOULD contain an additional targetUrl property whose value is a String containing the IRI of the target of the bookmark.
collection Represents a generic collection of objects of any type. This object type can be used, for instance, to represent a collection of files like a folder; a collection of photos like an album; and so forth. Objects of this type MAY contain an additional objectTypes property whose value is an Array of Strings specifying the expected objectType of objects contained within the collection.
comment Represents a textual response to another object. Objects of this type MAY contain an additional inReplyTo property whose value is an Array of one or more other Activity Stream Objects for which the object is to be considered a response.
device Represents a device of any type.
event Represents an event that occurs at a certain location during a particular period of time. Objects of this type MAY contain the additional properties specified here.
file Represents any form of document or file. Objects of this type MAY contain an additional fileUrl property whose value a dereferenceable IRI that can be used to retrieve the file; and an additional mimeType property whose value is the MIME type of the file described by the object.
game Represents a game or competition of any kind.
group Represents a grouping of objects in which member objects can join or leave. Objects of this type MAY contain the additional properties specified here.
image Represents a graphical image. Objects of this type MAY contain an additional fullImage property whose value is an Activity Streams Media Link to a "full-sized" representation of the image.
issue Represents a report about a problem or situation that needs to be resolved. For instance, the issue object can be used to represent reports detailing software defects, or reports of acceptable use violations, and so forth. Objects of this type MAY contain the additional properties specified here.
job Represents information about a job or a job posting.
note Represents a short-form text message. This object is intended primarily for use in "micro-blogging" scenarios and in systems where users are invited to publish short, often plain-text messages whose useful lifespan is generally shorter than that of an article of weblog entry. A note is similar in structure to an article, but typically does not have a title or distinct paragraphs and tends to be much shorter in length.
offer Represents an offer of any kind.
organization Represents an organization of any kind.
page Represents an area, typically a web page, that is representative of, and generally managed by a particular entity. Such areas are usually dedicated to displaying descriptive information about the entity and showcasing recent content such as articles, photographs and videos. Most social networking applications, for example, provide individual users with their own dedicated "profile" pages. Several allow similar types of pages to be created for commercial entities, organizations or events. While the specific details of how pages are implemented, their characteristics and use may vary, the one unifying property is that they are typically "owned" by a single entity that is represented by the content provided by the page itself.
permission Represents a permission that can be granted to an individual. For instance, a person can be granted permission to modify a file. Objects of this type MAY contain the additional properties specified here.
person Represents an individual person.
place Represents a physical location. Locations can be represented using geographic coordinates, a physical address, a free-form location name, or any combination of these. Objects of this type MAY contain the additional properties specified here.
process Represents any form of process. For instance, a long-running task that is started and expected to continue operating for a period of time.
product Represents a commercial good or service. Objects of this type MAY contain an additional fullImage property whose value is an Activity Streams Media Link to an image resource representative of the product.
question Represents a question or a poll. Objects of this type MAY contain an additional options property whose value is an Array of possible answers to the question in the form of Activity Stream objects of any type.
review Represents a primarily prose-based commentary on another object. Objects of this type MAY contain a rating property as specified here.
role Represents a role assigned to some entity within a specific context. For instance, a person be assigned the "admin" role within a particular group. Objects of this type MAY contain the additional properties specified here.
service Represents any form of hosted or consumable service that performs some kind of work or benefit for other entities. Examples of such objects include websites, businesses, etc.
task Represents an activity that has yet to be completed. Objects of this type can contain additional properties as specified here.
team Represents a team of any type.
video Represents video content of any kind. Objects of this type MAY contain additional properties as specified here.

Audio and Video Objects

In addition to the core properties shared by all Activity Streams Objects, audio and video objects MAY contain the following properties:
PropertyValueDescription
embedCode String A fragment of HTML markup that, when embedded within another HTML page, provides an interactive user-interface for viewing or listening to the video or audio stream.
stream Media Link An Activity Streams Media Link to the video or audio content itself.

For example:

  {
    "objectType": "video",
    "displayName": "Cute little kittens",
    "embedCode": "<video width="320" height="240" controls="controls">...</video>",
    "stream": {
      "url": "http://example.org/my_video.mpg"
    }
  }

Binary Objects

The binary object type is used to carry arbitrary Base64-encoded binary data within an Activity Stream object. It is primarily intended to attach binary data to other object types through the use of the attachments property.

In addition to the core properties shared by all Activity Streams Objects, binary objects MAY contain the following properties:

PropertyValueDescription
compression String An optional token identifying a compression algorithm applied to the binary data prior to Base64-encoding. Possible algorithms are "deflate" and "gzip", respectively indicating the use of the compression mechanisms defined by RFC 1951 and RFC 1952. Additional compression algorithms MAY be used but are not defined by this specification. Note that previous versions of this specification allowed for multiple compression algorithms to be applied and listed using a comma-separated format. The use of multiple compressions is no longer permitted.
data String The URL-Safe Base64-encoded representation of the binary data
fileUrl String An optional IRI for the binary data described by this object.
length Non-negative Integer The total number of unencoded, uncompressed octets contained within the "data" field.
md5 String An optional MD5 checksum calculated over the unencoded, uncompressed octets contained within the "data" field
mimeType String The MIME Media Type of the binary data contained within the object.

Note that the binary and file objectTypes are conceptually related. The key difference between the two lies in the fact that the "file" objectType is more representative of the abstract description of a file or document while the binary objectType represents the actual, concrete stream of octets that make up the content.

Because of their close relationship, it is possible for the file objectType to share the same basic properties as the binary objectType. That is, a file MAY also have properties such as length, mimeType, and md5.

For example

  {
    "objectType": "note",
    "displayName": "A note with a binary attachment",
    "attachments": [
      {
        "objectType": "binary",
        "data": "dGhpcyBpcyB1bmNvbXByZXNzZWQgZGF0YQo=",
        "md5": "827ae7e1ab45e4dd591d087c741e5770",
        "length": 25
      }
    ]
  }

Event

In addition to the core properties shared by all Activity Streams Objects, event objects MAY contain the following properties:
PropertyValueDescription
attendedBy Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that attended the event.
attending Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that intend to attend the event.
endTime String The date and time that the event ends represented as a String conforming to the "date-time" production in [RFC3339].
invited Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that have been invited to the event.
maybeAttending Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that possibly may attend the event.
notAttendedBy Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that did not attend the event.
notAttending Collection A collection object as defined in Section 3.5 of the JSON Activity Streams specification that provides information about entities that do not intend to attend the event.
startTime String The date and time that the event begins represented as a String confirming to the "date-time" production in RFC 3339.

For example:

  {
    "objectType": "event",
    "displayName": "Meeting with Joe",
    "startTime": "2012-12-12T12:00:00Z",
    "endTime: "2012-12-12T13:00:00Z",
    "invited": {
      "items": [
        {"objectType": "person", 
         "displayName": "Joe"}
      ]
    },
    "attending": {
      "items": [
        {"objectType": "person", 
         "displayName": "Joe"}
      ]
    }
  }

Issue

In addition to the core properties shared by all Activity Streams Objects, issue objects MAY contain the following properties:
PropertyValueDescription
types Array An array of one or more absolute IRI's that describe the type of issue represented by the object. Note that the IRI's are intended for use as identifiers and MAY or MAY NOT be dereferenceable.

For example:

  {
    "objectType": "issue",
    "displayName": "Terms of Use Violation",
    "url": "http://.../terms-of-use",
    "types": [
      "http://example.org/codes/inappropriateMaterial",
      "http://example.org/codes/copyrightViolation"
    ]
  }

Permission

In addition to the core properties shared by all Activity Streams Objects, permission objects MAY contain the following properties:
PropertyValueDescription
scope Activity Streams Object A single Activity Streams Object, of any objectType, that identifies the scope of the permission. For example, if the permission objects describes write permissions for a given file, the scope property would be a file object describing that file.
actions Array of Strings An array of Strings that identify the specific actions associated with the permission. The actions are application and scope specific. No common, core set of actions is defined by this specification.

For example:

  {
    "objectType": "permission",
    "displayName": "Permission to Edit File: 2Q2014 Sales Forecast.xls",
    "scope": {
      "objectType": "file",
      "displayName": "2Q2014 Sales Forecast.xls"
    },
    "actions": ["modify", "delete", "create"]
  }

Place

In addition to the core properties shared by all Activity Streams Objects, place objects MAY contain the following properties:
PropertyValueDescription
position JSON Object The latitude, longitude and altitude of the place as a point on Earth. Represented as a JSON Object as described below.
address JSON Object A physical address represented as a JSON object as described below.

The properties for the position property are:

PropertyValueDescription
altitude Floating point Number The elevation of this point relative to the Earth, in meters above or below mean sea level (e.g. 8848.00, -86.00).
latitude Floating point Number The latitude of this point on Earth according to the WGS-84 coordinate reference system in decimal degrees (e.g. 27.9881, -3.12676).
longitude Floating point Number The longitude of this point on Earth according to the WGS-74 coordinate reference system in decimal degrees (e.g. 86.9253, -134.4323).

For example:

  {
    "objectType": "place",
    "displayName": "Some Random Location on Earth",
    "position": {
      "latitude": 34.34,
      "longitude": -127.23,
      "altitude": 100.05
    }
  }

Note that in older versions of this specification, the value of the position property was represented as an ISO 6709 compliant String. For instance "position":"+27.5916+086.5640+8850/". This format has been deprecated and SHOULD NOT be used. However, there might be existing deployed applications still utilizing the ISO 6709. Consuming implementations can choose to continue supporting the ISO 6709 format but SHOULD NOT produce Activity Streams that use the deprecated format.

The properties for the address property are:

PropertyValueDescription
formatted String The full mailing address formatted for display or use with a printed mailing label.
streetAddress String The street address including house number, street name, P.O. Box, apartment or unit number and extended multi-line address information.
locality String The city or locality
region String The state or region
postalCode String The zip or postal code
country String The country name component

For example:

  {
    "objectType": "place",
    "displayName": "This is not really my address",
    "address": {
      "formatted": "111 North First Street, New York, NY 11111",
      "streetAdress": "111 North First Street",
      "locality": "New York",
      "region": "NY",
      "postalCode": "11111",
      "country": "US"
    }
  }

Roles and Groups

In addition to the core properties shared by all Activity Streams Objets, role and group objects MAY contain the following:
PropertyValueDescription
members Collection Object An optional Activity Streams Collection object listing the members of a group, or listing the entities assigned to a particular role.

For example:

  {
    "objectType": "group",
    "displayName": "My Work Group",
    "members": {
      "items": [
        {
          "objectType": "person",
          "displayName": "Laura"
        },
        {
          "objectType": "person",
          "displayName": "Mark"
        }
      ]
    }
  }

Task

In addition to the core properties shared by all Activity Streams Objects, task objects MAY contain the following properties:
PropertyValueDescription
actor Activity Streams Object An Activity Streams Object that provides information about the actor that is expected to complete the task.
by String A RFC 3339 date-time specifying the date and time by which the task is to be completed.
object Activity Streams Object An Activity Streams object describing the object of the task.
prerequisites Array of Task Objects An Array of other Task objects that are to be completed before this task can be completed.
required Boolean A boolean value indicating whether completion of this task is considered to be mandatory.
supersedes Array of Task Objects An Array of other Task objects that are superseded by this task object.
verb String A string indicating the verb for this task as defined in Section 3.2 of [activitystreams].

For example:

  {
    "objectType": "task",
    "displayName": "James needs to read the spec",
    "by": "2012-12-12T12:12:12Z",
    "verb": "read",
    "actor": {
      "objectType": "person",
      "displayName": "James"
    },
    "object": {
      "objectType": "file",
      "displayName": "A specification",
      "url": "http://example.org/spec.html"
    },
    "required": true
  }

Base Extension Properties

This specification defines an initial set of extension properties that can be used with all activities or objects.

Context

The basic model for an Activity provides properties that allow the expression of who (actor) performed the action, what (object) was acted upon, the action (verb) that was taken, and to what the action was directed (target). The additional context property allows the Activity to further include information about why a particular action occurred by providing details about the context within which a particular Activity was performed. The value of the context property is an Object of any objectType. The meaning of the context property is only defined when used within an Activity object.

For example, the following Activity uses the context property to reference the specific reasons a particular article object has been flagged as being inappropriate:

  {
    "actor": {
      "objectType": "person",
      "displayName": "Joe"
    },
    "verb": "flag-as-inappropriate",
    "object": {
      "objectType": "article",
      "displayName": "An article about stuff"
    },
    "context": {
      "objectType": "issue",
      "displayName": "Terms of Use Violation",
      "url": "http://.../terms-of-use",
      "types": [
        "http://example.org/codes/inappropriateMaterial",
        "http://example.org/codes/copyrightViolation"
      ]
    }
  }

Location

Location data can be added to any object type or activity. Location can be specified via geographic coordinates, a street address, a free-form location name or any combination of these.

Within a JSON-serialized Activity Stream, the Location is represented using a property named location whose value is a Place object. The objectType property of this object MAY be omitted.

When appearing within an activity, the location data indicates the location where the activity occurred. When appearing within an object, the location data indicates the location of that object at the time the activity occurred.

For example:

  {
    "objectType": "person",
    "displayName": "John Doe",
    "location": {
      "displayName": "Mount Everest",
      "position": {
        "altitude": 8848.00,
        "latitude": 27.9881,
        "longitude": 86.9253
      }
    }
  }

Mood

Mood describes the mood of the user when the activity was performed. This is usually collected via an extra field in the user interface used to perform the activity. For the purpose of this schema, a mood is a freeform, short mood keyword or phrase along with an optional mood icon image.

In JSON, Moods are included within an object or activity using a property named mood whose value is a JSON object with the following properties:

PropertyValueDescription
displayName String The natural-language, human-readable and plain-text keyword or phrase describing the mood. HTML markup MUST NOT be included.
image Media Link An optional image that provides a visual representation of the mood.

For example:

  {
    "objectType": "person",
    "displayName": "James",
    "mood": {
      "displayName": "happy",
      "image": {
        "url": "http://example.org/emot/happy.png"
      }
    }
  }

Rating

A rating given as a number between 1.0 and 5.0 inclusive with one decimal place of precision. Represented in JSON as a property called rating whose value is a JSON number giving the rating.

Ratings are generally most useful only for particular types of objects, such as audio, video, photos and places.

For example:

  {
    "objectType": "review",
    "content": "This is a great product",
    "rating": 3.5
  }

Result

The result provides a description of the result of any particular activity. The value of the result property is an Object of any objectType. The meaning of the result property is only defined when used within an Activity object.

For instance:

  {
    "actor": {
      "objectType": "person",
      "displayName": "Joe"
    },
    "verb": "complete",
    "object": {
      "objectType": "http://example.org/Exam",
      "displayName": "The Big Exam"
    },
    "result": {
      "score": 123,
      "duration": "P1H",
    }
  }

Use of the result property will generally only be applicable with certain combinations of verbs and objectTypes. In many cases, the result will be implicit in the combination of actor, verb and object used -- for example, in an activity where a person, Joe, creates an article, the result of the activity is clear without the need to specify a separate result property.

Source

The source property provides a reference to the original source of an object or activity. The value of the source property is an Object of any objectType.

The source property is closely related to the generator and provider properties but serves the distinct purpose of identifying where the activity or object was originally published as opposed to identifying the applications that generated or published it.

For example:

  {
    "actor": {
      "objectType": "person",
      "displayName": "Joe"
    },
    "verb": "post",
    "object": {
      "objectType": "photo",
      "image": "http://example.org/photos/fluffycat.jpg"
    },
    "source": {
      "objectType": "collection",
      "displayName": "Joe's Photo's",
      "url": "http://example.org/joes/photos"
    }
  }

Starting and Ending Timestamps

When an long running Activity occurs over a distinct period of time, or when an Object represents a long-running process or event, the startTime and endTime properties can be used to specify the date and time at which the activity or object begins or concludes. The values for each are represented as JSON Strings conforming to the "date-time" production in [RFC3339][RFC3339].

For example:

  {
    "actor": {
      "objectType": "person",
      "displayName": "John Doe"},
    "verb": "at",
    "object": {
      "objectType":"place",
      "displayName":"Home"},
    "published": "2012-08-28T03:34:23Z",
    "startTime": "2012-08-12T12:13:14Z",
    "endTime": "2012-08-13T01:34:12Z"
  }

The startTime and endTime properties can be used independently or together. If both are specified, the endTime property MUST specify a moment in time that is more recent that that specified by the startTime property.

Tags

A listing of the objects that have been associated with a particular object. Represented in JSON using a property named tags whose value is an Array of objects.

For example:

  {
    "objectType": "photo",
    "image": "http://example.org/photos/fluffycat.jpg",
    "tags": [
      {
        "objectType": "person",
        "displayName": "John"
      },
      {
        "objectType": "person",
        "displayName": "Jane"
      }
    ]
  }

Multi-page Collections

A multi-page collection is a set of linked collection objects that together contain the complete set of objects that can be considered to be members of the collection.

When using multi-paged collections, the following additional properties can be used in addition to the core collection properties defined in section 3.5 of activitystreams.

PropertyValueDescription
itemsAfter String An RFC 3339 date-time, as described in Section 3 of [activitystreams], indicating that the items array contains only items published or updated after the date and time specified.
itemsBefore String An RFC 3339 date-time, as described in Section 3 of [activitystreams], indicating that the items array contains only items published or updated before the date and time specified.
itemsPerPage Non-negative Integer A non-negative integer specifying the maximum number of objects that will be included in the value of the items array.
links Links Object Collection of links connecting this collection object to other collection objects containing additional items that can be considered to be members of the same logical set.
startInde Non-negative Integer A non-negative integer value identifying the relative position within the collection of the first object contained in the items property. For instance, if there are 20 items that are considered to be members of a collection, but only the last 10 of those items are serialized within the value of the "items" property, the value of "startIndex" would be 10.

The value of the links property is an object. The members of the object are Registered or Extension Link Relations as defined by RFC5988. The following Registered Link Relations are identified as having specific purpose for use with Multi-page Collections:

NameValueDescription
first Link Object A Link Object referencing the further preceding page of the multi-page collection.
last Link Object A Link Object referencing the further following page of the multi-page collection.
prev Link Object A Link Object referencing the immediately preceding page of the multi-page collection. Note that "previous" can be used an an equivalent alternative; however implementations SHOULD use "prev" and MUST NOT used both "prev" and "previous" within the same "links" object.
next Link Object A Link Object referencing the immediately following page of the multi-page collection.
current Link Object A Link Object referencing the page containing the items have been updated or published most recently.
self Link Object A Link Object referencing this page.

For example, one page of a multi-page collection:

  {
    "totalItems": 12,
    "itemsPerPage" : 10,
    "startIndex": 10,
    "links": {
      "self": {"href":"http://example.org/items?page=1"},
      "next": {"href":"http://example.org/items?page=2"},
      "prev": {"href":"http://example.org/items?page=3"},
      "current": {"href":"http://example.org/items"}
    },
    "items" : [
      {
        "objectType": "person",
        "displayName":"Joe"
      },
      {
        "objectType": "person",
        "displayName":"Sally"
      }
    ]
  }

Note that, as the example illustrates, the totalItems property specifies the total number of items that can be considered to be a part of the collection as a whole, while the itemsPerPage indicates the maximum number of objects that will be included in this particular subset. The actual number of objects included in the value of the items property can be equal to or less than either of these values.

External Vocabularies

Any object within an Activity Streams object can be extended with additional properties not defined by the core Activity Streams [activitystreams][activitystreams] specification or this document. Such extension properties can be specific to individual applications or be drawn from other defined vocabularies such as that defined by the Schema.org organization and others.

When utilizing such vocabularies, it is possible that conflicts in the naming of properties and format of expected values might arise. To mitigate the risk of such conflicts, the following guidelines SHOULD be followed:

  1. When selecting the objectType for an object, if there is a close equivalent objectType already defined by thisspecification, then that objectType SHOULD be used.
  2. When properties specific to an external vocabulary are to be included within an object, those SHOULD be grouped together under a single namespace property whose name is uniquely reflective of the vocabulary.
  3. When including properties from the external vocabulary, avoid properties that are a close semantic match to existing properties defined by this or the core Activity Streams activitystreams specification. For example, within the Schema.org vocabulary, the properties name, description, url and image are semantically equivalent to core Activity Streams object properties and therefore SHOULD NOT be used.
  4. Further, avoid utilizing properties from multiple external vocabularies that are similar or semantically equivalent to each other.

This specification defines the following initial set of namespace properties that correspond to specific external vocabularies currently considered to be reasonable candidates for use within Activity Streams objects. Future versions of this specification might add additional namespace properties to this list. Implementors are free to define additional namespace properties representing other external vocabularies as necessary; however, there is a risk of potential conflicts if multiple independent implementors select the same namespace property to represent different external vocabularies. To help prevent such conflicts, it is RECOMMENDED that implementors publicly document their use of external vocabularies.

"dc"

The dc namespace property is defined to encapsulate the set of extension properties that represent information specific to the [Dublin Core Metadata Initiative][1]. If, for instance, Dublin Core properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the dc property.

For example:

  {
    "objectType": "file",
    "displayName": "A Document",
    "fileUrl": "http://example.org/foo.html"
    "dc": {
      "format": "text/html; charset="UTF-8"
    }
  }

"geojson"

The geojson namespace property is defined defined to encapsulate the set of extension properties that represent information specific to an [GeoJSON][2] data type. If, for instance, GeoJSON properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the geojson property.

For example:

  {
    "objectType": "place",
    "displayName": "A GeoJSON Described Place",
    "geojson": {
      "type": "FeatureCollection",
      "features": [
        {"type": "Feature",
         "geometry": {
           "type": "Point",
           "coordinates": [102.0, 0.5]
         },
         "properties": {
           "prop0": "value0"}
        },
        {"type": "Feature",
         "geometry": {
           "type": "LineString",
           "coordinates": [
             [102.0, 0.0],
             [103.0, 1.0],
             [104.0, 0.0],
             [105.0, 1.0]
           ]
         },
         "properties": {
           "prop0": "value0",
           "prop1": 0.0}
        },
        {"type": "Feature",
         "geometry": {
           "type": "Polygon",
           "coordinates": [
             [[100.0, 0.0],
              [101.0, 0.0],
              [101.0, 1.0],
              [100.0, 1.0],
              [100.0, 0.0]]]
           },
           "properties": {
             "prop0": "value0",
             "prop1": {"this": "that"}
           }
        }
      ]
    }
  }

"ld"

The ld namespace property is defined to encapsulate the set of extension properties that represent information specific to the [JSON Linked Data][3] vocabulary. If, for instance, Linked Data properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the ld property.

For example:

  {
    "objectType": "person",
    "displayName": "John Doe",
    "ld": {
      "@context": "http://json-ld.org/contexts/person.ld",
      "@id": "http://example.org/john.doe",
      "born": "1929-12-12"
    }
  }

"links"

The links namespace property is defined to encapsulate the set of extension properties that represent links to external resources. Property names are defined as being either Registered or Extension Link Relation Types as defined by [RFC5988][RFC5988]. The list of currently known Registered Link Relations can be found within the [IANA Registry of Link Relations][4].

For example:

  {
    "objectType": "note",
    "displayName": "This is a simple note",
    "links": {
      "canonical": {
  "href":"http://www.example.org/notes/123"
      },
      "edit": {
  "href":"http://www.example.org/api/notes/123"
      }
    }
  }

The value of each property within the links object is either a single Link Object or an array of Link Objects in the case where multiple links with the same Link Relation must be specified.

When the value is specified as an array of Link Objects, the ordering of values within the array is considered insignificant. Each contained value is to be treated as a separate link. An array SHOULD NOT contain multiple Link Objects specifying the same href value.

When using extension link relation types, the property name can be specified as an IRI RFC3987 but MUST be converted to URIs RFC3986 when compared and dereferenced as required by Section 4.2 of RFC5988.

As defined in Section 3 of RFC5988, such properties can be viewed as statements of the form "The containing object has a {relation type} resource at {target IRI}" where the {relation type} is identified by the property name, and the {target IRI} is provided by the property value.

Link Objects

All links are expressed as JSON objects that MUST contain an href property whose value is an absolute IRI [RFC3987][RFC3987] providing the target of the link. The object MAY contain the following additional properties:
PropertyValueDescription
hreflang RFC4646 Language Tag A hint identifying the language of the target resource.
title String A human-readable descriptive label for the link. HTML-markup SHOULD NOT be used.
type String A hint identifying the MIME media type of the linked resource.

Link Objects MAY contain an objectType property with the value link.

Additional properties MAY be specified but are undefined by this specification.

"odata"

The odata namespace property is defined to encapsulate the set of extension properties that represent information specific to the [OData][5] specification. If, for instance, OData properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the odata property.

For example:

  {
    "objectType": "person",
    "displayName": "John Doe",
    "odata": {
      "__metadata": { ... },
      "com.example.user.kind" : "PAID",
      "CustomerID": "JDOE",
      "UserName": "jdoe",
    }
  }

"opengraph"

The opengraph namespace property is defined to encapsulate the set of extension properties that represent information specific to an [OpenGraph][6] data type. If, for instance, OpenGraph properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the opengraph property.

For example:

  {
    "objectType": "person",
    "displayName": "John Smith",
    "opengraph": {
      "username": "john_smith",
      "verified": false,
      "relationship_status": "Single"
    }
  }

"schema_org"

The schema\_org namespace property is defined to encapsulate the set of extension properties that represent information specific to a [Schema.org][7] data type. If, for instance, Schema.org properties can be applied to an Activity Streams object, those properties SHOULD be grouped together under the schema_org property.

For example:

  {
    "objectType": "person",
    "displayName": "John Smith",
    "schema_org": {
      "additionalType": ["http://schema.org/Person"]
      "birthDate": ["1976-12-23"],
      "gender": ["Male"]
    }
  }

License

As of [date], the following persons or entities have made this Specification available under the Open Web Foundation Agreement Version 1.0, which is available at http://www.openwebfoundation.org/legal/.

[List of persons or entities]

You can review the signed copies of the Open Web Foundation Agreement Version 1.0 for this Specification at http://activitystrea.ms/licensing/, which may also include additional parties to those listed above.

Your use of this Specification may be subject to other third party rights. THIS SPECIFICATION IS PROVIDED "AS IS." The contributors expressly disclaim any warranties (express, implied, or otherwise), including implied warranties of merchantability, non-infringement, fitness for a particular purpose, or title, related to the Specification. The entire risk as to implementing or otherwise using the Specification is assumed by the Specification implementer and user. IN NO EVENT WILL ANY PARTY BE LIABLE TO ANY OTHER PARTY FOR LOST PROFITS OR ANY FORM OF INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER FROM ANY CAUSES OF ACTION OF ANY KIND WITH RESPECT TO THIS SPECIFICATION OR ITS GOVERNING AGREEMENT, WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, AND WHETHER OR NOT THE OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Normative References