Module generated

Expand description

Vocabulary types generated from Fedify’s schemas.

Do not edit this file. It is written by cargo run -p ojak-vocab-gen from crates/ojak-vocab/schemas, which are Fedify’s work under the MIT license in that directory, and a test fails when it differs from what the generator would write now.

Each type reads a document in the form crate::read produces and writes one in the same spelling. A property that may take several types takes an enum of them, with Iri for a reference and Other for anything no schema describes.

Structs§

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.
Activity: An Activity is a subtype of {@link Object} that describes some form of action that may happen, is currently happening, or has already happened. The {@link Activity} type itself serves as an abstract base type for all types of activities. It is important to note that the {@link Activity} type itself does not carry any specific semantics about the kind of action being taken.
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.
Agreement: The agreement reached between parties responding to a {@link Proposal}.
Announce: Indicates that the actor is calling the target’s attention the object.
AnnounceAuthorization: Proves that an {@link Announce} interaction has been approved by the post author.
AnnounceRequest: A request to announce (boost) a post that requires approval from the post author.
Application: Describes a software application.
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.
Article: Represents any kind of multi-paragraph written work.
Audio: Represents an audio document of any kind.
Block: Indicates that the actor is blocking the object. Blocking is a stronger form of {@link 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.
ChatMessage: ChatMessages are the messages sent in 1-on-1 chats. They are similar to {@link Note}s, but the addressing is done by having a single AP actor in the to field. Addressing multiple actors is not allowed. These messages are always private, there is no public version of them. They are created with a {@link Create} activity.
Collection: A Collection is a subtype of {@link Object} that represents ordered or unordered sets of {@link Object} or {@link Link} instances.
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.
Commitment: A promised economic transaction, referenced by an {@link Agreement}.
Create: Indicates that the actor has created the object.
CryptographicKey: A key owned by an actor.
DataIntegrityProof: A proof that can be added to any activity or object, allowing recipients to verify the identity of the actor and the integrity of the data.
Delete: Indicates that the actor has deleted the object. If specified, the origin indicates the context from which the object was deleted.
DidService: Means of communicating or interacting with the DID subject or associated entities via one or more service endpoints. Examples include discovery services, agent services, social networking services, file storage services, and verifiable credential repository services.
Dislike: Indicates that the actor dislikes the object.
Document: Represents a document of any kind.
Emoji: Represents a custom emoji.
EmojiReact: Represents an emoji reaction. See also FEP-c0e0.
Endpoints: Contents of {@link Actor}’s endpoints.
Event: Represents any kind of event.
Export: “Export Actor” service.
FeatureAuthorization: Proves that an actor consented to being included in a {@link FeaturedCollection}.
FeatureRequest: A request for consent before featuring an actor in a {@link FeaturedCollection}.
FeaturedCollection: A curated collection of recommended actors or other objects.
FeaturedItem: A single entry in a {@link FeaturedCollection}.
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.
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.
Group: Represents a formal or informal collective of Actors.
Hashtag: A specialized {@link Link} that represents an #hashtag.
Ignore: Indicates that the actor is ignoring the object. The target and origin typically have no defined meaning.
Image: An image document of any kind.
Intent: A proposed economic transaction describing what is being offered or requested in a {@link Proposal}.
InteractionPolicy: Represents an interaction policy attached to a post, specifying who can like, reply to, announce, or quote it. Each sub-policy ({@link InteractionRule}) defines which actors receive automatic or manual approval.
InteractionRule: Represents a sub-policy within an {@link InteractionPolicy}, defining which actors receive automatic or manual approval for a specific interaction type (like, reply, or announce).
IntransitiveActivity: Instances of IntransitiveActivity are a subtype of {@link Activity} representing intransitive actions. The object property is therefore inappropriate for these activities.
Invite: A specialization of Offer in which the actor is extending an invitation for the object to the target.
Join: Indicates that the actor has joined the object. The target and origin typically have no defined meaning.
Leave: Indicates that the actor has left the object. The target and origin typically have no meaning.
Like: Indicates that the actor likes, recommends or endorses the object. The target and origin typically have no defined meaning.
LikeAuthorization: Proves that a {@link Like} interaction has been approved by the post author.
LikeRequest: A request to like a post that requires approval from the post author.
Link: A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by RFC 5988. Many of the properties defined by the Activity Vocabulary allow values that are either instances of {@link Object} or {@link Link}. When a {@link 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 Link} are properties of the reference as opposed to properties of the resource.
Listen: Indicates that the actor has listened to the object.
Measure: A quantity with a unit of measure.
Mention: A specialized {@link Link} that represents an @mention.
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.
Multikey: Represents a key owned by an actor according to FEP-521a: Representing actor’s public keys.
Note: Represents a short written work typically less than a single paragraph in length.
Object: 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 {@link Activity}, {@link IntransitiveActivity}, {@link Collection} and {@link OrderedCollection}.
Offer: Indicates that the actor is offering the object. If specified, the target indicates the entity to which the object is being offered.
OrderedCollection: A subtype of {@link Collection} in which members of the logical collection are assumed to always be strictly ordered.
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.
Organization: Represents an organization.
Page: Represents a Web Page.
Person: Represents an individual person.
Place: Represents a logical or physical location. See 5.3 Representing Places for additional information.
Profile: A {@link Profile} is a content object that describes another {@link Object}, typically used to describe Actor Type objects. The {@link Profile.describes} property is used to reference the object being described by the profile.
PropertyValue: A pair of property name and value.
Proposal: A published request or offer, sometimes with what is expected in return.
Question: Represents a question being asked. Question objects are an extension of {@link 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.
QuoteAuthorization: Proves that a quote interaction has been approved by the quoted object’s author.
QuoteRequest: A request to quote an object that requires approval from the quoted object’s author.
Read: Indicates that the actor has read the object.
Reject: Indicates that the actor is rejecting the object. The target and origin typically have no defined meaning.
Relationship: Describes a relationship between two individuals. The {@link Relationship.subject} and {@link Relationship.object} properties are used to identify the connected individuals.
Remove: Indicates that the actor is removing the object. If specified, the origin indicates the context from which the object is being removed.
ReplyAuthorization: Proves that a reply interaction has been approved by the post author.
ReplyRequest: A request to reply to a post that requires approval from the post author.
Service: Represents a service of any kind.
Source: Contents of {@link Object}’s source.
TentativeAccept: A specialization of {@link Accept} indicating that the acceptance is tentative.
TentativeReject: A specialization of {@link Reject} in which the rejection is considered tentative.
Tombstone: A Tombstone represents a content object that has been deleted. It can be used in {@link Collection}s to signify that there used to be an object at this position, but it has been deleted.
Translation: Translator credit and source freshness for one language version of an {@link Object}, as defined by the draft FEP-22cd. This is embedded metadata, not an independent post or activity target. Its optional identifier need not be dereferenceable and does not establish trust in embedded translator actors.
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.
Undo: Indicates that the actor is undoing the object. In most cases, the object will be an {@link 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).
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.
Video: Represents a video document of any kind.
View: Indicates that the actor has viewed the object.

Enums§

AnyActor: A value of Application, Group, Organization, Person, Service, or of a type extending one of them.
AnyCollection: A value of Collection, or of a type extending one of them.
AnyCollectionPage: A value of CollectionPage, or of a type extending one of them.
AnyDidService: A value of DidService, or of a type extending one of them.
AnyObject: A value of Object, or of a type extending one of them.
AnyOrderedCollection: A value of OrderedCollection, or of a type extending one of them.
BooleanOrDateTime: A value of Boolean, DateTime, or of a type extending one of them.
IriOrUnits: A value of Iri, Units, or of a type extending one of them.
LinkOrIri: A value of Iri, Link, or of a type extending one of them.
LinkOrObject: A value of Link, Object, or of a type extending one of them.
LinkOrObjectOrPropertyValue: A value of PropertyValue, Link, Object, or of a type extending one of them.
OrderedCollectionOrOrderedCollectionPage: A value of OrderedCollection, OrderedCollectionPage, or of a type extending one of them.