spelling: messages

[friendica.git] / doc / API-Entities.md

diff --git a/doc/API-Entities.md b/doc/API-Entities.md
index da59de77b06980dff5e93e90c74cbb649372ec8b..213b2494f1a8b4697241b73afe767662f2cd6cc9 100644 (file)
--- a/doc/API-Entities.md
+++ b/doc/API-Entities.md
@@ -361,6 +361,117 @@ Ex: Wed May 23 06:01:13 +0000 2007
 </tbody>
 </table>
 
+## Event
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>uid</code></td>
+<td>Integer</td>
+<td>Owner User Id</td>
+</tr>
+
+<tr>
+<td><code>cid</code></td>
+<td>Integer</td>
+<td>Target Contact Id</td>
+</tr>
+
+<tr>
+<td><code>uri</code></td>
+<td>String</td>
+<td>Item unique URI string</td>
+</tr>
+
+<tr>
+<td><code>name</code></td>
+<td>String (Plaintext)</td>
+<td>Title</td>
+</tr>
+
+<tr>
+<td><code>desc</code></td>
+<td>String (HTML)</td>
+<td>Description</td>
+</tr>
+
+<tr>
+<td><code>start_time</code></td>
+<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>end_time</code></td>
+<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
+<td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
+</tr>
+
+<tr>
+<td><code>type</code></td>
+<td>String (<code>event</code> or <code>birthday</code>)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>nofinish</code></td>
+<td>Boolean</td>
+<td>Ongoing event</td>
+</tr>
+
+<tr>
+<td><code>place</code></td>
+<td>String</td>
+<td>Optional. Location.</td>
+</tr>
+
+<tr>
+<td><code>ignore</code></td>
+<td>Boolean</td>
+<td>???</td>
+</tr>
+
+<tr>
+<td><code>allow_cid</code></td>
+<td>String (angle-brackets escaped integers)</td>
+<td>Optional. List of allowed contact ids</td>
+</tr>
+
+<tr>
+<td><code>allow_gid</code></td>
+<td>String (angle-brackets escaped integers)</td>
+<td>Optional. List of allowed group ids</td>
+</tr>
+
+<tr>
+<td><code>deny_cid</code></td>
+<td>String (angle-brackets escaped integers)</td>
+<td>Optional. List of disallowed contact ids</td>
+</tr>
+
+<tr>
+<td><code>deny_gid</code></td>
+<td>String (angle-brackets escaped integers)</td>
+<td>Optional. List of disallowed group ids</td>
+</tr>
+
+</tbody>
+</table>
+
 ## Hashtag
 
 Unused
@@ -654,7 +765,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <li>64: Unused</li>
 <li>128: Mention</li>
 <li>256: Tag added to a post</li>
-<li>512: Poke</li>
+<li>512: Poke (Obsolete)</li>
 <li>1024: New post</li>
 <li>16384: System email</li>
 <li>32768: System event</li>
@@ -797,6 +908,13 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <td>Resource ID (32 hex chars)</td>
 </tr>
 
+<tr>
+<td><code>media-id</code></td>
+<td>String (Integer) </td>
+<td>ID used for attaching images to a Mastodon Post Status</td>
+</tr>
+
+
 <tr>
 <td><code>created</code></td>
 <td>String (Date)</td>
@@ -890,6 +1008,14 @@ Mutually exclusive with <code>data</code> <code>datasize</code>.
 </td>
 </tr>
 
+<tr>
+<td><code>scales</code></td>
+<td>Array of Photo Scales</td>
+<td>
+List of the various resized versions of the Photo
+</td>
+</tr>
+
 <tr>
 <td><code>datasize</code></td>
 <td>Integer</td>
@@ -929,6 +1055,58 @@ Mutually exclusive with <code>link</code>.
 </tbody>
 </table>
 
+## Photo Scale
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>String (Integer)</td>
+<td>Row ID of this photo scale</td>
+</tr>
+
+<tr>
+<td><code>scale</code></td>
+<td>Integer</td>
+<td>Scale number</td>
+</tr>
+
+<tr>
+<td><code>link</code></td>
+<td>String (URL)</td>
+<td>URL to this scale's image</td>
+</tr>
+
+<tr>
+<td><code>height</code></td>
+<td>Integer</td>
+<td>Image height in pixels</td>
+</tr>
+
+<tr>
+<td><code>width</code></td>
+<td>Integer</td>
+<td>Image width in pixels</td>
+</tr>
+
+<tr>
+<td><code>size</code></td>
+<td>Integer</td>
+<td>Image size in bytes</td>
+</tr>
+
+</tbody>
+</table>
+
+
 ## Photo List Item
 
 <table class="table table-condensed table-striped table-bordered">
@@ -992,6 +1170,40 @@ Mutually exclusive with <code>link</code>.
 </tbody>
 </table>
 
+
+## Photo Album
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>name</code></td>
+<td>String</td>
+<td>The name of the photo album</td>
+</tr>
+
+<tr>
+<td><code>created</code></td>
+<td>String (Date)</td>
+<td>The creation date of the album. Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>count</code></td>
+<td>Integer</td>
+<td>The number of images in the album</td>
+</tr>
+
+</tbody>
+</table>
+
 ## Private message
 
 <table class="table table-condensed table-striped table-bordered">
@@ -1181,54 +1393,6 @@ Mutually exclusive with <code>link</code>.
 <td></td>
 </tr>
 
-<tr>
-<td><code>hometown</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>gender</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>marital</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>marital_with</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>marital_since</code></td>
-<td>String (Date)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>sexual</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>politic</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>religion</code></td>
-<td>String</td>
-<td></td>
-</tr>
-
 <tr>
 <td><code>public_keywords</code></td>
 <td>String</td>
@@ -1241,90 +1405,12 @@ Mutually exclusive with <code>link</code>.
 <td>Comma-separated list of words meant to be used for search only.</td>
 </tr>
 
-<tr>
-<td><code>likes</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>dislikes</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>about</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>music</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>book</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>tv</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>film</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>interest</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>romance</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>work</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>education</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
-<tr>
-<td><code>social_networks</code></td>
-<td>String (Plaintext)</td>
-<td></td>
-</tr>
-
 <tr>
 <td><code>homepage</code></td>
 <td>String (URL)</td>
 <td></td>
 </tr>
 
-<tr>
-<td><code>users</code></td>
-<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
-<td>If populated, only these contacts have access to the profile.</td>
-</tr>
-
 </tbody>
 </table>