jeena/tent.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update content/docs/server-protocol.md

Browse source 
following example
This commit is contained in:
Daniel Siders 2012-09-16 16:45:19 -03:00
parent fc31280e2a
commit 01d4d48e8b
1 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

25
content/docs/server-protocol.md
View file

@ -43,8 +43,29 @@ with the Tent entity.
### Follow an entity
A follow request is required in order to receive notifications about posts
published by an entity.
Users follow other users to receive new content. Different users create different kinds of content. Follow requests determine who follows whom and what content is delivered to each user in real time.
Every user can always decide who can see different content. Following is about interest, not permission. Just because someone requests content from a user does not give them access to all of their posts.
There are three ways a follower can specify what information she wants to receive: licenses, post types, and views.
Licenses determine the terms under which content was published. Different users use different licenses for different reasons.
Post types are the kind of content the user created, like statuses, essays, photos, and albums. Anyone can create new post types.
Views specify what kind of content will be sent for each post type. For example, essays can be long so some users might only want to receive an excerpt of each essay before deciding to download the whole thing. Photos and albums can take up lots of space. Requesting an incomplete view of a post type does not mean the user can not download the rest later. A user with permission to see a post can see any of its views. The view types for each post type are defined in that type's description.
By combining these three options, users can request only specific types of content from another user when asking to follow them.
*Example:* A user, https://example.org, wants to follow her friend, https://cloudmir.com. If her request is accepted, https://example.org will receive new updates from https://cloudmir.com as soon as they are created.
First, https://example.org needs to tell her friend what kind of content she wants to receive directly. Since https://cloudmir.com's server will send out new content immediately to everyone following him, https://example.org needs to think carefully about what to request. Her friend posts lots of photos and statuses which would clutter https://example.org's feed.
In this case, she wants all of her friend's essays that are published under the Creative Commons Attribution v3.0 license. She can also choose how much information she wants sent to her about each post. The descriptions of each of these *views* can be found with the post type. For essays, she wants the entire post, so she requests the `full` view.
https://cloudmir.com accepts the following request and provides authenitcation credentials to manage future exchanges. https://cloudmir.com also tells https://example.org that he will not tell the public that she is following him.
https://example.org can always request to see other posts by https://cloudmir.com, but only the post types, licenses, and views in her following record will be automatically sent to her.
### POST /followers