You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/basics/pagination.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: "Data Formats"
2
+
title: "Pagination"
3
3
---
4
4
5
5
# Pagination
@@ -104,4 +104,4 @@ Responses from paginated streams will include the following fields in the `meta`
104
104
<td>If <code>more</code> is <code>true</code>, there are more matches available for the given query than would fit within <code>count</code> objects. If <code>more</code> is <code>false</code>, there are no more matches available.</td>
Copy file name to clipboardExpand all lines: content/docs/meta/annotations.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ title: "Annotations"
7
7
* TOC
8
8
{:toc}
9
9
10
-
Annotations are metadata that can be attached to Users, Posts, Channels, or Messages. This allows developers and users to add extra information to App.net objects outside of the fields App.net has already defined.
10
+
Annotations are metadata that can be attached to Users, Posts, Channels, Messages, or Files. This allows developers and users to add extra information to App.net objects outside of the fields App.net has already defined.
11
11
12
12
## What's so great about annotations?
13
13
@@ -52,7 +52,7 @@ In general, annotations are a list of objects that have a ```type``` and a ```va
52
52
53
53
### Annotations in App.net objects
54
54
55
-
All objects that support annotations (User, Post, Channel, Message) have an `annotations` field which will contain a list of individual annotation objects if they are present.
55
+
All objects that support annotations (User, Post, Channel, Message, File) have an `annotations` field which will contain a list of individual annotation objects if they are present.
56
56
57
57
#### Example: annotations field in a Post
58
58
@@ -91,7 +91,7 @@ All objects that support annotations (User, Post, Channel, Message) have an `ann
91
91
92
92
### Limits
93
93
94
-
- Each object (User, Post, Channel, Message) is allowed at most 8192 bytes worth of annotations (in total, when serialized as JSON).
94
+
- Each object (User, Post, Channel, Message, File) is allowed at most 8192 bytes worth of annotations (in total, when serialized as JSON).
95
95
- Post and Message annotations are immutable and can only be added at creation time.
96
96
- A Post or Message can have multiple annotations of the same "type".
97
97
- User and Channel annotations are mutable and can be updated at any time.
@@ -100,13 +100,13 @@ All objects that support annotations (User, Post, Channel, Message) have an `ann
100
100
101
101
### Creating, Updating and Deleting
102
102
103
-
For Posts, Messages, and Channels, you can create annotations when you create the object. You must pass JSON objects that include annotations matching the above schema. Please see the documentation for [creating Posts](/docs/resources/post/lifecycle/#create-a-post), [Messages](/docs/resources/message/lifecycle/#create-a-message), and [Channels](/docs/resources/channel/lifecycle/#create-a-channel).
103
+
For Posts, Messages, Channels, and Files, you can create annotations when you create the object. You must pass JSON objects that include annotations matching the above schema. Please see the documentation for [creating Posts](/docs/resources/post/lifecycle/#create-a-post), [Messages](/docs/resources/message/lifecycle/#create-a-message), [Channels](/docs/resources/channel/lifecycle/#create-a-channel), or [Files](/docs/resources/file/lifecycle/#create-a-file).
104
104
105
-
To add or update User or Channel annotations, you [update a User's profile](/docs/resources/user/profile/#update-a-user) or [update a Channel](/docs/resources/channel/lifecycle/#update-a-channel) and pass in the annotations you want to add or update. To delete an annotation, omit the `value` key for the annotation type you want to delete. For example, to delete a user's blog url, specify `{"type": "net.app.core.directory.blog"}`.
105
+
To add or update User or Channel annotations, you [update a User's profile](/docs/resources/user/profile/#update-a-user), [update a Channel](/docs/resources/channel/lifecycle/#update-a-channel), or [update a File](/docs/resources/file/lifecycle/#update-a-file) and pass in the annotations you want to add or update. To delete an annotation, omit the `value` key for the annotation type you want to delete. For example, to delete a user's blog url, specify `{"type": "net.app.core.directory.blog"}`.
106
106
107
107
### Retrieving
108
108
109
-
Since annotations can be up to 8192 bytes, they are never included by default. When making a request for Users, Posts, Channelsor Messages, you can use the parameter `include_annotations=1` to receive all applicable annotations. When requesting Users or Posts you can use `include_user_annotations=1` or `include_post_annotations=1` to include just those annotations. When requesting Channels or Messages you can use `include_channel_annotations=1` or `include_message_annotations=1` to include just those annotations.
109
+
Since annotations can be up to 8192 bytes, they are never included by default. When making a request for Users, Posts, Channels, Messages, or Files, you can use the parameter `include_annotations=1` to receive all applicable annotations. When requesting Users or Posts you can use `include_user_annotations=1` or `include_post_annotations=1` to include just those annotations. When requesting Channels or Messages you can use `include_channel_annotations=1` or `include_message_annotations=1` to include just those annotations. When requesting Files you can use `include_file_annotations=1` or `include_user_annotations=1` to include just those annotations.
Copy file name to clipboardExpand all lines: content/docs/resources/file/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,17 +42,17 @@ A file uploaded by a User and hosted by App.net.
42
42
<tr>
43
43
<td><code>derived_files</code></td>
44
44
<td>object</td>
45
-
<td>An object containing any other Files that were created using this File as input. Please see the section on <a href="#derived_files">derived Files</a> for more information.</td>
45
+
<td>An object containing any other Files that were created using this File as input. Please see the section on <a href="#derived-files">Derived Files</a> for more information.</td>
46
46
</tr>
47
47
<tr>
48
48
<td><code>file_token</code></td>
49
49
<td>string</td>
50
-
<td>[Optional] A token that can be used to modify a File. Only present upon creation time, if a write file token was specified when fetching this file or if you have the files scope. Please see the section on <a href="#file_authorization">File authorization</a> for more information.</td>
50
+
<td>[Optional] A token that can be used to modify a File. Only present upon creation time, if a write file token was specified when fetching this file or if you have the files scope. Please see the section on <a href="#file-authorization">File Authorization</a> for more information.</td>
51
51
</tr>
52
52
<tr>
53
53
<td><code>file_token_read</code></td>
54
54
<td>string</td>
55
-
<td>[Optional] A token that can be used to access a File. Only present when <code>public</code> is <code>true</code> or if a read token was specified when fetching this File. Please see the section on <a href="#file_authorization">File authorization</a> for more information.</td>
55
+
<td>[Optional] A token that can be used to access a File. Only present when <code>public</code> is <code>true</code> or if a read token was specified when fetching this File. Please see the section on <a href="#file-authorization">File Authorization</a> for more information.</td>
0 commit comments