X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2FAPI-Entities.md;h=213b2494f1a8b4697241b73afe767662f2cd6cc9;hb=9581b05603e6ee4e250738c159ed2e67b3fb2eeb;hp=da59de77b06980dff5e93e90c74cbb649372ec8b;hpb=e1ba53fec3391e40565e0c7c88a23cb6dae3dc4e;p=friendica.git
diff --git a/doc/API-Entities.md b/doc/API-Entities.md
index da59de77b0..213b2494f1 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 group 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 group ids |
+
+
+
+
+
## Hashtag
Unused
@@ -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) |
@@ -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
@@ -1181,54 +1393,6 @@ Mutually exclusive with link
.
|
-
-hometown |
-String |
- |
-
-
-
-gender |
-String |
- |
-
-
-
-marital |
-String |
- |
-
-
-
-marital_with |
-String |
- |
-
-
-
-marital_since |
-String (Date) |
- |
-
-
-
-sexual |
-String |
- |
-
-
-
-politic |
-String |
- |
-
-
-
-religion |
-String |
- |
-
-
public_keywords |
String |
@@ -1241,90 +1405,12 @@ Mutually exclusive with link
.
Comma-separated list of words meant to be used for search only. |
-
-likes |
-String (Plaintext) |
- |
-
-
-
-dislikes |
-String (Plaintext) |
- |
-
-
-
-about |
-String (Plaintext) |
- |
-
-
-
-music |
-String (Plaintext) |
- |
-
-
-
-book |
-String (Plaintext) |
- |
-
-
-
-tv |
-String (Plaintext) |
- |
-
-
-
-film |
-String (Plaintext) |
- |
-
-
-
-interest |
-String (Plaintext) |
- |
-
-
-
-romance |
-String (Plaintext) |
- |
-
-
-
-work |
-String (Plaintext) |
- |
-
-
-
-education |
-String (Plaintext) |
- |
-
-
-
-social_networks |
-String (Plaintext) |
- |
-
-
homepage |
String (URL) |
|
-
-users |
-List of Contacts |
-If populated, only these contacts have access to the profile. |
-
-