mirror of
https://github.com/p2p-ld/linkml-activitypub.git
synced 2024-12-22 13:14:28 +00:00
Compare commits
2 commits
df18975493
...
66dc12e73e
| Author | SHA1 | Date | |
|---|---|---|---|
66dc12e73e
|
|||
|
f196ac3376
|
180 changed files with 62539 additions and 21583 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1,5 +1,3 @@
|
|||
/docs/
|
||||
/generated/docs/
|
||||
/tmp/
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
|
|
|
|||
11
CHANGELOG.md
Normal file
11
CHANGELOG.md
Normal 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
14
Makefile
|
|
@ -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
44
README.md
|
|
@ -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,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
139
generated/docs/Accept.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
163
generated/docs/Activity.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
132
generated/docs/Add.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
132
generated/docs/Announce.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
112
generated/docs/Application.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Application
|
||||
|
||||
|
||||
Describes a software application.
|
||||
|
||||
URI: [as:Application](http://www.w3.org/ns/activitystreams#Application)
|
||||
|
||||
|
||||
[: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|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
132
generated/docs/Arrive.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
112
generated/docs/Article.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Article
|
||||
|
||||
|
||||
|
||||
|
||||
URI: [as:Article](http://www.w3.org/ns/activitystreams#Article)
|
||||
|
||||
|
||||
[: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|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
112
generated/docs/Audio.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Audio
|
||||
|
||||
|
||||
Represents an audio document of any kind.
|
||||
|
||||
URI: [as:Audio](http://www.w3.org/ns/activitystreams#Audio)
|
||||
|
||||
|
||||
[: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|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
132
generated/docs/Block.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
139
generated/docs/Collection.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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
139
generated/docs/CollectionPage.md
Normal 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)
|
||||
|
||||
|
||||
[: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|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.
|
||||
* 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)
|
||||
* [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)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:CollectionPage |
|
||||
|
||||
32
generated/docs/Collection_items.md
Normal file
32
generated/docs/Collection_items.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
# Slot: items
|
||||
|
||||
|
||||
Identifies the items contained in a collection. The items might be ordered or unordered.
|
||||
|
||||
URI: [as:Collection_items](http://www.w3.org/ns/activitystreams#Collection_items)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
[Collection](Collection.md) → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [items](items.md)
|
||||
|
||||
## Children
|
||||
|
||||
* [OrderedCollection➞items](OrderedCollection_items.md)
|
||||
|
||||
## Used by
|
||||
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:items |
|
||||
|
||||
132
generated/docs/Create.md
Normal file
132
generated/docs/Create.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Create
|
||||
|
||||
|
||||
Indicates that the actor has created the object.
|
||||
|
||||
URI: [as:Create](http://www.w3.org/ns/activitystreams#Create)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Create|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],[Collection],[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:Create |
|
||||
|
||||
132
generated/docs/Delete.md
Normal file
132
generated/docs/Delete.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Delete
|
||||
|
||||
|
||||
Indicates that the actor has deleted the object. If specified, the origin indicates the context from which the object was deleted.
|
||||
|
||||
URI: [as:Delete](http://www.w3.org/ns/activitystreams#Delete)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Delete|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],[Collection],[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:Delete |
|
||||
|
||||
132
generated/docs/Dislike.md
Normal file
132
generated/docs/Dislike.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Dislike
|
||||
|
||||
|
||||
Indicates that the actor dislikes the object.
|
||||
|
||||
URI: [as:Dislike](http://www.w3.org/ns/activitystreams#Dislike)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Dislike|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],[Collection],[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:Dislike |
|
||||
|
||||
121
generated/docs/Document.md
Normal file
121
generated/docs/Document.md
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
|
||||
# Class: Document
|
||||
|
||||
|
||||
Represents a document of any kind.
|
||||
|
||||
URI: [as:Document](http://www.w3.org/ns/activitystreams#Document)
|
||||
|
||||
|
||||
[: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]^-[Video],[Document]^-[Image],[Document]^-[Audio],[Object]^-[Document],[Collection],[Audio])](https://yuml.me/diagram/nofunky;dir:TB/class/[Video],[Object],[Image],[Document|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]^-[Video],[Document]^-[Image],[Document]^-[Audio],[Object]^-[Document],[Collection],[Audio])
|
||||
|
||||
## 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
|
||||
|
||||
* [Audio](Audio.md) - Represents an audio document of any kind.
|
||||
* [Image](Image.md) - An image document of any kind
|
||||
* [Video](Video.md) - Represents a video document of any kind.
|
||||
|
||||
## Referenced by Class
|
||||
|
||||
|
||||
## 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:Document |
|
||||
|
||||
112
generated/docs/Event.md
Normal file
112
generated/docs/Event.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Event
|
||||
|
||||
|
||||
Represents any kind of event.
|
||||
|
||||
URI: [as:Event](http://www.w3.org/ns/activitystreams#Event)
|
||||
|
||||
|
||||
[: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/[Object],[Object]^-[Event|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: [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:Event |
|
||||
|
||||
132
generated/docs/Flag.md
Normal file
132
generated/docs/Flag.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Flag
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:Flag](http://www.w3.org/ns/activitystreams#Flag)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Flag|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],[Collection],[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:Flag |
|
||||
|
||||
132
generated/docs/Follow.md
Normal file
132
generated/docs/Follow.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Follow
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:Follow](http://www.w3.org/ns/activitystreams#Follow)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Follow|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],[Collection],[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:Follow |
|
||||
|
||||
112
generated/docs/Group.md
Normal file
112
generated/docs/Group.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Group
|
||||
|
||||
|
||||
Represents a formal or informal collective of Actors.
|
||||
|
||||
URI: [as:Group](http://www.w3.org/ns/activitystreams#Group)
|
||||
|
||||
|
||||
[: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/[Object],[Object]^-[Group|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: [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:Group |
|
||||
|
||||
139
generated/docs/Ignore.md
Normal file
139
generated/docs/Ignore.md
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
|
||||
# Class: Ignore
|
||||
|
||||
|
||||
Indicates that the actor is ignoring the object. The target and origin typically have no defined meaning.
|
||||
|
||||
URI: [as:Ignore](http://www.w3.org/ns/activitystreams#Ignore)
|
||||
|
||||
|
||||
[: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]^-[Block],[Activity]^-[Ignore],[Collection],[Block],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Ignore|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]^-[Block],[Activity]^-[Ignore],[Collection],[Block],[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.
|
||||
|
||||
## Children
|
||||
|
||||
* [Block](Block.md) - 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.
|
||||
|
||||
## 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:Ignore |
|
||||
|
||||
141
generated/docs/IntransitiveActivity.md
Normal file
141
generated/docs/IntransitiveActivity.md
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
|
||||
# Class: IntransitiveActivity
|
||||
|
||||
|
||||
['An Activity that has no direct object@en']
|
||||
|
||||
URI: [as:IntransitiveActivity](http://www.w3.org/ns/activitystreams#IntransitiveActivity)
|
||||
|
||||
|
||||
[: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]^-[Travel],[IntransitiveActivity]^-[Question],[IntransitiveActivity]^-[Arrive],[Activity]^-[IntransitiveActivity],[Collection],[Arrive],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Travel],[Question],[IntransitiveActivity|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]^-[Travel],[IntransitiveActivity]^-[Question],[IntransitiveActivity]^-[Arrive],[Activity]^-[IntransitiveActivity],[Collection],[Arrive],[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.
|
||||
|
||||
## Children
|
||||
|
||||
* [Arrive](Arrive.md) - 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.
|
||||
* [Question](Question.md) - Represents a question being asked. Question objects are an extension of IntransitiveActivity. That is, the Question object is an Activity, but the direct object is the question itself and therefore it would not contain an object property.
|
||||
* [Travel](Travel.md) - Indicates that the actor is traveling to target from origin. Travel is an IntransitiveObject whose actor specifies the direct object. If the target or origin are not specified, either can be determined by context.
|
||||
|
||||
## 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:IntransitiveActivity |
|
||||
|
||||
132
generated/docs/Invite.md
Normal file
132
generated/docs/Invite.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Invite
|
||||
|
||||
|
||||
A specialization of Offer in which the actor is extending an invitation for the object to the target.
|
||||
|
||||
URI: [as:Invite](http://www.w3.org/ns/activitystreams#Invite)
|
||||
|
||||
|
||||
[: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],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Offer],[Offer]^-[Invite|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],[Collection])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [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.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Inherited from Offer:
|
||||
|
||||
* [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:Invite |
|
||||
|
||||
132
generated/docs/Join.md
Normal file
132
generated/docs/Join.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Join
|
||||
|
||||
|
||||
Indicates that the actor has joined the object. The target and origin typically have no defined meaning.
|
||||
|
||||
URI: [as:Join](http://www.w3.org/ns/activitystreams#Join)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Join|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],[Collection],[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:Join |
|
||||
|
||||
132
generated/docs/Leave.md
Normal file
132
generated/docs/Leave.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Leave
|
||||
|
||||
|
||||
Indicates that the actor has left the object. The target and origin typically have no meaning.
|
||||
|
||||
URI: [as:Leave](http://www.w3.org/ns/activitystreams#Leave)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Leave|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],[Collection],[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:Leave |
|
||||
|
||||
132
generated/docs/Like.md
Normal file
132
generated/docs/Like.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Like
|
||||
|
||||
|
||||
Indicates that the actor likes, recommends or endorses the object. The target and origin typically have no defined meaning.
|
||||
|
||||
URI: [as:Like](http://www.w3.org/ns/activitystreams#Like)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Like|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],[Collection],[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:Like |
|
||||
|
||||
62
generated/docs/Link.md
Normal file
62
generated/docs/Link.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
|
||||
# Class: Link
|
||||
|
||||
|
||||
A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by [ RFC5988]. Many of the properties defined by the Activity Vocabulary allow values that are either instances of Object or Link. When a Link is used, it establishes a qualified relation connecting the subject (the containing object) to the resource identified by the href. Properties of the Link are properties of the reference as opposed to properties of the resource.
|
||||
|
||||
URI: [as:Link](http://www.w3.org/ns/activitystreams#Link)
|
||||
|
||||
|
||||
[](https://yuml.me/diagram/nofunky;dir:TB/class/[Mention],[Link|name:string%20*;preview:string%20*;height:nonNegativeInteger%20%3F;href:anyURI%20%3F;hreflang:string%20%3F;id:anyURI%20%3F;mediaType:string%20%3F;rel:string%20*;width:nonNegativeInteger%20%3F]^-[Mention])
|
||||
|
||||
## Children
|
||||
|
||||
* [Mention](Mention.md) - A specialized Link that represents an @mention.
|
||||
|
||||
## Referenced by Class
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [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)
|
||||
* [height](height.md) <sub>0..1</sub>
|
||||
* Description: On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource.
|
||||
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
* [href](href.md) <sub>0..1</sub>
|
||||
* Description: The target resource pointed to by a Link.
|
||||
* Range: [AnyURI](types/AnyURI.md)
|
||||
* [hreflang](hreflang.md) <sub>0..1</sub>
|
||||
* Description: Hints as to the language used by the target resource. Value MUST be a [BCP47] Language-Tag.
|
||||
* Range: [String](types/String.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)
|
||||
* [rel](rel.md) <sub>0..\*</sub>
|
||||
* Description: A link relation associated with a Link. The value MUST conform to both the [HTML5] and [RFC5988] "link relation" definitions.
|
||||
In the [HTML5], any string not containing the "space" U+0020, "tab" (U+0009), "LF" (U+000A), "FF" (U+000C), "CR" (U+000D) or "," (U+002C) characters can be used as a valid link relation.
|
||||
|
||||
* Range: [String](types/String.md)
|
||||
* [width](width.md) <sub>0..1</sub>
|
||||
* Description: On a Link, specifies a hint as to the rendering width in device-independent pixels of the linked resource.
|
||||
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:Link |
|
||||
| **See also:** | | [https://www.w3.org/TR/activitystreams-vocabulary/#bib-RFC5988](https://www.w3.org/TR/activitystreams-vocabulary/#bib-RFC5988) |
|
||||
|
||||
132
generated/docs/Listen.md
Normal file
132
generated/docs/Listen.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Listen
|
||||
|
||||
|
||||
Indicates that the actor has listened to the object.
|
||||
|
||||
URI: [as:Listen](http://www.w3.org/ns/activitystreams#Listen)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Listen|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],[Collection],[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:Listen |
|
||||
|
||||
58
generated/docs/Mention.md
Normal file
58
generated/docs/Mention.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
|
||||
# Class: Mention
|
||||
|
||||
|
||||
A specialized Link that represents an @mention.
|
||||
|
||||
URI: [as:Mention](http://www.w3.org/ns/activitystreams#Mention)
|
||||
|
||||
|
||||
[:string%20*;preview(i):string%20*;height(i):nonNegativeInteger%20%3F;href(i):anyURI%20%3F;hreflang(i):string%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;rel(i):string%20*;width(i):nonNegativeInteger%20%3F],[Link])](https://yuml.me/diagram/nofunky;dir:TB/class/[Link]^-[Mention|name(i):string%20*;preview(i):string%20*;height(i):nonNegativeInteger%20%3F;href(i):anyURI%20%3F;hreflang(i):string%20%3F;id(i):anyURI%20%3F;mediaType(i):string%20%3F;rel(i):string%20*;width(i):nonNegativeInteger%20%3F],[Link])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [Link](Link.md) - A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by [ RFC5988]. Many of the properties defined by the Activity Vocabulary allow values that are either instances of Object or Link. When a Link is used, it establishes a qualified relation connecting the subject (the containing object) to the resource identified by the href. Properties of the Link are properties of the reference as opposed to properties of the resource.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Inherited from Link:
|
||||
|
||||
* [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)
|
||||
* [height](height.md) <sub>0..1</sub>
|
||||
* Description: On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource.
|
||||
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
* [href](href.md) <sub>0..1</sub>
|
||||
* Description: The target resource pointed to by a Link.
|
||||
* Range: [AnyURI](types/AnyURI.md)
|
||||
* [hreflang](hreflang.md) <sub>0..1</sub>
|
||||
* Description: Hints as to the language used by the target resource. Value MUST be a [BCP47] Language-Tag.
|
||||
* Range: [String](types/String.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)
|
||||
* [rel](rel.md) <sub>0..\*</sub>
|
||||
* Description: A link relation associated with a Link. The value MUST conform to both the [HTML5] and [RFC5988] "link relation" definitions.
|
||||
In the [HTML5], any string not containing the "space" U+0020, "tab" (U+0009), "LF" (U+000A), "FF" (U+000C), "CR" (U+000D) or "," (U+002C) characters can be used as a valid link relation.
|
||||
|
||||
* Range: [String](types/String.md)
|
||||
* [width](width.md) <sub>0..1</sub>
|
||||
* Description: On a Link, specifies a hint as to the rendering width in device-independent pixels of the linked resource.
|
||||
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:Mention |
|
||||
|
||||
132
generated/docs/Move.md
Normal file
132
generated/docs/Move.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Move
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:Move](http://www.w3.org/ns/activitystreams#Move)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Move|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],[Collection],[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:Move |
|
||||
|
||||
112
generated/docs/Note.md
Normal file
112
generated/docs/Note.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Note
|
||||
|
||||
|
||||
Represents a short written work typically less than a single paragraph in length.
|
||||
|
||||
URI: [as:Note](http://www.w3.org/ns/activitystreams#Note)
|
||||
|
||||
|
||||
[: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/[Object],[Object]^-[Note|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: [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:Note |
|
||||
|
||||
139
generated/docs/Offer.md
Normal file
139
generated/docs/Offer.md
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
|
||||
# Class: Offer
|
||||
|
||||
|
||||
Indicates that the actor is offering the object. If specified, the target indicates the entity to which the object is being offered.
|
||||
|
||||
URI: [as:Offer](http://www.w3.org/ns/activitystreams#Offer)
|
||||
|
||||
|
||||
[: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]^-[Invite],[Activity]^-[Offer],[Invite],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Offer|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]^-[Invite],[Activity]^-[Offer],[Invite],[Collection],[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.
|
||||
|
||||
## Children
|
||||
|
||||
* [Invite](Invite.md) - A specialization of Offer in which the actor is extending an invitation for the object to the target.
|
||||
|
||||
## 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:Offer |
|
||||
|
||||
130
generated/docs/OrderedCollection.md
Normal file
130
generated/docs/OrderedCollection.md
Normal file
|
|
@ -0,0 +1,130 @@
|
|||
|
||||
# Class: OrderedCollection
|
||||
|
||||
|
||||
A subtype of Collection in which members of the logical collection are assumed to always be strictly ordered.
|
||||
|
||||
URI: [as:OrderedCollection](http://www.w3.org/ns/activitystreams#OrderedCollection)
|
||||
|
||||
|
||||
[:string%20%3F;first(i):string%20%3F;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]^-[OrderedCollectionPage],[Collection]^-[OrderedCollection],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[OrderedCollectionPage],[OrderedCollection|items:string%20*;current(i):string%20%3F;first(i):string%20%3F;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]^-[OrderedCollectionPage],[Collection]^-[OrderedCollection],[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.
|
||||
|
||||
## Children
|
||||
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md) - Used to represent ordered subsets of items from an OrderedCollection. Refer to the Activity Streams 2.0 Core for a complete description of the OrderedCollectionPage object.
|
||||
|
||||
## Referenced by Class
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [OrderedCollection➞items](OrderedCollection_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)
|
||||
|
||||
### 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.
|
||||
* 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)
|
||||
* [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)
|
||||
* [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)
|
||||
145
generated/docs/OrderedCollectionPage.md
Normal file
145
generated/docs/OrderedCollectionPage.md
Normal file
|
|
@ -0,0 +1,145 @@
|
|||
|
||||
# Class: OrderedCollectionPage
|
||||
|
||||
|
||||
Used to represent ordered subsets of items from an OrderedCollection. Refer to the Activity Streams 2.0 Core for a complete description of the OrderedCollectionPage object.
|
||||
|
||||
URI: [as:OrderedCollectionPage](http://www.w3.org/ns/activitystreams#OrderedCollectionPage)
|
||||
|
||||
|
||||
[:string%20%3F;first(i):string%20%3F;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],[OrderedCollection],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[OrderedCollection]^-[OrderedCollectionPage|startIndex:nonNegativeInteger%20%3F;next:string%20%3F;partOf:string%20%3F;prev:string%20%3F;items:string%20*;current(i):string%20%3F;first(i):string%20%3F;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],[OrderedCollection],[Collection])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [OrderedCollection](OrderedCollection.md) - A subtype of Collection in which members of the logical collection are assumed to always be strictly ordered.
|
||||
|
||||
## Referenced by Class
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [startIndex](startIndex.md) <sub>0..1</sub>
|
||||
* Description: A non-negative integer value identifying the relative position within the logical view of a strictly ordered collection.
|
||||
* Range: [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
* [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)
|
||||
* [OrderedCollectionPage➞items](OrderedCollectionPage_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)
|
||||
|
||||
### Inherited from OrderedCollection:
|
||||
|
||||
* [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)
|
||||
* [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)
|
||||
* [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)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:OrderedCollectionPage |
|
||||
|
||||
30
generated/docs/OrderedCollectionPage_items.md
Normal file
30
generated/docs/OrderedCollectionPage_items.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
|
||||
# Slot: items
|
||||
|
||||
|
||||
Identifies the items contained in a collection. The items might be ordered or unordered.
|
||||
|
||||
URI: [as:OrderedCollectionPage_items](http://www.w3.org/ns/activitystreams#OrderedCollectionPage_items)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
[OrderedCollectionPage](OrderedCollectionPage.md) → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [OrderedCollection➞items](OrderedCollection_items.md)
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:items |
|
||||
|
||||
31
generated/docs/OrderedCollection_items.md
Normal file
31
generated/docs/OrderedCollection_items.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
# Slot: items
|
||||
|
||||
|
||||
Identifies the items contained in a collection. The items might be ordered or unordered.
|
||||
|
||||
URI: [as:OrderedCollection_items](http://www.w3.org/ns/activitystreams#OrderedCollection_items)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
[OrderedCollection](OrderedCollection.md) → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [Collection➞items](Collection_items.md)
|
||||
|
||||
## Children
|
||||
|
||||
* [OrderedCollectionPage➞items](OrderedCollectionPage_items.md)
|
||||
|
||||
## Used by
|
||||
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:items |
|
||||
|
||||
20
generated/docs/OrderedItems.md
Normal file
20
generated/docs/OrderedItems.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
|
||||
# Class: OrderedItems
|
||||
|
||||
|
||||
OrderedItems is not a real class in the ActivityStreams specification, but it is used as the container of the items in `OrderedCollections`
|
||||
|
||||
URI: [as:OrderedItems](http://www.w3.org/ns/activitystreams#OrderedItems)
|
||||
|
||||
|
||||
[](https://yuml.me/diagram/nofunky;dir:TB/class/[OrderedItems])
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:OrderedItems |
|
||||
|
||||
112
generated/docs/Organization.md
Normal file
112
generated/docs/Organization.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Organization
|
||||
|
||||
|
||||
Represents an organization.
|
||||
|
||||
URI: [as:Organization](http://www.w3.org/ns/activitystreams#Organization)
|
||||
|
||||
|
||||
[: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],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]^-[Organization|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],[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.
|
||||
|
||||
## 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:Organization |
|
||||
|
||||
112
generated/docs/Page.md
Normal file
112
generated/docs/Page.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Page
|
||||
|
||||
|
||||
Represents a Web Page.
|
||||
|
||||
URI: [as:Page](http://www.w3.org/ns/activitystreams#Page)
|
||||
|
||||
|
||||
[: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],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]^-[Page|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],[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.
|
||||
|
||||
## 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:Page |
|
||||
|
||||
112
generated/docs/Person.md
Normal file
112
generated/docs/Person.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Person
|
||||
|
||||
|
||||
Represents an individual person.
|
||||
|
||||
URI: [as:Person](http://www.w3.org/ns/activitystreams#Person)
|
||||
|
||||
|
||||
[: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],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]^-[Person|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],[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.
|
||||
|
||||
## 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:Person |
|
||||
|
||||
134
generated/docs/Place.md
Normal file
134
generated/docs/Place.md
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
|
||||
# Class: Place
|
||||
|
||||
|
||||
Represents a logical or physical location. See 5.3 Representing Places for additional information.
|
||||
|
||||
URI: [as:Place](http://www.w3.org/ns/activitystreams#Place)
|
||||
|
||||
|
||||
[: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],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]^-[Place|accuracy:float%20%3F;altitude:float%20%3F;latitude:float%20%3F;longitude:float%20%3F;radius:float%20%3F;units:string%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],[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.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [accuracy](accuracy.md) <sub>0..1</sub>
|
||||
* Description: Indicates the accuracy of position coordinates on a Place objects. Expressed in properties of percentage. e.g. "94.0" means "94.0% accurate".
|
||||
* Range: [Float](types/Float.md)
|
||||
* [altitude](altitude.md) <sub>0..1</sub>
|
||||
* Description: Indicates the altitude of a place. The measurement units is indicated using the units property. If units is not specified, the default is assumed to be "m" indicating meters.
|
||||
* Range: [Float](types/Float.md)
|
||||
* [latitude](latitude.md) <sub>0..1</sub>
|
||||
* Description: The latitude of a place
|
||||
* Range: [Float](types/Float.md)
|
||||
* [longitude](longitude.md) <sub>0..1</sub>
|
||||
* Description: The longitude of a place
|
||||
* Range: [Float](types/Float.md)
|
||||
* [radius](radius.md) <sub>0..1</sub>
|
||||
* Description: The radius from the given latitude and longitude for a Place. The units is expressed by the units property. If units is not specified, the default is assumed to be "m" indicating "meters".
|
||||
* Range: [Float](types/Float.md)
|
||||
* [units](units.md) <sub>0..1</sub>
|
||||
* Description: Specifies the measurement units for the radius and altitude properties on a Place object. If not specified, the default is assumed to be "m" for "meters".
|
||||
* 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:Place |
|
||||
| **See also:** | | [https://www.w3.org/TR/activitystreams-vocabulary/#places](https://www.w3.org/TR/activitystreams-vocabulary/#places) |
|
||||
|
||||
118
generated/docs/Profile.md
Normal file
118
generated/docs/Profile.md
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
|
||||
# Class: Profile
|
||||
|
||||
|
||||
A Profile is a content object that describes another Object, typically used to describe Actor Type objects. The describes property is used to reference the object being described by the profile.
|
||||
|
||||
URI: [as:Profile](http://www.w3.org/ns/activitystreams#Profile)
|
||||
|
||||
|
||||
[: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],[Object]^-[Profile],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]<describes%200..1-++[Profile|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],[Object]^-[Profile],[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.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [describes](describes.md) <sub>0..1</sub>
|
||||
* Description: On a Profile object, the describes property identifies the object described by the Profile.
|
||||
* Range: [Object](Object.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:Profile |
|
||||
|
||||
20
generated/docs/Property.md
Normal file
20
generated/docs/Property.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
|
||||
# Class: Property
|
||||
|
||||
|
||||
|
||||
|
||||
URI: [as:Property](http://www.w3.org/ns/activitystreams#Property)
|
||||
|
||||
|
||||
[](https://yuml.me/diagram/nofunky;dir:TB/class/[Property])
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | rdf:Property |
|
||||
|
||||
142
generated/docs/Question.md
Normal file
142
generated/docs/Question.md
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
|
||||
# Class: Question
|
||||
|
||||
|
||||
Represents a question being asked. Question objects are an extension of IntransitiveActivity. That is, the Question object is an Activity, but the direct object is the question itself and therefore it would not contain an object property.
|
||||
Either of the anyOf and oneOf properties MAY be used to express possible answers, but a Question object MUST NOT have both properties.
|
||||
|
||||
URI: [as:Question](http://www.w3.org/ns/activitystreams#Question)
|
||||
|
||||
|
||||
[: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],[IntransitiveActivity],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[IntransitiveActivity]^-[Question|anyOf:string%20*;oneOf:string%20*;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],[IntransitiveActivity],[Collection])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [IntransitiveActivity](IntransitiveActivity.md) - ['An Activity that has no direct object@en']
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [anyOf](anyOf.md) <sub>0..\*</sub>
|
||||
* Description: Identifies an inclusive option for a Question. Use of anyOf implies that the Question can have multiple answers. To indicate that a Question can have only one answer, use oneOf.
|
||||
* Range: [String](types/String.md)
|
||||
* [oneOf](oneOf.md) <sub>0..\*</sub>
|
||||
* Description: Identifies an exclusive option for a Question. Use of oneOf implies that the Question can have only a single answer. To indicate that a Question can have multiple answers, use anyOf.
|
||||
* Range: [String](types/String.md)
|
||||
|
||||
### 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:Question |
|
||||
|
||||
132
generated/docs/Read.md
Normal file
132
generated/docs/Read.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Read
|
||||
|
||||
|
||||
Indicates that the actor has read the object.
|
||||
|
||||
URI: [as:Read](http://www.w3.org/ns/activitystreams#Read)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Read|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],[Collection],[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:Read |
|
||||
|
||||
139
generated/docs/Reject.md
Normal file
139
generated/docs/Reject.md
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
|
||||
# Class: Reject
|
||||
|
||||
|
||||
Indicates that the actor is rejecting the object. The target and origin typically have no defined meaning.
|
||||
|
||||
URI: [as:Reject](http://www.w3.org/ns/activitystreams#Reject)
|
||||
|
||||
|
||||
[: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]^-[TentativeReject],[Activity]^-[Reject],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[TentativeReject],[Reject|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]^-[TentativeReject],[Activity]^-[Reject],[Collection],[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.
|
||||
|
||||
## Children
|
||||
|
||||
* [TentativeReject](TentativeReject.md) - A specialization of Reject in which the rejection is considered 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:Reject |
|
||||
|
||||
132
generated/docs/Remove.md
Normal file
132
generated/docs/Remove.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Remove
|
||||
|
||||
|
||||
Indicates that the actor is removing the object. If specified, the origin indicates the context from which the object is being removed.
|
||||
|
||||
URI: [as:Remove](http://www.w3.org/ns/activitystreams#Remove)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Remove|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],[Collection],[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:Remove |
|
||||
|
||||
112
generated/docs/Service.md
Normal file
112
generated/docs/Service.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Service
|
||||
|
||||
|
||||
Represents a service of any kind.
|
||||
|
||||
URI: [as:Service](http://www.w3.org/ns/activitystreams#Service)
|
||||
|
||||
|
||||
[: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],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]^-[Service|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],[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.
|
||||
|
||||
## 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:Service |
|
||||
|
||||
20
generated/docs/Statement.md
Normal file
20
generated/docs/Statement.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
|
||||
# Class: Statement
|
||||
|
||||
|
||||
|
||||
|
||||
URI: [as:Statement](http://www.w3.org/ns/activitystreams#Statement)
|
||||
|
||||
|
||||
[](https://yuml.me/diagram/nofunky;dir:TB/class/[Statement])
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | rdf:Statement |
|
||||
|
||||
132
generated/docs/TentativeAccept.md
Normal file
132
generated/docs/TentativeAccept.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: TentativeAccept
|
||||
|
||||
|
||||
A specialization of Accept indicating that the acceptance is tentative.
|
||||
|
||||
URI: [as:TentativeAccept](http://www.w3.org/ns/activitystreams#TentativeAccept)
|
||||
|
||||
|
||||
[: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],[Collection],[Accept])](https://yuml.me/diagram/nofunky;dir:TB/class/[Accept]^-[TentativeAccept|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],[Collection],[Accept])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [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.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Inherited from Accept:
|
||||
|
||||
* [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:TentativeAccept |
|
||||
|
||||
132
generated/docs/TentativeReject.md
Normal file
132
generated/docs/TentativeReject.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: TentativeReject
|
||||
|
||||
|
||||
A specialization of Reject in which the rejection is considered tentative.
|
||||
|
||||
URI: [as:TentativeReject](http://www.w3.org/ns/activitystreams#TentativeReject)
|
||||
|
||||
|
||||
[: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],[Reject],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Reject]^-[TentativeReject|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],[Reject],[Collection])
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [Reject](Reject.md) - Indicates that the actor is rejecting the object. The target and origin typically have no defined meaning.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Inherited from Reject:
|
||||
|
||||
* [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:TentativeReject |
|
||||
|
||||
121
generated/docs/Tombstone.md
Normal file
121
generated/docs/Tombstone.md
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
|
||||
# Class: Tombstone
|
||||
|
||||
|
||||
A Tombstone represents a content object that has been deleted. It can be used in Collections to signify that there used to be an object at this position, but it has been deleted.
|
||||
|
||||
URI: [as:Tombstone](http://www.w3.org/ns/activitystreams#Tombstone)
|
||||
|
||||
|
||||
[: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],[Object]^-[Tombstone],[Object],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Object]<formerType%200..*-++[Tombstone|deleted:datetime%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],[Object]^-[Tombstone],[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.
|
||||
|
||||
## Attributes
|
||||
|
||||
|
||||
### Own
|
||||
|
||||
* [formerType](formerType.md) <sub>0..\*</sub>
|
||||
* Description: On a Tombstone object, the formerType property identifies the type of the object that was deleted.
|
||||
* Range: [Object](Object.md)
|
||||
* [deleted](deleted.md) <sub>0..1</sub>
|
||||
* Description: On a Tombstone object, the deleted property is a timestamp for when the object was deleted.
|
||||
* Range: [Datetime](types/Datetime.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:Tombstone |
|
||||
|
||||
132
generated/docs/Travel.md
Normal file
132
generated/docs/Travel.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Travel
|
||||
|
||||
|
||||
Indicates that the actor is traveling to target from origin. Travel is an IntransitiveObject whose actor specifies the direct object. If the target or origin are not specified, either can be determined by context.
|
||||
|
||||
URI: [as:Travel](http://www.w3.org/ns/activitystreams#Travel)
|
||||
|
||||
|
||||
[: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],[IntransitiveActivity],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[IntransitiveActivity]^-[Travel|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],[IntransitiveActivity],[Collection])
|
||||
|
||||
## 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:Travel |
|
||||
|
||||
132
generated/docs/Undo.md
Normal file
132
generated/docs/Undo.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Undo
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:Undo](http://www.w3.org/ns/activitystreams#Undo)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Undo|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],[Collection],[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:Undo |
|
||||
|
||||
132
generated/docs/Update.md
Normal file
132
generated/docs/Update.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: Update
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:Update](http://www.w3.org/ns/activitystreams#Update)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[Update|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],[Collection],[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:Update |
|
||||
|
||||
112
generated/docs/Video.md
Normal file
112
generated/docs/Video.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Video
|
||||
|
||||
|
||||
Represents a video document of any kind.
|
||||
|
||||
URI: [as:Video](http://www.w3.org/ns/activitystreams#Video)
|
||||
|
||||
|
||||
[: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],[Document],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Document]^-[Video|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],[Document],[Collection])
|
||||
|
||||
## 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:Video |
|
||||
|
||||
132
generated/docs/View.md
Normal file
132
generated/docs/View.md
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
# Class: View
|
||||
|
||||
|
||||
Indicates that the actor has viewed the object.
|
||||
|
||||
URI: [as:View](http://www.w3.org/ns/activitystreams#View)
|
||||
|
||||
|
||||
[: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],[Collection],[Activity])](https://yuml.me/diagram/nofunky;dir:TB/class/[Activity]^-[View|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],[Collection],[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:View |
|
||||
|
||||
29
generated/docs/accuracy.md
Normal file
29
generated/docs/accuracy.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: accuracy
|
||||
|
||||
|
||||
Indicates the accuracy of position coordinates on a Place objects. Expressed in properties of percentage. e.g. "94.0" means "94.0% accurate".
|
||||
|
||||
URI: [as:accuracy](http://www.w3.org/ns/activitystreams#accuracy)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Float](types/Float.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Place](Place.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:accuracy |
|
||||
|
||||
68
generated/docs/activitypub.md
Normal file
68
generated/docs/activitypub.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
|
||||
# linkml-activitypub
|
||||
|
||||
|
||||
**metamodel version:** 1.7.0
|
||||
|
||||
**version:** None
|
||||
|
||||
|
||||
Extension of ActivityStreams2 schema to include ActivityPub Actor and other definitions
|
||||
|
||||
|
||||
### Classes
|
||||
|
||||
|
||||
### Mixins
|
||||
|
||||
|
||||
### Slots
|
||||
|
||||
|
||||
### Enums
|
||||
|
||||
|
||||
### Subsets
|
||||
|
||||
|
||||
### Types
|
||||
|
||||
|
||||
#### Built in
|
||||
|
||||
* **Bool**
|
||||
* **Curie**
|
||||
* **Decimal**
|
||||
* **ElementIdentifier**
|
||||
* **NCName**
|
||||
* **NodeIdentifier**
|
||||
* **URI**
|
||||
* **URIorCURIE**
|
||||
* **XSDDate**
|
||||
* **XSDDateTime**
|
||||
* **XSDTime**
|
||||
* **float**
|
||||
* **int**
|
||||
* **str**
|
||||
|
||||
#### Defined
|
||||
|
||||
* [Boolean](types/Boolean.md) (**Bool**) - A binary (true or false) value
|
||||
* [Curie](types/Curie.md) (**Curie**) - a compact URI
|
||||
* [Date](types/Date.md) (**XSDDate**) - a date (year, month and day) in an idealized calendar
|
||||
* [DateOrDatetime](types/DateOrDatetime.md) (**str**) - Either a date or a datetime
|
||||
* [Datetime](types/Datetime.md) (**XSDDateTime**) - The combination of a date and time
|
||||
* [Decimal](types/Decimal.md) (**Decimal**) - A real number with arbitrary precision that conforms to the xsd:decimal specification
|
||||
* [Double](types/Double.md) (**float**) - A real number that conforms to the xsd:double specification
|
||||
* [Float](types/Float.md) (**float**) - A real number that conforms to the xsd:float specification
|
||||
* [Integer](types/Integer.md) (**int**) - An integer
|
||||
* [Jsonpath](types/Jsonpath.md) (**str**) - A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form.
|
||||
* [Jsonpointer](types/Jsonpointer.md) (**str**) - A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form.
|
||||
* [Ncname](types/Ncname.md) (**NCName**) - Prefix part of CURIE
|
||||
* [Nodeidentifier](types/Nodeidentifier.md) (**NodeIdentifier**) - A URI, CURIE or BNODE that represents a node in a model.
|
||||
* [Objectidentifier](types/Objectidentifier.md) (**ElementIdentifier**) - A URI or CURIE that represents an object in the model.
|
||||
* [Sparqlpath](types/Sparqlpath.md) (**str**) - A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF.
|
||||
* [String](types/String.md) (**str**) - A character string
|
||||
* [Time](types/Time.md) (**XSDTime**) - A time object represents a (local) time of day, independent of any particular day
|
||||
* [Uri](types/Uri.md) (**URI**) - a complete URI
|
||||
* [Uriorcurie](types/Uriorcurie.md) (**URIorCURIE**) - a URI or a CURIE
|
||||
195
generated/docs/activitystreams.md
Normal file
195
generated/docs/activitystreams.md
Normal file
|
|
@ -0,0 +1,195 @@
|
|||
|
||||
# linkml-activitystreams
|
||||
|
||||
|
||||
**metamodel version:** 1.7.0
|
||||
|
||||
**version:** None
|
||||
|
||||
|
||||
LinkML representation of ActivityStreams 2 Schema.
|
||||
|
||||
|
||||
### Classes
|
||||
|
||||
* [Link](Link.md) - A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by [ RFC5988]. Many of the properties defined by the Activity Vocabulary allow values that are either instances of Object or Link. When a Link is used, it establishes a qualified relation connecting the subject (the containing object) to the resource identified by the href. Properties of the Link are properties of the reference as opposed to properties of the resource.
|
||||
* [Mention](Mention.md) - A specialized Link that represents an @mention.
|
||||
* [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.
|
||||
* [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.
|
||||
* [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.
|
||||
* [TentativeAccept](TentativeAccept.md) - A specialization of Accept indicating that the acceptance is tentative.
|
||||
* [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.
|
||||
* [Block](Block.md) - 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.
|
||||
* [IntransitiveActivity](IntransitiveActivity.md) - ['An Activity that has no direct object@en']
|
||||
* [Arrive](Arrive.md) - 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.
|
||||
* [Question](Question.md) - Represents a question being asked. Question objects are an extension of IntransitiveActivity. That is, the Question object is an Activity, but the direct object is the question itself and therefore it would not contain an object property.
|
||||
* [Travel](Travel.md) - Indicates that the actor is traveling to target from origin. Travel is an IntransitiveObject whose actor specifies the direct object. If the target or origin are not specified, either can be determined by context.
|
||||
* [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.
|
||||
* [Invite](Invite.md) - A specialization of Offer in which the actor is extending an invitation for the object to the target.
|
||||
* [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.
|
||||
* [TentativeReject](TentativeReject.md) - A specialization of Reject in which the rejection is considered tentative.
|
||||
* [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.
|
||||
* [Application](Application.md) - Describes a software application.
|
||||
* [Article](Article.md)
|
||||
* [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.
|
||||
* [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.
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md) - Used to represent ordered subsets of items from an OrderedCollection. Refer to the Activity Streams 2.0 Core for a complete description of the OrderedCollectionPage object.
|
||||
* [Document](Document.md) - Represents a document of any kind.
|
||||
* [Audio](Audio.md) - Represents an audio document of any kind.
|
||||
* [Image](Image.md) - An image document of any kind
|
||||
* [Video](Video.md) - Represents a video document of any kind.
|
||||
* [Event](Event.md) - Represents any kind of event.
|
||||
* [Group](Group.md) - Represents a formal or informal collective of Actors.
|
||||
* [Note](Note.md) - Represents a short written work typically less than a single paragraph in length.
|
||||
* [Organization](Organization.md) - Represents an organization.
|
||||
* [Page](Page.md) - Represents a Web Page.
|
||||
* [Person](Person.md) - Represents an individual person.
|
||||
* [Place](Place.md) - Represents a logical or physical location. See 5.3 Representing Places for additional information.
|
||||
* [Profile](Profile.md) - A Profile is a content object that describes another Object, typically used to describe Actor Type objects. The describes property is used to reference the object being described by the profile.
|
||||
* [Relationship](Relationship.md) - Describes a relationship between two individuals. The subject and object properties are used to identify the connected individuals.
|
||||
* [Service](Service.md) - Represents a service of any kind.
|
||||
* [Tombstone](Tombstone.md) - A Tombstone represents a content object that has been deleted. It can be used in Collections to signify that there used to be an object at this position, but it has been deleted.
|
||||
* [OrderedItems](OrderedItems.md) - OrderedItems is not a real class in the ActivityStreams specification, but it is used as the container of the items in `OrderedCollections`
|
||||
* [Property](Property.md)
|
||||
* [Statement](Statement.md)
|
||||
|
||||
### Mixins
|
||||
|
||||
|
||||
### Slots
|
||||
|
||||
* [accuracy](accuracy.md) - Indicates the accuracy of position coordinates on a Place objects. Expressed in properties of percentage. e.g. "94.0" means "94.0% accurate".
|
||||
* [altitude](altitude.md) - Indicates the altitude of a place. The measurement units is indicated using the units property. If units is not specified, the default is assumed to be "m" indicating meters.
|
||||
* [anyOf](anyOf.md) - Identifies an inclusive option for a Question. Use of anyOf implies that the Question can have multiple answers. To indicate that a Question can have only one answer, use oneOf.
|
||||
* [attachment](attachment.md) - 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.
|
||||
* [attributedTo](attributedTo.md) - 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.
|
||||
* [actor](actor.md) - 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.
|
||||
* [audience](audience.md) - Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
|
||||
* [bcc](bcc.md) - Identifies one or more Objects that are part of the private secondary audience of this Object.
|
||||
* [bto](bto.md) - Identifies an Object that is part of the private primary audience of this Object.
|
||||
* [cc](cc.md) - Identifies an Object that is part of the public secondary audience of this Object.
|
||||
* [closed](closed.md) - Indicates that a question has been closed, and answers are no longer accepted.
|
||||
* [content](content.md) - 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.
|
||||
* [context](context.md) - Identifies the context within which the object exists or an activity was performed.
|
||||
* [current](current.md) - In a paged Collection, indicates the page that contains the most recently updated member items.
|
||||
* [deleted](deleted.md) - On a Tombstone object, the deleted property is a timestamp for when the object was deleted.
|
||||
* [describes](describes.md) - On a Profile object, the describes property identifies the object described by the Profile.
|
||||
* [duration](duration.md) - 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").
|
||||
* [endTime](endTime.md) - 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.
|
||||
* [first](first.md) - In a paged Collection, indicates the furthest preceeding page of items in the collection.
|
||||
* [formerType](formerType.md) - On a Tombstone object, the formerType property identifies the type of the object that was deleted.
|
||||
* [generator](generator.md) - Identifies the entity (e.g. an application) that generated the object.
|
||||
* [height](height.md) - On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource.
|
||||
* [href](href.md) - The target resource pointed to by a Link.
|
||||
* [hreflang](hreflang.md) - Hints as to the language used by the target resource. Value MUST be a [BCP47] Language-Tag.
|
||||
* [icon](icon.md) - 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.
|
||||
* [id](id.md) - Provides the globally unique identifier for an Object or Link.
|
||||
* [image](image.md) - Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.
|
||||
* [inReplyTo](inReplyTo.md) - Indicates one or more entities for which this object is considered a response.
|
||||
* [instrument](instrument.md) - Identifies one or more objects used (or to be used) in the completion of an Activity.
|
||||
* [items](items.md) - Identifies the items contained in a collection. The items might be ordered or unordered.
|
||||
* [Collection➞items](Collection_items.md)
|
||||
* [OrderedCollection➞items](OrderedCollection_items.md)
|
||||
* [OrderedCollectionPage➞items](OrderedCollectionPage_items.md)
|
||||
* [last](last.md) - In a paged Collection, indicates the furthest proceeding page of the collection.
|
||||
* [latitude](latitude.md) - The latitude of a place
|
||||
* [location](location.md) - Indicates one or more physical or logical locations associated with the object.
|
||||
* [longitude](longitude.md) - The longitude of a place
|
||||
* [mediaType](mediaType.md) - When used on a Link, identifies the MIME media type of the referenced resource.
|
||||
* [name](name.md) - 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.
|
||||
* [next](next.md) - In a paged Collection, indicates the next page of items.
|
||||
* [object](object.md) - 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.
|
||||
* [oneOf](oneOf.md) - Identifies an exclusive option for a Question. Use of oneOf implies that the Question can have only a single answer. To indicate that a Question can have multiple answers, use anyOf.
|
||||
* [origin](origin.md) - 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".
|
||||
* [partOf](partOf.md) - Identifies the Collection to which a CollectionPage objects items belong.
|
||||
* [prev](prev.md) - In a paged Collection, identifies the previous page of items.
|
||||
* [preview](preview.md) - Identifies an entity that provides a preview of this object.
|
||||
* [published](published.md) - The date and time at which the object was published
|
||||
* [radius](radius.md) - The radius from the given latitude and longitude for a Place. The units is expressed by the units property. If units is not specified, the default is assumed to be "m" indicating "meters".
|
||||
* [rel](rel.md) - A link relation associated with a Link. The value MUST conform to both the [HTML5] and [RFC5988] "link relation" definitions.
|
||||
* [relationship](relationship.md) - On a Relationship object, the relationship property identifies the kind of relationship that exists between subject and object.
|
||||
* [replies](replies.md) - Identifies a Collection containing objects considered to be responses to this object.
|
||||
* [result](result.md) - 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.
|
||||
* [startIndex](startIndex.md) - A non-negative integer value identifying the relative position within the logical view of a strictly ordered collection.
|
||||
* [startTime](startTime.md) - 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.
|
||||
* [subject](subject.md) - On a Relationship object, the subject property identifies one of the connected individuals. For instance, for a Relationship object describing "John is related to Sally", subject would refer to John.
|
||||
* [summary](summary.md) - A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided.
|
||||
* [tag](tag.md) - 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.
|
||||
* [target](target.md) - 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.
|
||||
* [to](to.md) - Identifies an entity considered to be part of the public primary audience of an Object
|
||||
* [totalItems](totalItems.md) - 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.
|
||||
* [type](type.md) - Identifies the Object or Link type. Multiple values may be specified.
|
||||
* [units](units.md) - Specifies the measurement units for the radius and altitude properties on a Place object. If not specified, the default is assumed to be "m" for "meters".
|
||||
* [updated](updated.md) - The date and time at which the object was updated
|
||||
* [url](url.md) - Identifies one or more links to representations of the object
|
||||
* [width](width.md) - On a Link, specifies a hint as to the rendering width in device-independent pixels of the linked resource.
|
||||
|
||||
### Enums
|
||||
|
||||
* [unitEnum](unitEnum.md)
|
||||
|
||||
### Subsets
|
||||
|
||||
|
||||
### Types
|
||||
|
||||
|
||||
#### Built in
|
||||
|
||||
* **Bool**
|
||||
* **Curie**
|
||||
* **Decimal**
|
||||
* **ElementIdentifier**
|
||||
* **NCName**
|
||||
* **NodeIdentifier**
|
||||
* **URI**
|
||||
* **URIorCURIE**
|
||||
* **XSDDate**
|
||||
* **XSDDateTime**
|
||||
* **XSDTime**
|
||||
* **float**
|
||||
* **int**
|
||||
* **str**
|
||||
|
||||
#### Defined
|
||||
|
||||
* [AnyURI](types/AnyURI.md) ([String](types/String.md))
|
||||
* [Boolean](types/Boolean.md) (**Bool**) - A binary (true or false) value
|
||||
* [Curie](types/Curie.md) (**Curie**) - a compact URI
|
||||
* [Date](types/Date.md) (**XSDDate**) - a date (year, month and day) in an idealized calendar
|
||||
* [DateOrDatetime](types/DateOrDatetime.md) (**str**) - Either a date or a datetime
|
||||
* [Datetime](types/Datetime.md) (**XSDDateTime**) - The combination of a date and time
|
||||
* [Decimal](types/Decimal.md) (**Decimal**) - A real number with arbitrary precision that conforms to the xsd:decimal specification
|
||||
* [Double](types/Double.md) (**float**) - A real number that conforms to the xsd:double specification
|
||||
* [DurationType](types/DurationType.md) ([String](types/String.md))
|
||||
* [Float](types/Float.md) (**float**) - A real number that conforms to the xsd:float specification
|
||||
* [Integer](types/Integer.md) (**int**) - An integer
|
||||
* [Jsonpath](types/Jsonpath.md) (**str**) - A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form.
|
||||
* [Jsonpointer](types/Jsonpointer.md) (**str**) - A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form.
|
||||
* [LangString](types/LangString.md) ([String](types/String.md))
|
||||
* [Ncname](types/Ncname.md) (**NCName**) - Prefix part of CURIE
|
||||
* [Nodeidentifier](types/Nodeidentifier.md) (**NodeIdentifier**) - A URI, CURIE or BNODE that represents a node in a model.
|
||||
* [NonNegativeInteger](types/NonNegativeInteger.md) ([Integer](types/Integer.md))
|
||||
* [Objectidentifier](types/Objectidentifier.md) (**ElementIdentifier**) - A URI or CURIE that represents an object in the model.
|
||||
* [Sparqlpath](types/Sparqlpath.md) (**str**) - A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF.
|
||||
* [String](types/String.md) (**str**) - A character string
|
||||
* [Time](types/Time.md) (**XSDTime**) - A time object represents a (local) time of day, independent of any particular day
|
||||
* [Uri](types/Uri.md) (**URI**) - a complete URI
|
||||
* [Uriorcurie](types/Uriorcurie.md) (**URIorCURIE**) - a URI or a CURIE
|
||||
59
generated/docs/actor.md
Normal file
59
generated/docs/actor.md
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
|
||||
# Slot: actor
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:actor](http://www.w3.org/ns/activitystreams#actor)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
* is_a: [attributedTo](attributedTo.md)
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Block](Block.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Offer](Offer.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Remove](Remove.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:actor |
|
||||
|
||||
29
generated/docs/altitude.md
Normal file
29
generated/docs/altitude.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: altitude
|
||||
|
||||
|
||||
Indicates the altitude of a place. The measurement units is indicated using the units property. If units is not specified, the default is assumed to be "m" indicating meters.
|
||||
|
||||
URI: [as:altitude](http://www.w3.org/ns/activitystreams#altitude)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Float](types/Float.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Place](Place.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:altitude |
|
||||
|
||||
29
generated/docs/anyOf.md
Normal file
29
generated/docs/anyOf.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: anyOf
|
||||
|
||||
|
||||
Identifies an inclusive option for a Question. Use of anyOf implies that the Question can have multiple answers. To indicate that a Question can have only one answer, use oneOf.
|
||||
|
||||
URI: [as:anyOf](http://www.w3.org/ns/activitystreams#anyOf)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Question](Question.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:anyOf |
|
||||
|
||||
80
generated/docs/attachment.md
Normal file
80
generated/docs/attachment.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: attachment
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:attachment](http://www.w3.org/ns/activitystreams#attachment)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:attachment |
|
||||
|
||||
81
generated/docs/attributedTo.md
Normal file
81
generated/docs/attributedTo.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
|
||||
# Slot: attributedTo
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:attributedTo](http://www.w3.org/ns/activitystreams#attributedTo)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
* [actor](actor.md)
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:attributedTo |
|
||||
|
||||
80
generated/docs/audience.md
Normal file
80
generated/docs/audience.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: audience
|
||||
|
||||
|
||||
Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant.
|
||||
|
||||
URI: [as:audience](http://www.w3.org/ns/activitystreams#audience)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:audience |
|
||||
|
||||
80
generated/docs/bcc.md
Normal file
80
generated/docs/bcc.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: bcc
|
||||
|
||||
|
||||
Identifies one or more Objects that are part of the private secondary audience of this Object.
|
||||
|
||||
URI: [as:bcc](http://www.w3.org/ns/activitystreams#bcc)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:bcc |
|
||||
|
||||
80
generated/docs/bto.md
Normal file
80
generated/docs/bto.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: bto
|
||||
|
||||
|
||||
Identifies an Object that is part of the private primary audience of this Object.
|
||||
|
||||
URI: [as:bto](http://www.w3.org/ns/activitystreams#bto)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:bto |
|
||||
|
||||
80
generated/docs/cc.md
Normal file
80
generated/docs/cc.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: cc
|
||||
|
||||
|
||||
Identifies an Object that is part of the public secondary audience of this Object.
|
||||
|
||||
URI: [as:cc](http://www.w3.org/ns/activitystreams#cc)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:cc |
|
||||
|
||||
21
generated/docs/closed.md
Normal file
21
generated/docs/closed.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
|
||||
# Slot: closed
|
||||
|
||||
|
||||
Indicates that a question has been closed, and answers are no longer accepted.
|
||||
|
||||
URI: [as:closed](http://www.w3.org/ns/activitystreams#closed)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
80
generated/docs/content.md
Normal file
80
generated/docs/content.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: content
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:content](http://www.w3.org/ns/activitystreams#content)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:content |
|
||||
|
||||
81
generated/docs/context.md
Normal file
81
generated/docs/context.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
|
||||
# Slot: context
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:context](http://www.w3.org/ns/activitystreams#context)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:context |
|
||||
|
||||
32
generated/docs/current.md
Normal file
32
generated/docs/current.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
# Slot: current
|
||||
|
||||
|
||||
In a paged Collection, indicates the page that contains the most recently updated member items.
|
||||
|
||||
URI: [as:current](http://www.w3.org/ns/activitystreams#current)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:current |
|
||||
|
||||
29
generated/docs/deleted.md
Normal file
29
generated/docs/deleted.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: deleted
|
||||
|
||||
|
||||
On a Tombstone object, the deleted property is a timestamp for when the object was deleted.
|
||||
|
||||
URI: [as:deleted](http://www.w3.org/ns/activitystreams#deleted)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Datetime](types/Datetime.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Tombstone](Tombstone.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:deleted |
|
||||
|
||||
29
generated/docs/describes.md
Normal file
29
generated/docs/describes.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: describes
|
||||
|
||||
|
||||
On a Profile object, the describes property identifies the object described by the Profile.
|
||||
|
||||
URI: [as:describes](http://www.w3.org/ns/activitystreams#describes)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Object](Object.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Profile](Profile.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:describes |
|
||||
|
||||
81
generated/docs/duration.md
Normal file
81
generated/docs/duration.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
|
||||
# Slot: duration
|
||||
|
||||
|
||||
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").
|
||||
|
||||
URI: [as:duration](http://www.w3.org/ns/activitystreams#duration)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [DurationType](types/DurationType.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:duration |
|
||||
| **See also:** | | [https://www.w3.org/TR/xmlschema11-2/](https://www.w3.org/TR/xmlschema11-2/) |
|
||||
|
||||
80
generated/docs/endTime.md
Normal file
80
generated/docs/endTime.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: endTime
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:endTime](http://www.w3.org/ns/activitystreams#endTime)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Datetime](types/Datetime.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:endTime |
|
||||
|
||||
32
generated/docs/first.md
Normal file
32
generated/docs/first.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
# Slot: first
|
||||
|
||||
|
||||
In a paged Collection, indicates the furthest preceeding page of items in the collection.
|
||||
|
||||
URI: [as:first](http://www.w3.org/ns/activitystreams#first)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:first |
|
||||
|
||||
29
generated/docs/formerType.md
Normal file
29
generated/docs/formerType.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: formerType
|
||||
|
||||
|
||||
On a Tombstone object, the formerType property identifies the type of the object that was deleted.
|
||||
|
||||
URI: [as:formerType](http://www.w3.org/ns/activitystreams#formerType)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [Object](Object.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Tombstone](Tombstone.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:formerType |
|
||||
|
||||
80
generated/docs/generator.md
Normal file
80
generated/docs/generator.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: generator
|
||||
|
||||
|
||||
Identifies the entity (e.g. an application) that generated the object.
|
||||
|
||||
URI: [as:generator](http://www.w3.org/ns/activitystreams#generator)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:generator |
|
||||
|
||||
30
generated/docs/height.md
Normal file
30
generated/docs/height.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
|
||||
# Slot: height
|
||||
|
||||
|
||||
On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource.
|
||||
|
||||
URI: [as:height](http://www.w3.org/ns/activitystreams#height)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [NonNegativeInteger](types/NonNegativeInteger.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Link](Link.md)
|
||||
* [Mention](Mention.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:height |
|
||||
|
||||
30
generated/docs/href.md
Normal file
30
generated/docs/href.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
|
||||
# Slot: href
|
||||
|
||||
|
||||
The target resource pointed to by a Link.
|
||||
|
||||
URI: [as:href](http://www.w3.org/ns/activitystreams#href)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [AnyURI](types/AnyURI.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Link](Link.md)
|
||||
* [Mention](Mention.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:href |
|
||||
|
||||
31
generated/docs/hreflang.md
Normal file
31
generated/docs/hreflang.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
# Slot: hreflang
|
||||
|
||||
|
||||
Hints as to the language used by the target resource. Value MUST be a [BCP47] Language-Tag.
|
||||
|
||||
URI: [as:hreflang](http://www.w3.org/ns/activitystreams#hreflang)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Link](Link.md)
|
||||
* [Mention](Mention.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:hreflang |
|
||||
| **Close Mappings:** | | schema:inLanguage |
|
||||
|
||||
80
generated/docs/icon.md
Normal file
80
generated/docs/icon.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: icon
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:icon](http://www.w3.org/ns/activitystreams#icon)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:icon |
|
||||
|
||||
82
generated/docs/id.md
Normal file
82
generated/docs/id.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
|
||||
# Slot: id
|
||||
|
||||
|
||||
Provides the globally unique identifier for an Object or Link.
|
||||
|
||||
URI: [as:id](http://www.w3.org/ns/activitystreams#id)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [AnyURI](types/AnyURI.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Link](Link.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Mention](Mention.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:id |
|
||||
|
||||
112
generated/docs/image.md
Normal file
112
generated/docs/image.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
|
||||
# Class: Image
|
||||
|
||||
|
||||
An image document of any kind
|
||||
|
||||
URI: [as:Image](http://www.w3.org/ns/activitystreams#Image)
|
||||
|
||||
|
||||
[: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],[Document],[Collection])](https://yuml.me/diagram/nofunky;dir:TB/class/[Document]^-[Image|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],[Document],[Collection])
|
||||
|
||||
## 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:Image |
|
||||
|
||||
80
generated/docs/inReplyTo.md
Normal file
80
generated/docs/inReplyTo.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: inReplyTo
|
||||
|
||||
|
||||
Indicates one or more entities for which this object is considered a response.
|
||||
|
||||
URI: [as:inReplyTo](http://www.w3.org/ns/activitystreams#inReplyTo)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:inReplyTo |
|
||||
|
||||
58
generated/docs/instrument.md
Normal file
58
generated/docs/instrument.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
|
||||
# Slot: instrument
|
||||
|
||||
|
||||
Identifies one or more objects used (or to be used) in the completion of an Activity.
|
||||
|
||||
URI: [as:instrument](http://www.w3.org/ns/activitystreams#instrument)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Block](Block.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Offer](Offer.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Remove](Remove.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:instrument |
|
||||
|
||||
29
generated/docs/items.md
Normal file
29
generated/docs/items.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: items
|
||||
|
||||
|
||||
Identifies the items contained in a collection. The items might be ordered or unordered.
|
||||
|
||||
URI: [as:items](http://www.w3.org/ns/activitystreams#items)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
* [Collection➞items](Collection_items.md)
|
||||
|
||||
## Used by
|
||||
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:items |
|
||||
|
||||
32
generated/docs/last.md
Normal file
32
generated/docs/last.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
# Slot: last
|
||||
|
||||
|
||||
In a paged Collection, indicates the furthest proceeding page of the collection.
|
||||
|
||||
URI: [as:last](http://www.w3.org/ns/activitystreams#last)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:last |
|
||||
|
||||
29
generated/docs/latitude.md
Normal file
29
generated/docs/latitude.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: latitude
|
||||
|
||||
|
||||
The latitude of a place
|
||||
|
||||
URI: [as:latitude](http://www.w3.org/ns/activitystreams#latitude)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Float](types/Float.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Place](Place.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:latitude |
|
||||
|
||||
80
generated/docs/location.md
Normal file
80
generated/docs/location.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
|
||||
# Slot: location
|
||||
|
||||
|
||||
Indicates one or more physical or logical locations associated with the object.
|
||||
|
||||
URI: [as:location](http://www.w3.org/ns/activitystreams#location)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:location |
|
||||
|
||||
29
generated/docs/longitude.md
Normal file
29
generated/docs/longitude.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
# Slot: longitude
|
||||
|
||||
|
||||
The longitude of a place
|
||||
|
||||
URI: [as:longitude](http://www.w3.org/ns/activitystreams#longitude)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [Float](types/Float.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Place](Place.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:longitude |
|
||||
|
||||
84
generated/docs/mediaType.md
Normal file
84
generated/docs/mediaType.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
|
||||
# Slot: mediaType
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:mediaType](http://www.w3.org/ns/activitystreams#mediaType)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..1</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Link](Link.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Mention](Mention.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | as:mediaType |
|
||||
| **Exact Mappings:** | | schema:encodingFormat |
|
||||
|
||||
82
generated/docs/name.md
Normal file
82
generated/docs/name.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
|
||||
# Slot: name
|
||||
|
||||
|
||||
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.
|
||||
|
||||
URI: [as:name](http://www.w3.org/ns/activitystreams#name)
|
||||
|
||||
|
||||
## Domain and Range
|
||||
|
||||
None → <sub>0..\*</sub> [String](types/String.md)
|
||||
|
||||
## Parents
|
||||
|
||||
|
||||
## Children
|
||||
|
||||
|
||||
## Used by
|
||||
|
||||
* [Accept](Accept.md)
|
||||
* [Activity](Activity.md)
|
||||
* [Add](Add.md)
|
||||
* [Announce](Announce.md)
|
||||
* [Application](Application.md)
|
||||
* [Arrive](Arrive.md)
|
||||
* [Article](Article.md)
|
||||
* [Audio](Audio.md)
|
||||
* [Block](Block.md)
|
||||
* [Collection](Collection.md)
|
||||
* [CollectionPage](CollectionPage.md)
|
||||
* [Create](Create.md)
|
||||
* [Delete](Delete.md)
|
||||
* [Dislike](Dislike.md)
|
||||
* [Document](Document.md)
|
||||
* [Event](Event.md)
|
||||
* [Flag](Flag.md)
|
||||
* [Follow](Follow.md)
|
||||
* [Group](Group.md)
|
||||
* [Ignore](Ignore.md)
|
||||
* [Image](Image.md)
|
||||
* [IntransitiveActivity](IntransitiveActivity.md)
|
||||
* [Invite](Invite.md)
|
||||
* [Join](Join.md)
|
||||
* [Leave](Leave.md)
|
||||
* [Like](Like.md)
|
||||
* [Link](Link.md)
|
||||
* [Listen](Listen.md)
|
||||
* [Mention](Mention.md)
|
||||
* [Move](Move.md)
|
||||
* [Note](Note.md)
|
||||
* [Object](Object.md)
|
||||
* [Offer](Offer.md)
|
||||
* [OrderedCollection](OrderedCollection.md)
|
||||
* [OrderedCollectionPage](OrderedCollectionPage.md)
|
||||
* [Organization](Organization.md)
|
||||
* [Page](Page.md)
|
||||
* [Person](Person.md)
|
||||
* [Place](Place.md)
|
||||
* [Profile](Profile.md)
|
||||
* [Question](Question.md)
|
||||
* [Read](Read.md)
|
||||
* [Reject](Reject.md)
|
||||
* [Relationship](Relationship.md)
|
||||
* [Remove](Remove.md)
|
||||
* [Service](Service.md)
|
||||
* [TentativeAccept](TentativeAccept.md)
|
||||
* [TentativeReject](TentativeReject.md)
|
||||
* [Tombstone](Tombstone.md)
|
||||
* [Travel](Travel.md)
|
||||
* [Undo](Undo.md)
|
||||
* [Update](Update.md)
|
||||
* [Video](Video.md)
|
||||
* [View](View.md)
|
||||
|
||||
## Other properties
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Mappings:** | | rdfs:name |
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue