jonny/linkml-activitypub
1
0
Fork 0
mirror of https://github.com/p2p-ld/linkml-activitypub.git synced 2024-09-18 02:14:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

v0.2.0 - Rename to activitystreams and activitypub rather than both being activitypub

Browse source
This commit is contained in:
sneakers-the-rat 2024-01-14 22:00:00 -08:00
parent df18975493
commit f196ac3376
Signed by untrusted user who does not match committer: jonny
GPG key ID: 6DCB96EF1E4D232D
179 changed files with 61571 additions and 21583 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -1,5 +1,3 @@
/docs/
/generated/docs/
/tmp/
# Byte-compiled / optimized / DLL files

11
CHANGELOG.md Normal file
View file

@ -0,0 +1,11 @@
# Changelog
## 0.2
- 0.2.0
- Change names so activitystreams.yaml schema is separate from activitypub.yaml
# 0.1
- 0.1.0
- Initial transcription of activitystreams vocabulary

14
Makefile
View file

@ -10,16 +10,17 @@ RUN = poetry run
# get values from about.yaml file
SCHEMA_NAME = "linkml_activitypub"
SOURCE_SCHEMA_PATH = "linkml_activitypub/activitypub.yaml"
AS_SCHEMA_PATH = "linkml_activitypub/activitystreams.yaml"
AP_SCHEMA_PATH = "linkml_activitypub/activitypub.yaml"
SOURCE_SCHEMA_DIR = $(dir $(SOURCE_SCHEMA_PATH))
SCHEMA_FILES := $(wildcard $(SOURCE_SCHEMA_DIR))
SRC = src
DEST = generated
PYMODEL = $(SCHEMA_NAME)
DOCDIR = docs
EXAMPLEDIR = examples
# environment variables
include config.env
GEN_PARGS =
ifdef LINKML_GENERATORS_PROJECT_ARGS
GEN_PARGS = ${LINKML_GENERATORS_PROJECT_ARGS}
@ -99,10 +100,13 @@ gen-examples:
# generates all project files
gen-project: $(PYMODEL)
$(RUN) gen-project ${GEN_PARGS} -d $(DEST) $(SOURCE_SCHEMA_PATH) && mv $(DEST)/*.py $(PYMODEL)/dataclass/
$(RUN) gen-project ${GEN_PARGS} -d $(DEST) $(AS_SCHEMA_PATH)
$(RUN) gen-project ${GEN_PARGS} -d $(DEST) $(AP_SCHEMA_PATH)
mv $(DEST)/*.py "${PYMODEL}/dataclass/"
gen-pydantic: $(PYMODEL)
$(RUN) gen-pydantic $(SOURCE_SCHEMA_PATH) --pydantic-version 2 > $(PYMODEL)/activitypub.py
$(RUN) gen-pydantic $(AS_SCHEMA_PATH) --pydantic-version 2 > $(PYMODEL)/activitystreams.py
$(RUN) gen-pydantic $(AP_SCHEMA_PATH) --pydantic-version 2 > $(PYMODEL)/activitypub.py
test: test-schema test-python test-examples

44
README.md
View file

@ -1,10 +1,25 @@
# linkml-activitypub
LinkML representation of ActivityPub schema (which is mostly ActivityStreams except where it's not)
LinkML representation of ActivityStreams and ActivityPub schema
https://pypi.org/projects/linkml-activitypub
## Process
Source schema:
- `linkml_activitypub/activitystreams.yaml` - ActivityStreams2 vocabulary schema
- `linkml_activitypub/activitypub.yaml` - ActivityPub Extensions to ActivityStreams2 (imports ActivityStreams2)
Generated models:
- `generated/` - All generated schema for both source schema
- Pydantic 2 Models:
- `linkml_activitypub/activitystreams.py`
- `linkml_activitypub/activitypub.py`
- Dataclasses
- `linkml_activitypub/dataclass/activitystreams.py`
- `linkml_activitypub/dataclass/activitypub.py`
## ActivityStreams
### Process
Intermediate files are in the `data` directory
@ -13,7 +28,7 @@ Intermediate files are in the `data` directory
- `activitystreams2.ofn` - Convert to functional notation with [robot](http://robot.obolibrary.org/)
- `activitystreams2.yaml` - Then to rough linkml using [schema-automator](https://linkml.io/schema-automator/)
Then the final schema in `linkml_activitypub/activitypub.yaml`:
Then the final schema in `linkml_activitypub/activitystreams.yaml`:
- Reorder to match ActivityStreams
- Ensure correct
- inheritance
@ -47,12 +62,7 @@ Then the final schema in `linkml_activitypub/activitypub.yaml`:
- `schema`: https://schema.org/ - for specifying IETF BCP 47 language codes
## Notes
Need properties...
## Errata
### Errata
- `OrderedCollectionPage` is not a subclass of, and doesn't mix in `CollectionPage` since it would then have an ambiguous
class definition, since `OrderedCollection` inherits from `Collection` but asserts that the `list_items_ordered` slot is `true`
@ -60,6 +70,22 @@ Need properties...
- Accordingly, the domain and range of slots that include `CollectionPage` also include `OrderedCollectionPage
- Need to implement some `xsd:duration` pattern
### TODO
- JSON-LD Serialization: https://www.w3.org/TR/activitystreams-core/#syntaxconventions
- Collection serialization: "In the JSON serialization, the unordered items of a Collection are represented using the items property while ordered items are represented using the orderedItems property."
- Should `items` and `orderedItems` just be disjoint slots, rather than a slot with a special property modification?
## ActivityPub
## Process
## Errata
## TODO
- Everything!
# References
- Status of AS OWL vocabulary and etc. https://github.com/w3c/activitystreams/issues/416

2
about.yaml
View file

@ -2,4 +2,4 @@
name: linkml-activitypub
author: Jonny Saunders <sneakers-the-rat@protonmail.com>
description: LinkML representation of linkml_activitypub Schema
source_schema_path: linkml_activitypub/activitypub.yaml
source_schema_path: linkml_activitypub/activitystreams.yaml

139
generated/docs/Accept.md Normal file
View file

@ -0,0 +1,139 @@
# Class: Accept
Indicates that the actor accepts the object. The target property can be used in certain circumstances to indicate the context into which the object has been accepted.
URI: [as:Accept](http://www.w3.org/ns/activitystreams#Accept)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[TentativeAccept],[Collection],[Activity],[Accept&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F]^-[TentativeAccept],[Activity]^-[Accept])](https://yuml.me/diagram/nofunky;dir:TB/class/[TentativeAccept],[Collection],[Activity],[Accept&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F]^-[TentativeAccept],[Activity]^-[Accept])
## Parents
* is_a: [Activity](Activity.md) - An Activity is a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. The Activity type itself serves as an abstract base type for all types of activities. It is important to note that the Activity type itself does not carry any specific semantics about the kind of action being taken.
## Children
* [TentativeAccept](TentativeAccept.md) - A specialization of Accept indicating that the acceptance is tentative.
## Referenced by Class
## Attributes
### Inherited from Activity:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Accept |

163
generated/docs/Activity.md Normal file
View file

@ -0,0 +1,163 @@
# Class: Activity
An Activity is a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. The Activity type itself serves as an abstract base type for all types of activities. It is important to note that the Activity type itself does not carry any specific semantics about the kind of action being taken.
URI: [as:Activity](http://www.w3.org/ns/activitystreams#Activity)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[View],[Update],[Undo],[Remove],[Reject],[Read],[Offer],[Object],[Move],[Listen],[Like],[Leave],[Join],[IntransitiveActivity],[Ignore],[Follow],[Flag],[Dislike],[Delete],[Create],[Collection],[Announce],[Add],[Activity&#124;actor:string%20*;instrument:string%20*;object:string%20*;origin:string%20*;result:string%20*;target:string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F]^-[View],[Activity]^-[Update],[Activity]^-[Undo],[Activity]^-[Remove],[Activity]^-[Reject],[Activity]^-[Read],[Activity]^-[Offer],[Activity]^-[Move],[Activity]^-[Listen],[Activity]^-[Like],[Activity]^-[Leave],[Activity]^-[Join],[Activity]^-[IntransitiveActivity],[Activity]^-[Ignore],[Activity]^-[Follow],[Activity]^-[Flag],[Activity]^-[Dislike],[Activity]^-[Delete],[Activity]^-[Create],[Activity]^-[Announce],[Activity]^-[Add],[Activity]^-[Accept],[Object]^-[Activity],[Accept])](https://yuml.me/diagram/nofunky;dir:TB/class/[View],[Update],[Undo],[Remove],[Reject],[Read],[Offer],[Object],[Move],[Listen],[Like],[Leave],[Join],[IntransitiveActivity],[Ignore],[Follow],[Flag],[Dislike],[Delete],[Create],[Collection],[Announce],[Add],[Activity&#124;actor:string%20*;instrument:string%20*;object:string%20*;origin:string%20*;result:string%20*;target:string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F]^-[View],[Activity]^-[Update],[Activity]^-[Undo],[Activity]^-[Remove],[Activity]^-[Reject],[Activity]^-[Read],[Activity]^-[Offer],[Activity]^-[Move],[Activity]^-[Listen],[Activity]^-[Like],[Activity]^-[Leave],[Activity]^-[Join],[Activity]^-[IntransitiveActivity],[Activity]^-[Ignore],[Activity]^-[Follow],[Activity]^-[Flag],[Activity]^-[Dislike],[Activity]^-[Delete],[Activity]^-[Create],[Activity]^-[Announce],[Activity]^-[Add],[Activity]^-[Accept],[Object]^-[Activity],[Accept])
## Parents
* is_a: [Object](Object.md) - Describes an object of any kind. The Object type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as Activity, IntransitiveActivity, Collection and OrderedCollection.
## Children
* [Accept](Accept.md) - Indicates that the actor accepts the object. The target property can be used in certain circumstances to indicate the context into which the object has been accepted.
* [Add](Add.md) - Indicates that the actor has added the object to the target. If the target property is not explicitly specified, the target would need to be determined implicitly by context. The origin can be used to identify the context from which the object originated.
* [Announce](Announce.md) - Indicates that the actor is calling the target's attention the object. The origin typically has no defined meaning.
* [Create](Create.md) - Indicates that the actor has created the object.
* [Delete](Delete.md) - Indicates that the actor has deleted the object. If specified, the origin indicates the context from which the object was deleted.
* [Dislike](Dislike.md) - Indicates that the actor dislikes the object.
* [Flag](Flag.md) - Indicates that the actor is "flagging" the object. Flagging is defined in the sense common to many social platforms as reporting content as being inappropriate for any number of reasons.
* [Follow](Follow.md) - Indicates that the actor is "following" the object. Following is defined in the sense typically used within Social systems in which the actor is interested in any activity performed by or on the object. The target and origin typically have no defined meaning.
* [Ignore](Ignore.md) - Indicates that the actor is ignoring the object. The target and origin typically have no defined meaning.
* [IntransitiveActivity](IntransitiveActivity.md) - ['An Activity that has no direct object@en']
* [Join](Join.md) - Indicates that the actor has joined the object. The target and origin typically have no defined meaning.
* [Leave](Leave.md) - Indicates that the actor has left the object. The target and origin typically have no meaning.
* [Like](Like.md) - Indicates that the actor likes, recommends or endorses the object. The target and origin typically have no defined meaning.
* [Listen](Listen.md) - Indicates that the actor has listened to the object.
* [Move](Move.md) - Indicates that the actor has moved object from origin to target. If the origin or target are not specified, either can be determined by context.
* [Offer](Offer.md) - Indicates that the actor is offering the object. If specified, the target indicates the entity to which the object is being offered.
* [Read](Read.md) - Indicates that the actor has read the object.
* [Reject](Reject.md) - Indicates that the actor is rejecting the object. The target and origin typically have no defined meaning.
* [Remove](Remove.md) - Indicates that the actor is removing the object. If specified, the origin indicates the context from which the object is being removed.
* [Undo](Undo.md) - Indicates that the actor is undoing the object. In most cases, the object will be an Activity describing some previously performed action (for instance, a person may have previously "liked" an article but, for whatever reason, might choose to undo that like at some later point in time). The target and origin typically have no defined meaning.
* [Update](Update.md) - Indicates that the actor has updated the object. Note, however, that this vocabulary does not define a mechanism for describing the actual set of modifications made to object. The target and origin typically have no defined meaning.
* [View](View.md) - Indicates that the actor has viewed the object.
## Referenced by Class
## Attributes
### Own
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
### Inherited from Object:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Activity |

132
generated/docs/Add.md Normal file
View file

@ -0,0 +1,132 @@
# Class: Add
Indicates that the actor has added the object to the target. If the target property is not explicitly specified, the target would need to be determined implicitly by context. The origin can be used to identify the context from which the object originated.
URI: [as:Add](http://www.w3.org/ns/activitystreams#Add)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection],[Activity]^-[Add&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection],[Activity]^-[Add&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Activity])
## Parents
* is_a: [Activity](Activity.md) - An Activity is a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. The Activity type itself serves as an abstract base type for all types of activities. It is important to note that the Activity type itself does not carry any specific semantics about the kind of action being taken.
## Attributes
### Inherited from Activity:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Add |

132
generated/docs/Announce.md Normal file
View file

@ -0,0 +1,132 @@
# Class: Announce
Indicates that the actor is calling the target's attention the object. The origin typically has no defined meaning.
URI: [as:Announce](http://www.w3.org/ns/activitystreams#Announce)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection],[Activity]^-[Announce&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection],[Activity]^-[Announce&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Activity])
## Parents
* is_a: [Activity](Activity.md) - An Activity is a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. The Activity type itself serves as an abstract base type for all types of activities. It is important to note that the Activity type itself does not carry any specific semantics about the kind of action being taken.
## Attributes
### Inherited from Activity:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Announce |

112
generated/docs/Application.md Normal file
View file

@ -0,0 +1,112 @@
# Class: Application
Describes a software application.
URI: [as:Application](http://www.w3.org/ns/activitystreams#Application)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Object],[Collection],[Object]^-[Application&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object],[Collection],[Object]^-[Application&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])
## Parents
* is_a: [Object](Object.md) - Describes an object of any kind. The Object type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as Activity, IntransitiveActivity, Collection and OrderedCollection.
## Attributes
### Inherited from Object:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Application |

132
generated/docs/Arrive.md Normal file
View file

@ -0,0 +1,132 @@
# Class: Arrive
An IntransitiveActivity that indicates that the actor has arrived at the location. The origin can be used to identify the context from which the actor originated. The target typically has no defined meaning.
URI: [as:Arrive](http://www.w3.org/ns/activitystreams#Arrive)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[IntransitiveActivity],[Collection],[IntransitiveActivity]^-[Arrive&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])](https://yuml.me/diagram/nofunky;dir:TB/class/[IntransitiveActivity],[Collection],[IntransitiveActivity]^-[Arrive&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])
## Parents
* is_a: [IntransitiveActivity](IntransitiveActivity.md) - ['An Activity that has no direct object@en']
## Attributes
### Inherited from IntransitiveActivity:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Arrive |

112
generated/docs/Article.md Normal file
View file

@ -0,0 +1,112 @@
# Class: Article
URI: [as:Article](http://www.w3.org/ns/activitystreams#Article)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Object],[Collection],[Object]^-[Article&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object],[Collection],[Object]^-[Article&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])
## Parents
* is_a: [Object](Object.md) - Describes an object of any kind. The Object type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as Activity, IntransitiveActivity, Collection and OrderedCollection.
## Attributes
### Inherited from Object:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Article |

112
generated/docs/Audio.md Normal file
View file

@ -0,0 +1,112 @@
# Class: Audio
Represents an audio document of any kind.
URI: [as:Audio](http://www.w3.org/ns/activitystreams#Audio)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Document],[Collection],[Document]^-[Audio&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])](https://yuml.me/diagram/nofunky;dir:TB/class/[Document],[Collection],[Document]^-[Audio&#124;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])
## Parents
* is_a: [Document](Document.md) - Represents a document of any kind.
## Attributes
### Inherited from Document:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Audio |

132
generated/docs/Block.md Normal file
View file

@ -0,0 +1,132 @@
# Class: Block
Indicates that the actor is blocking the object. Blocking is a stronger form of Ignore. The typical use is to support social systems that allow one user to block activities or content of other users. The target and origin typically have no defined meaning.
URI: [as:Block](http://www.w3.org/ns/activitystreams#Block)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Ignore],[Collection],[Ignore]^-[Block&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])](https://yuml.me/diagram/nofunky;dir:TB/class/[Ignore],[Collection],[Ignore]^-[Block&#124;actor(i):string%20*;instrument(i):string%20*;object(i):string%20*;origin(i):string%20*;result(i):string%20*;target(i):string%20*;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F])
## Parents
* is_a: [Ignore](Ignore.md) - Indicates that the actor is ignoring the object. The target and origin typically have no defined meaning.
## Attributes
### Inherited from Ignore:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
* [actor](actor.md) <sub>0..\*</sub>
* Description: Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link.
* Range: [String](types/String.md)
* [instrument](instrument.md) <sub>0..\*</sub>
* Description: Identifies one or more objects used (or to be used) in the completion of an Activity.
* Range: [String](types/String.md)
* [object](object.md) <sub>0..\*</sub>
* Description: When used within an Activity, describes the direct object of the activity. For instance, in the activity "John added a movie to his wishlist", the object of the activity is the movie added.
When used within a Relationship describes the entity to which the subject is related.
* Range: [String](types/String.md)
* [origin](origin.md) <sub>0..\*</sub>
* Description: Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition "from". For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
* Range: [String](types/String.md)
* [result](result.md) <sub>0..\*</sub>
* Description: Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource.
* Range: [String](types/String.md)
* [target](target.md) <sub>0..\*</sub>
* Description: Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition "to". For instance, in the activity "John added a movie to his wishlist", the target of the activity is John's wishlist. An activity can have more than one target.
* Range: [String](types/String.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Block |

139
generated/docs/Collection.md Normal file
View file

@ -0,0 +1,139 @@
# Class: Collection
A Collection is a subtype of Object that represents ordered or unordered sets of Object or Link instances. Refer to the Activity Streams 2.0 Core specification for a complete description of the Collection type.
URI: [as:Collection](http://www.w3.org/ns/activitystreams#Collection)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[OrderedCollection],[Object],[CollectionPage],[Object]++-%20replies%200..1>[Collection&#124;current:string%20%3F;first:string%20%3F;items:string%20*;last:string%20%3F;totalItems:nonNegativeInteger%20%3F;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Collection]^-[OrderedCollection],[Collection]^-[CollectionPage],[Object]^-[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[OrderedCollection],[Object],[CollectionPage],[Object]++-%20replies%200..1>[Collection&#124;current:string%20%3F;first:string%20%3F;items:string%20*;last:string%20%3F;totalItems:nonNegativeInteger%20%3F;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Collection]^-[OrderedCollection],[Collection]^-[CollectionPage],[Object]^-[Collection])
## Parents
* is_a: [Object](Object.md) - Describes an object of any kind. The Object type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as Activity, IntransitiveActivity, Collection and OrderedCollection.
## Children
* [CollectionPage](CollectionPage.md) - Used to represent distinct subsets of items from a Collection. Refer to the Activity Streams 2.0 Core for a complete description of the CollectionPage object.
* [OrderedCollection](OrderedCollection.md) - A subtype of Collection in which members of the logical collection are assumed to always be strictly ordered.
## Referenced by Class
* **None** *[replies](replies.md)* <sub>0..1</sub> **[Collection](Collection.md)**
## Attributes
### Own
* [current](current.md) <sub>0..1</sub>
* Description: In a paged Collection, indicates the page that contains the most recently updated member items.
* Range: [String](types/String.md)
* [first](first.md) <sub>0..1</sub>
* Description: In a paged Collection, indicates the furthest preceeding page of items in the collection.
* Range: [String](types/String.md)
* [Collection➞items](Collection_items.md) <sub>0..\*</sub>
* Description: Identifies the items contained in a collection. The items might be ordered or unordered.
* Range: [String](types/String.md)
* [last](last.md) <sub>0..1</sub>
* Description: In a paged Collection, indicates the furthest proceeding page of the collection.
* Range: [String](types/String.md)
* [totalItems](totalItems.md) <sub>0..1</sub>
* Description: A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance.
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
### Inherited from Object:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.
* Range: [String](types/String.md)
* [audience](audience.md) <sub>0..\*</sub>
* Description: Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
* Range: [String](types/String.md)
* [bcc](bcc.md) <sub>0..\*</sub>
* Description: Identifies one or more Objects that are part of the private secondary audience of this Object.
* Range: [String](types/String.md)
* [bto](bto.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the private primary audience of this Object.
* Range: [String](types/String.md)
* [cc](cc.md) <sub>0..\*</sub>
* Description: Identifies an Object that is part of the public secondary audience of this Object.
* Range: [String](types/String.md)
* [content](content.md) <sub>0..\*</sub>
* Description: The 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. The content MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [context](context.md) <sub>0..\*</sub>
* Description: Identifies the context within which the object exists or an activity was performed.
The notion of "context" used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event.
* Range: [String](types/String.md)
* [generator](generator.md) <sub>0..\*</sub>
* Description: Identifies the entity (e.g. an application) that generated the object.
* Range: [String](types/String.md)
* [icon](icon.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.
* Range: [String](types/String.md)
* [image](image.md) <sub>0..\*</sub>
* Description: Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
* Range: [String](types/String.md)
* [inReplyTo](inReplyTo.md) <sub>0..\*</sub>
* Description: Indicates one or more entities for which this object is considered a response.
* Range: [String](types/String.md)
* [location](location.md) <sub>0..\*</sub>
* Description: Indicates one or more physical or logical locations associated with the object.
* Range: [String](types/String.md)
* [name](name.md) <sub>0..\*</sub>
* Description: A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
* Range: [String](types/String.md)
* [preview](preview.md) <sub>0..\*</sub>
* Description: Identifies an entity that provides a preview of this object.
* Range: [String](types/String.md)
* [replies](replies.md) <sub>0..1</sub>
* Description: Identifies a Collection containing objects considered to be responses to this object.
* Range: [Collection](Collection.md)
* [summary](summary.md) <sub>0..\*</sub>
* Description: A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
* Range: [String](types/String.md)
* [tag](tag.md) <sub>0..\*</sub>
* Description: One 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.
* Range: [String](types/String.md)
* [to](to.md) <sub>0..\*</sub>
* Description: Identifies an entity considered to be part of the public primary audience of an Object
* Range: [String](types/String.md)
* [url](url.md) <sub>0..\*</sub>
* Description: Identifies one or more links to representations of the object
* Range: [String](types/String.md)
* [duration](duration.md) <sub>0..1</sub>
* Description: When 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. The value MUST be expressed as an xsd:duration as defined by [ xmlschema11-2], section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
* Range: [DurationType](types/DurationType.md)
* [endTime](endTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [id](id.md) <sub>0..1</sub>
* Description: Provides the globally unique identifier for an Object or Link.
* Range: [AnyURI](types/AnyURI.md)
* [mediaType](mediaType.md) <sub>0..1</sub>
* Description: When used on a Link, identifies the MIME media type of the referenced resource.
When 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.
* Range: [String](types/String.md)
* [published](published.md) <sub>0..1</sub>
* Description: The date and time at which the object was published
* Range: [Datetime](types/Datetime.md)
* [startTime](startTime.md) <sub>0..1</sub>
* Description: The 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.
* Range: [Datetime](types/Datetime.md)
* [updated](updated.md) <sub>0..1</sub>
* Description: The date and time at which the object was updated
* Range: [Datetime](types/Datetime.md)
## Other properties
| | | |
| --- | --- | --- |
| **Mappings:** | | as:Collection |

139
generated/docs/CollectionPage.md Normal file
View file

@ -0,0 +1,139 @@
# Class: CollectionPage
Used to represent distinct subsets of items from a Collection. Refer to the Activity Streams 2.0 Core for a complete description of the CollectionPage object.
URI: [as:CollectionPage](http://www.w3.org/ns/activitystreams#CollectionPage)
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection]^-[CollectionPage&#124;next:string%20%3F;partOf:string%20%3F;prev:string%20%3F;current(i):string%20%3F;first(i):string%20%3F;items(i):string%20*;last(i):string%20%3F;totalItems(i):nonNegativeInteger%20%3F;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Collection]^-[CollectionPage&#124;next:string%20%3F;partOf:string%20%3F;prev:string%20%3F;current(i):string%20%3F;first(i):string%20%3F;items(i):string%20*;last(i):string%20%3F;totalItems(i):nonNegativeInteger%20%3F;attachment(i):string%20*;attributedTo(i):string%20*;audience(i):string%20*;bcc(i):string%20*;bto(i):string%20*;cc(i):string%20*;content(i):string%20*;context(i):string%20*;generator(i):string%20*;icon(i):string%20*;image(i):string%20*;inReplyTo(i):string%20*;location(i):string%20*;name(i):string%20*;preview(i):string%20*;summary(i):string%20*;tag(i):string%20*;to(i):string%20*;url(i):string%20*;duration(i):durationType%20%3F;endTime(i):datetime%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;published(i):datetime%20%3F;startTime(i):datetime%20%3F;updated(i):datetime%20%3F],[Collection])
## Parents
* is_a: [Collection](Collection.md) - A Collection is a subtype of Object that represents ordered or unordered sets of Object or Link instances. Refer to the Activity Streams 2.0 Core specification for a complete description of the Collection type.
## Attributes
### Own
* [next](next.md) <sub>0..1</sub>
* Description: In a paged Collection, indicates the next page of items.
* Range: [String](types/String.md)
* [partOf](partOf.md) <sub>0..1</sub>
* Description: Identifies the Collection to which a CollectionPage objects items belong.
* Range: [String](types/String.md)
* [prev](prev.md) <sub>0..1</sub>
* Description: In a paged Collection, identifies the previous page of items.
* Range: [String](types/String.md)
### Inherited from Collection:
* [attachment](attachment.md) <sub>0..\*</sub>
* Description: Identifies a resource 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.
* Range: [String](types/String.md)
* [attributedTo](attributedTo.md) <sub>0..\*</sub>
* Description: Identifies 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.