Working on implementing this in together now, I'm sure there is a valid reason, but I'm just wondering why the _id
is different from the paging before and after values, could they not be the same?
Working on implementing this in together now, I'm sure there is a valid reason, but I'm just wondering why the _id
is different from the paging before and after values, could they not be the same?
The before
and after
values are meant to represent pages of data, not necessarily individual records. In my case, the after
value refers to an item that isn't in the current page. I could return a string for _id
that looks more like the before
and after
strings, but that's just an implementation detail of my server. Alternately I may switch my before
/after
strings to look more like the current _id
value. Either way, this difference doesn't seem important to the client.
Not that it has to be implemented right now, but I do want to make a case for the “updated” field of a channel. In order to reduce “high noise signal”, for most of my channels, I’ll want the channel’s “unread indicator” to disappear when I reach the top of the timeline (even if things are unread). When a channel is updated (receives new posts), I would want to be able to re-enable the unread indicator. Essentially saying “there are new posts here” rather than saying “there are unread posts here”. In fact now that I say it, I might make the indicator a different color as well. That said, the purpose of such a channel is, I want to be able to know what I have and haven’t read, while only being prompted to open the channel if there are new posts. The “new posts” indicator essentially upping the priority of time looking at that channel than one without new posts. That said, when I have more time, to be able to go back to an existing channel and still know what I haven’t read (which is why this can’t just use the “last_read_entry”, even though that is a useful method).
(Originally published at: https://eddiehinkle.com/2018/02/12/7/reply/)
Not that it has to be implemented right now, but I do want to make a case for the “updated” field of a channel. In order to reduce “high noise signal”, for most of my channels, I’ll want the channel’s “unread indicator” to disappear when I reach the top of the timeline (even if things are unread). When a channel is updated (receives new posts), I would want to be able to re-enable the unread indicator. Essentially saying “there are new posts here” rather than saying “there are unread posts here”. In fact now that I say it, I might make the indicator a different color as well. That said, the purpose of such a channel is, I want to be able to know what I have and haven’t read, while only being prompted to open the channel if there are new posts. The “new posts” indicator essentially upping the priority of time looking at that channel than one without new posts. That said, when I have more time, to be able to go back to an existing channel and still know what I haven’t read (which is why this can’t just use the “last_read_entry”, even though that is a useful method).
(Originally published at: https://eddiehinkle.com/2018/02/12/7/reply/)
With the work in tracking read state, I've started implementing these additional properties by prefixing them with _
. I felt like that was the least obtrusive way to include them while also making it obvious they are not part of the post vocabulary.
Additional brainstorming around other per-item data should be discussed in new issues.
The unread
property has been documented in the spec, and implemented in Aperture.
I am not sure the updated
property is useful, so I'm leaving it out for now. I'm going to close this issue as most of the discussion is taking place in #4.
I'm implementing a draft of this in Aperture right now. Here is the current API.
Every entry now includes a unique system ID, meant for internal identification of the item (not global identification). This is returned in the timeline response as the parameter _id
, and there is now also _is_read
. For example:
{
"items": [
{
"type": "entry",
"url": "http://example.com/100",
...
"_id": "41003",
"_is_read": false
]
}
These new _id
values are meant to be opaque to clients, and must always be a string. Some servers will likely use integer database IDs, but other servers may use other string identifiers for entries depending on the implementation.
Retrieving the list of channels now also includes the number of unread entries in the channel:
{
"channels": [
{
"uid": "notifications",
"name": "Notifications",
"unread": 0
},
{
"uid": "YPGiUrZjNM36LNdpFy7eSzJE7o2aK82z",
"name": "IndieWeb",
"unread": 7
}
]
}
To mark an individual entry as read:
action=timeline
channel=example
method=mark_read
entry=1234
To mark multiple entires as read:
action=timeline
channel=example
method=mark_read
entry[]=1234
entry[]=5678
Both of the above also work with method=mark_unread
.
To mark an entry read as well as everything before it:
action=timeline
channel=example
method=mark_read
last_read_entry=1234
This is to address the use case of streams, where you really only care about knowing where in the stream you've scrolled to and whether there are any new entries since then.
This is mostly inspired by the Feedly Markers API Mark one or more articles as read and Mark a feed as read
Here is a diff of the changes.
The main differences can be read here:
Some silo examples of "home" vs "notifications":
and of course more on the wiki
Some discussion from IRC about whether hardcoding a "home" channel even makes sense in the first place.
@aaronpk I’m having trouble with OwnYourGram — it posted a few photos on 1/29 but nothing since then. When I hit Post manually, I get “There was an error posting the photo!”. I authenticate as avi.micro.blog — any chance you could take a quick look? Thanks!
@aaronpk I’m having trouble with OwnYourGram — it posted a few photos on 1/29 but nothing since then. When I hit Post manually, I get “There was an error posting the photo!”. I authenticate as avi.micro.blog — any chance you could take a quick look? Thanks!