Skip to content

Model Reference

Django ActivityPub Toolkit uses several categories of models to represent ActivityPub data structures, federation state, and application-specific entities.

Core Federation Models

These models manage the fundamental entities for ActivityPub federation.

Domains and References

activitypub.models.Domain

Bases: TimeStampedModel

activitypub.models.Reference

Bases: StatusModel

The Reference is the base class for any JSON-LD context.

activitypub.models.LinkedDataDocument

Bases: Model

A linked data document contains only the source JSON-LD documents

Accounts and Actors

activitypub.models.Account

Bases: Model

activitypub.models.ActivityPubServer

Bases: Model

ActivityStreams Context Models

These models store ActivityStreams 2.0 vocabulary data attached to references.

Core Types

activitypub.models.LinkContext

Bases: AbstractContextModel

activitypub.models.as2.AbstractAs2ObjectContext

Bases: AbstractContextModel

ActivityStreams 2.0 vocabulary context. Stores AS2-specific fields like name, type, published, actor, etc.

activitypub.models.ActorContext

Bases: BaseAs2ObjectContext

activitypub.models.ActivityContext

Bases: BaseAs2ObjectContext

activitypub.models.QuestionContext

Bases: AbstractContextModel

Collections

activitypub.models.CollectionContext

Bases: BaseCollectionContext

activitypub.models.CollectionPageContext

Bases: BaseCollectionContext

activitypub.models.CollectionItem

Bases: Model

Extended Properties

activitypub.models.EndpointContext

Bases: AbstractContextModel

activitypub.models.LinkRelation

Bases: Model

activitypub.models.RelationshipProperties

Bases: Model

activitypub.models.LinkedFile

Bases: Model

Security and Integrity

Models for cryptographic operations and message integrity verification.

activitypub.models.SecV1Context

Bases: AbstractContextModel

Security vocabulary v1 context (https://w3id.org/security/v1). Stores security-specific fields like owner, publicKeyPem, signature, etc.

activitypub.models.HttpMessageSignature

Bases: Model

Notifications and Processing

Models for handling incoming activities and background processing.

activitypub.models.Notification

Bases: Model

activitypub.models.NotificationProcessResult

Bases: Model

activitypub.models.NotificationIntegrityProof

Bases: Model

activitypub.models.NotificationProofVerification

Bases: TimeStampedModel

Social Features

activitypub.models.FollowRequest

Bases: StatusModel, TimeStampedModel