X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FAPI-Entities.md;h=de3eac9b9af1c5ed3fc3139108247a05d87ad154;hb=3cf9edf7cc9df7ac9af53d5ec49935a9079c2161;hp=b234912acddb25583ab856ef32b04d5da0e0f6bc;hpb=8e2910976f126ee7c728ba4716f317ac496f377b;p=friendica.git
diff --git a/doc/API-Entities.md b/doc/API-Entities.md
index b234912acd..de3eac9b9a 100644
--- a/doc/API-Entities.md
+++ b/doc/API-Entities.md
@@ -361,6 +361,117 @@ Ex: Wed May 23 06:01:13 +0000 2007
+## Event
+
+
+
+
+| Attribute |
+Type |
+Description |
+
+
+
+
+
+id |
+Integer |
+ |
+
+
+
+uid |
+Integer |
+Owner User Id |
+
+
+
+cid |
+Integer |
+Target Contact Id |
+
+
+
+uri |
+String |
+Item unique URI string |
+
+
+
+name |
+String (Plaintext) |
+Title |
+
+
+
+desc |
+String (HTML) |
+Description |
+
+
+
+start_time |
+String (UTC YYYY-MM-DD HH:II:SS)) |
+ |
+
+
+
+end_time |
+String (UTC YYYY-MM-DD HH:II:SS)) |
+Optional (null date is 0001-01-01 00:00:00 |
+
+
+
+type |
+String (event or birthday) |
+ |
+
+
+
+nofinish |
+Boolean |
+Ongoing event |
+
+
+
+place |
+String |
+Optional. Location. |
+
+
+
+ignore |
+Boolean |
+??? |
+
+
+
+allow_cid |
+String (angle-brackets escaped integers) |
+Optional. List of allowed contact ids |
+
+
+
+allow_gid |
+String (angle-brackets escaped integers) |
+Optional. List of allowed circle ids |
+
+
+
+deny_cid |
+String (angle-brackets escaped integers) |
+Optional. List of disallowed contact ids |
+
+
+
+deny_gid |
+String (angle-brackets escaped integers) |
+Optional. List of disallowed circle ids |
+
+
+
+
+
## Hashtag
Unused
@@ -472,7 +583,7 @@ Ex: Wed May 23 06:01:13 +0000 2007
friendica_owner |
-
+
Contact |
No |
@@ -654,7 +765,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
64: Unused
128: Mention
256: Tag added to a post
-512: Poke
+512: Poke (Obsolete)
1024: New post
16384: System email
32768: System event
@@ -797,6 +908,13 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
Resource ID (32 hex chars) |
+
+media-id |
+String (Integer) |
+ID used for attaching images to a Mastodon Post Status |
+
+
+
created |
String (Date) |
@@ -866,7 +984,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
allow_gid |
String (ACL) |
-List of contact group ids wrapped in angle brackets allowed to access the photo. |
+List of contact circle ids wrapped in angle brackets allowed to access the photo. |
@@ -878,7 +996,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
deny_gid |
String (ACL) |
-List of contact group ids wrapped in angle brackets forbidden to access the photo. |
+List of contact circle ids wrapped in angle brackets forbidden to access the photo. |
@@ -890,6 +1008,14 @@ Mutually exclusive with data datasize.
+
+scales |
+Array of Photo Scales |
+
+List of the various resized versions of the Photo
+ |
+
+
datasize |
Integer |
@@ -929,6 +1055,58 @@ Mutually exclusive with link.
+## Photo Scale
+
+
+
+
+| Attribute |
+Type |
+Nullable |
+
+
+
+
+
+id |
+String (Integer) |
+Row ID of this photo scale |
+
+
+
+scale |
+Integer |
+Scale number |
+
+
+
+link |
+String (URL) |
+URL to this scale's image |
+
+
+
+height |
+Integer |
+Image height in pixels |
+
+
+
+width |
+Integer |
+Image width in pixels |
+
+
+
+size |
+Integer |
+Image size in bytes |
+
+
+
+
+
+
## Photo List Item
@@ -992,6 +1170,40 @@ Mutually exclusive with link.
+
+## Photo Album
+
+
+
+
+| Attribute |
+Type |
+Description |
+
+
+
+
+
+name |
+String |
+The name of the photo album |
+
+
+
+created |
+String (Date) |
+The creation date of the album. Format YYYY-MM-DD HH:MM:SS |
+
+
+
+count |
+Integer |
+The number of images in the album |
+
+
+
+
+
## Private message
@@ -1329,4 +1541,4 @@ Unused
## User Mention
-Unused
\ No newline at end of file
+Unused