Optional @contextproperty to define the processing context. The Field of the
property is defined by the [JSON-LD] specification.
Optional attachmentIdentifies resources attached or related to an object that potentially requires special handling. The intent is to provide a model that is at least semantically similar to attachments in email.
Optional attributedIdentifies one or more entities to which this object is attributed. The attributed entities might not be Actors. For instance, an object might be attributed to the completion of another activity.
Optional audienceIdentifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.
Optional bccIdentifies one or more Objects that are part of the private secondary audience of this Object.
Optional btoIdentifies an Object that is part of the private primary audience of this Object.
Optional ccIdentifies an Object that is part of the public secondary audience of this Object.
Optional contentThe content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. [For multiple language-tagged values use contentMap property]
Optional contentThe content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. [For a single value use content property]
Optional durationWhen the object describes a time-bound resource, such as an audio or video, a meeting, etc., the duration property indicates the object's approximate duration.
Must be provided in xsd:duration
PT20M (20 minutes)
P1DT2H (1 day, 2 hours)
P2Y6M5DT12H35M30S (2 years, 6 months, 5 days, 12 hours, 35 minutes, 30 seconds)
Optional endThe date and time describing the actual or expected ending time of the object. When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.
Must be provided in xsd:dateTime
2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
Optional endpointsA json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor. This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.
Optional followersEvery actor SHOULD have a collection of followers. This is a list of everyone who has sent a Follow activity for the actor, added as a side effect. This is where one would find a list of all the actors that are following the actor. The followers collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
NOTE: The follow activity generally is a request to see the objects an actor creates. This makes the Followers collection an appropriate default target for delivery of notifications.
Optional followingEvery actor SHOULD have a collection of following. This is a list of everybody that the actor has followed, added as a side effect. The following collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
Optional generatorIdentifies the entity (e.g. an application) that generated the object.
Optional iconIndicates an entity (or entities) that describes an icon for this object. Unlike image property, the icon should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
Optional idProvides the globally unique identifier for an Object All objects must have unique global identifier (unless the object is transient, in which case the id MAY be omitted).
Optional imageIndicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
Optional inIndicates one or more entities for which this object is considered a response.
The inbox is discovered through the inbox property of an actor's profile. The inbox MUST be an OrderedCollection. The inbox stream contains all activities received by the actor. The server SHOULD filter content according to the requester permission. In general, the owner of an inbox is likely to be able to access all of their inbox contents. Depending on access control, some other content may be public, whereas other content may require authentication for non-owner users, if they can access the inbox at all.
Optional likedEvery actor MAY have a liked collection. This is a list of every object from all the actor's Like activities, added as a side effect. The liked collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
Optional likesEvery object MAY have a "likes" collection. This is a list of all Like activities with this object as the object property, added as a side effect. The likes collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
Optional locationIndicates one or more physical or logical locations associated with the object.
Optional mediaWhen used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Works different with Link
Optional nameA simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. [For multiple language-tagged values use nameMap property]
Optional nameA simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. [For a single value use name property]
The outbox is discovered through the outbox property of an actor's profile. The outbox MUST be an OrderedCollection. The outbox stream contains activities the user has published, subject to the ability of the requester to retrieve the activity (that is, the contents of the outbox are filtered by the permissions of the person reading it). If a user submits a request without Authorization the server should respond with all the Public posts. This could potentially be all relevant objects published by the user, though the number of available items is left to the discretion of those implementing and deploying the server.
Optional preferredA short username which may be used to refer to the actor, with no uniqueness guarantees. [For multiple language-tagged values use preferredUsernameMap property]
Optional preferredA short username which may be used to refer to the actor, with no uniqueness guarantees. [For a single value use preferredUsername property]
Optional previewIdentifies an entity that provides a preview of this object.
Optional published2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
Optional repliesIdentifies a Collection containing objects considered to be responses to this object.
Optional sharesEvery object MAY have a "shares" collection. This is a list of all Announce activities with this object as the object property, added as a side effect. The shares collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
Optional sourceActivityPub extends the Object by supplying the source property. The source property is intended to convey some sort of source from which the content markup was derived, as a form of provenance, or to support future editing by clients. In general, clients do the conversion from source to content, not the other way around. The value of source is itself an object which uses its own content and mediaType fields to supply source information.
Optional startThe date and time describing the actual or expected starting time of the object. When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.
Must be provided in xsd:dateTime
2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
Optional streamsA list of supplementary Collections which may be of interest.
Optional summaryA natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided. [For multiple language-tagged values use summaryMap property]
Optional summaryA natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided. [For a single value use summary property]
Optional tagOne or more "tags" that have been associated with an objects. A tag can be any kind of Object. The key difference between attachment and tag is that the former implies association by inclusion, while the latter implies associated by reference.
Optional toIdentifies an entity or entities considered to be part of the public primary audience of an Object.
Optional typeIdentifies the Object type. Multiple values may be specified. All objects must have type. There is already a bunch of default types presented by this library.
Optional updated2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
Optional urlIdentifies one or more links to representations of the object.
Generated using TypeDoc
JSON-LD uses the special