• If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

View
 

Link types

Page history last edited by James 11 years, 11 months ago

The Links for Activity Streams draft describes how to include RFC 5988 links into Activity Streams objects. This document lists the relationship types described in RFC 5988 and in the IANA Link Relation Type Registry and gives some guidance on how to apply them to Activity Streams. The table columns are:

 

  • Relationship: name of the relationship, from the RFC.
  • Applicability: high, medium, low, or none. How applicable this relationship type is to Activity Streams. none means that there already exist properties for this link relationship.
  • Serialization: what kind of things would you include this type of link relationship in? object, collection, activity, other?
  • Notes: any notes or references to other documents
 
Relationship  Applicability  Serialization  Notes 
alternate
high object, collection, activity

Useful for pointing between Atom and JSON versions of a serialization, or for pointing to a non-ActivityStreams serialization. For HTML, applicability is none since we already have the url property.

 

jasnell: not certain I would call this "high" applicability. I've yet to see a solid general use case for this in Activity Streams

appendix
low
   
archives
low    
author
none   Use the "author" property instead
bookmark
low
   
canonical
medium   Useful for pointing to a full version of an object...? Partial collection versus full collection...?
chapter
low
   
collection
medium activity, object Might be useful for pointing to a canonical "source" collection for activities or objects; for example, on a note object with Alice as an author, could point to a collection of all Alice's notes. See RFC 6573. Also, "up".
contents
low
   
copyright
medium
object, collection, activity
For copyright information or statements. See also "license"
current
low
  jasnell: I wouldn't mark this "low"... current provides a link to the resource with the most recently updated items, which could be quite useful when dealing with paged activity streams. applicability is potentially quite high. 
describedby
low
  jasnell: possible linked data tie in 
disclosure
low    
duplicate
low    
edit
medium
object, collection, activity
Could be useful for AtomPub-like API interface. See ActivityPub
edit-media
medium
object
Could be useful for AtomPub-like API interface. See ActivityPub
enclosure
none
 

Use Media Link serialization instead

first
high
collection
For partial collections, points to the first partial collection or "page"
glossary
low
   
help
low
   
hub
high
collection
Could be the best way to declare a PubSubHubbub hub, if you can't produce a Link: header.
icon
none   For activities, use the "icon" property instead. For objects, use the "image" object instead.
index
low
   
item
none   For a collection, include any related object in the "items" property.
last
high
collection
For partial collections, points to the last partial collection or "page"
latest-version
low
   
license
medium
object, collection, activity
Using Creative Commons license URLs here can be very useful. See also "copyright".
lrdd
low   Not clear why you'd use this instead of including links directly.
monitor
low   From RFC 5989jasnell: there are potentially interesting uses for this. I wouldn't rule it out
monitor-group
low   From RFC 5989.
next
high
collection
For partial collections, points to the next partial collection or "page"
next-archive
low
   
nofollow
low   ?
noreferrer
low   ?
payment
low
   
predecessor-version
low
   
prefetch
low   ?
prev
high collection For partial collections, points to the previous partial collection or "page"
previous
low
collection
Use "prev" instead. jasnell: why prefer "prev" over "previous"... personally I'd prefer "previous" over "prev" 
prev-archive
low
   
related
medium
object, collection, activity
A loose relationship; "see also".
replies
none
  Use Responses for Activity Streams instead
search
medium collection Could be useful for searching a large collection, but not yet defined. OpenSearch, perhaps?
section
low
   
self
high
object, collection, activity
Useful to point to the original JSON representation of the object or collection.
service
low
collection
Could be useful for AtomPub-like API interface. See ActivityPub
start
none
  Use "first" instead
stylesheet
none
  Just no reason to use this.
subsection
low
   
successor-version
low
   
tag
none   Use the "tags" collection for objects instead.
up
low
activity, object
Possibly point from an activity to its "source" collection?
version-history
low
   
via
medium
  ?
working-copy
low
   
working-copy-of
low
   
about   

From "Additional Link Relation Types"  (http://tools.ietf.org/html/draft-snell-additional-link-relations-04) ... useful in Linked Data style scenarios to reference the subject of the object

preview low   From "Additional Link Relation Types" (http://tools.ietf.org/html/draft-snell-additional-link-relations-04) ... for objects, use "image" instead
privacy-policy low   From "Additional Link Relation Types" (http://tools.ietf.org/html/draft-snell-additional-link-relations-04) ... useful for linking to privacy policy associated with a particular item. General applicability to Activity Streams is likely low.
terms-of-service ?   From "Additional Link Relation Types" (http://tools.ietf.org/html/draft-snell-additional-link-relations-04) ... useful for linking to terms of service statement associated with a particular item.
type ?   From "Additional Link Relation Types" (http://tools.ietf.org/html/draft-snell-additional-link-relations-04) ... useful in Linked Data style scenarios ... should not be viewed as a replacement for objectType but can help augment it in useful ways. (e.g. objectType can be "person" while type can link to "http://schema.org/Person"
profile ?   From "The 'profile' Link Relation Type" (http://tools.ietf.org/html/draft-wilde-profile-link-01) ... useful to indicate a specific "profile" or "vocabulary" a given object conforms to. Semantics of this are still very much up in the air. It's general applicability to activity streams is not yet known.

 

 

 

Comments (0)

You don't have permission to comment on this page.