activitystream

README

ActivityStream 🏞

Welcome to the Fediverse

This is a personal experiment to explore Activity Streams. This library is BRAND NEW, and is not ready for use by anyone, for any reason, at any time. Check out https://github.com/go-fed for a library that's ready for prime time.

This is an Experiment

ActivityStreams is so hard to work with in a "strongly typed", "idiomatic go" way, because the W3C spec is so loose with types. While this is great for a Javascript, or old ColdFusion programmer, it's super-cumbersome to try to squeeze this into a Go, or TypeScript paradigm.

So, here's the idea (for now). EVERYTHING is stored as a map[string]interface{}, which is as big of a no-no as using Reflect. But, it's the only way to support the entire spec without doing this.

Consistency will be "enforced" (or at least encouraged) using constructor functions that can construct these data structures in a "proper" way, and validator functions that can accept (nearly) any input, and then format it in a consistent manner.

Something like:

// WRITING ActivityStreams
writer.Announce(
    writer.Actor().Name("John Doe").ID("john@doe.com").URL("john.doe.com"),
    writer.Document().URL("https://me.website.com/document-name"),
    nil
)

// READING ActivityStreams
object, err := New(`{
    "@context": "https://www.w3.org/ns/activitystreams",
    "name": "Foo",
    "id": "http://example.org/foo"
    }`)

object.Name() // "foo"
object.ID() // "http://example.org/foo"

Pull Requests Welcome

This library is a work in progress, and will benefit from your experience reports, use cases, and contributions. If you have an idea for making this library better, send in a pull request. We're all in this together! 🏞

Documentation

Index

• Constants

Constants

const ActivityTypeAccept = "Accept"

ActivityTypeAccept description is TBD

const ActivityTypeAdd = "Add"

ActivityTypeAdd description is TBD

const ActivityTypeAnnounce = "Announce"

ActivityTypeAnnounce description is TBD

const ActivityTypeArrive = "Arrive"

ActivityTypeArrive description is TBD

const ActivityTypeBlock = "Block"

ActivityTypeBlock description is TBD

const ActivityTypeCreate = "Create"

ActivityTypeCreate description is TBD

const ActivityTypeDelete = "Delete"

ActivityTypeDelete description is TBD

const ActivityTypeDislike = "Dislike"

ActivityTypeDislike description is TBD

const ActivityTypeFlag = "Flag"

ActivityTypeFlag description is TBD

const ActivityTypeFollow = "Follow"

ActivityTypeFollow description is TBD

const ActivityTypeIgnore = "Ignore"

ActivityTypeIgnore description is TBD

const ActivityTypeInvite = "Invite"

ActivityTypeInvite description is TBD

const ActivityTypeJoin = "Join"

ActivityTypeJoin description is TBD

const ActivityTypeLeave = "Leave"

ActivityTypeLeave description is TBD

const ActivityTypeLike = "Like"

ActivityTypeLike description is TBD

const ActivityTypeListen = "Listen"

ActivityTypeListen description is TBD

const ActivityTypeMove = "Move"

ActivityTypeMove description is TBD

const ActivityTypeOffer = "Offer"

ActivityTypeOffer description is TBD

const ActivityTypeQuestion = "Question"

ActivityTypeQuestion description is TBD

const ActivityTypeRead = "Read"

ActivityTypeRead description is TBD

const ActivityTypeReject = "Reject"

ActivityTypeReject description is TBD

const ActivityTypeRemove = "Remove"

ActivityTypeRemove description is TBD

const ActivityTypeTentativeAccept = "TentativeAccept"

ActivityTypeTentativeAccept description is TBD

const ActivityTypeTentativeReject = "TentativeReject"

ActivityTypeTentativeReject description is TBD

const ActivityTypeTravel = "Travel"

ActivityTypeTravel description is TBD

const ActivityTypeUndo = "Undo"

ActivityTypeUndo description is TBD

const ActivityTypeUpdate = "Update"

ActivityTypeUpdate description is TBD

const ActivityTypeView = "View"

ActivityTypeView description is TBD

const ActorTypeApplication = "Application"

const ActorTypeGroup = "Group"

const ActorTypeOrganization = "Organization"

const ActorTypePerson = "Person"

const ActorTypeService = "Service"

const LinkTypeMention = "Mention"

LinkTypeMention is a specialized Link that represents an @mention.

const ObjectTypeArticle = "Article"

ObjectTypeArticle represents any kind of multi-paragraph written work.

const ObjectTypeAudio = "Audio"

ObjectTypeAudio represents an audio document of any kind.

const ObjectTypeDocument = "Document"

ObjectTypeDocument represents a document of any kind.

const ObjectTypeEvent = "Event"

ObjectTypeEvent represents any kind of event.

const ObjectTypeImage = "Image"

ObjectTypeImage represents an image document of any kind

const ObjectTypeMention = "Mention"

ObjectTypeMention ???

const ObjectTypeNote = "Note"

ObjectTypeNote represents a short written work typically less than a single paragraph in length.

const ObjectTypePage = "Page"

ObjectTypePage represents a Web Page.

const ObjectTypePlace = "Place"

ObjectTypePlace represents a logical or physical location. See 5.3 Representing Places for additional information.

const ObjectTypeProfile = "Profile"

ObjectTypeProfile 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.

const ObjectTypeRelationship = "Relationship"

ObjectTypeRelationship describes a relationship between two individuals. The subject and object properties are used to identify the connected individuals.

const ObjectTypeTombstone = "Tombstone"

ObjectTypeTombstone 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.

const ObjectTypeVideo = "Video"

ObjectTypeVideo represents a video document of any kind.

const PropertyAccuracy = "accuracy" // (xsd:float)

PropertyAccuracy description is TBD

const PropertyActor = "actor"

PropertyActor description is TBD

const PropertyAltitude = "altitude" // (xsd:float)

PropertyAltitude description is TBD

const PropertyAnyOf = "anyOf"

PropertyAnyOf description is TBD

const PropertyAttachment = "attachment"

PropertyAttachment description is TBD

const PropertyAttachments = "attachments"

PropertyAttachments description is TBD

const PropertyAttributedTo = "attributedTo"

PropertyAttributedTo description is TBD

const PropertyAudience = "audience"

PropertyAudience description is TBD

const PropertyAuthor = "author"

PropertyAuthor description is TBD

const PropertyBTo = "bto"

PropertyBTo description is TBD

const PropertyBcc = "bcc"

PropertyBcc description is TBD

const PropertyCc = "cc"

PropertyCc description is TBD

const PropertyClosed = "closed" // (xsd:dateTime)

PropertyClosed description is TBD

const PropertyContent = "content"

PropertyContent description is TBD

const PropertyContentMap = "contentMap"

PropertyContentMap description is TBD

const PropertyContext = "@context"

PropertyContext description is TBD

const PropertyCurrent = "current"

PropertyCurrent description is TBD

const PropertyDeleted = "deleted" // (xsd:dateTime)

PropertyDeleted description is TBD

const PropertyDescribes = "describes"

PropertyDescribes description is TBD

const PropertyDownstreamDuplicates = "downstreamDuplicates"

PropertyDownstreamDuplicates description is TBD

const PropertyDuration = "duration" // (xsd:duration)

PropertyDuration description is TBD

const PropertyEndTime = "endTime" // (xsd:dateTime)

PropertyEndTime description is TBD

const PropertyFirst = "first"

PropertyFirst description is TBD

const PropertyFormerType = "formerType"

PropertyFormerType description is TBD

const PropertyGenerator = "generator"

PropertyGenerator description is TBD

const PropertyHREF = "href"

PropertyHREF description is TBD

const PropertyHeight = "height" // (xsd:nonNegativeInteger)

PropertyHeight description is TBD

const PropertyHrefLang = "hreflang"

PropertyHrefLang description is TBD

const PropertyID = "id"

PropertyID description is TBD

const PropertyIcon = "icon"

PropertyIcon description is TBD

const PropertyImage = "image"

PropertyImage description is TBD

const PropertyInReplyTo = "inReplyTo"

PropertyInReplyTo description is TBD

const PropertyInstrument = "instrument"

PropertyInstrument description is TBD

const PropertyItems = "items"

PropertyItems description is TBD

const PropertyLast = "last"

PropertyLast description is TBD

const PropertyLatitude = "latitude" // (xsd:float)

PropertyLatitude description is TBD

const PropertyLocation = "location"

PropertyLocation description is TBD

const PropertyLongitude = "longitude" // (xsd:float)

PropertyLongitude description is TBD

const PropertyMediaType = "mediaType"

PropertyMediaType description is TBD

const PropertyName = "name"

PropertyName description is TBD

const PropertyNameMap = "nameMap"

PropertyNameMap description is TBD

const PropertyNext = "next"

PropertyNext description is TBD

const PropertyObject = "object"

PropertyObject description is TBD

const PropertyOneOf = "oneOf"

PropertyOneOf description is TBD

const PropertyOrderedItems = "orderedItems"

PropertyOrderedItems description is TBD

const PropertyOrigin = "origin"

PropertyOrigin description is TBD

const PropertyPartOf = "partOf"

PropertyPartOf description is TBD

const PropertyPrev = "prev"

PropertyPrev description is TBD

const PropertyPreview = "preview"

PropertyPreview description is TBD

const PropertyProvider = "provider"

PropertyProvider description is TBD

const PropertyPublished = "published" // (xsd:dateTime)

PropertyPublished description is TBD

const PropertyRadius = "radius" // (xsd:float)

PropertyRadius description is TBD

const PropertyRating = "rating" // (xsd:float)

PropertyRating description is TBD

const PropertyRel = "rel"

PropertyRel description is TBD

const PropertyRelationship = "relationship"

PropertyRelationship description is TBD

const PropertyReplies = "replies"

PropertyReplies description is TBD

const PropertyResult = "result"

PropertyResult description is TBD

const PropertyStartIndex = "startIndex" // (xsd:nonNegativeInteger)

PropertyStartIndex description is TBD

const PropertyStartTime = "startTime" // (xsd:dateTime)

PropertyStartTime description is TBD

const PropertySubject = "subject"

PropertySubject description is TBD

const PropertySummary = "summary"

PropertySummary description is TBD

const PropertySummaryMap = "summaryMap"

PropertySummaryMap description is TBD

const PropertyTag = "tag"

PropertyTag description is TBD

const PropertyTags = "tags"

PropertyTags description is TBD

const PropertyTarget = "target"

PropertyTarget description is TBD

const PropertyTo = "to"

PropertyTo description is TBD

const PropertyTotalItems = "totalItems" // (xsd:nonNegativeInteger)

PropertyTotalItems description is TBD

const PropertyType = "type"

PropertyType description is TBD

const PropertyURL = "url"

PropertyURL description is TBD

const PropertyUnits = "units"

PropertyUnits description is TBD

const PropertyUpdated = "updated" // (xsd:dateTime)

PropertyUpdated description is TBD

const PropertyUpstreamDuplicates = "upstreamDuplicates"

PropertyUpstreamDuplicates description is TBD

const PropertyVerb = "verb"

PropertyVerb description is TBD

const PropertyWidth = "width" // (xsd:nonNegativeInteger)

PropertyWidth description is TBD