X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FAPI-Entities.md;h=213b2494f1a8b4697241b73afe767662f2cd6cc9;hb=6f23be2a63dfae4118632ab74652c10a379cfc05;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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeTypeDescription
idInteger
uidIntegerOwner User Id
cidIntegerTarget Contact Id
uriStringItem unique URI string
nameString (Plaintext)Title
descString (HTML)Description
start_timeString (UTC YYYY-MM-DD HH:II:SS))
end_timeString (UTC YYYY-MM-DD HH:II:SS))Optional (null date is 0001-01-01 00:00:00
typeString (event or birthday)
nofinishBooleanOngoing event
placeStringOptional. Location.
ignoreBoolean???
allow_cidString (angle-brackets escaped integers)Optional. List of allowed contact ids
allow_gidString (angle-brackets escaped integers)Optional. List of allowed group ids
deny_cidString (angle-brackets escaped integers)Optional. List of disallowed contact ids
deny_gidString (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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeTypeNullable
    idString (Integer)Row ID of this photo scale
    scaleIntegerScale number
    linkString (URL)URL to this scale's image
    heightIntegerImage height in pixels
    widthIntegerImage width in pixels
    sizeIntegerImage size in bytes
    + + ## Photo List Item @@ -992,6 +1170,40 @@ Mutually exclusive with link.
    + +## Photo Album + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeTypeDescription
    nameStringThe name of the photo album
    createdString (Date)The creation date of the album. Format YYYY-MM-DD HH:MM:SS
    countIntegerThe number of images in the album
    + ## Private message @@ -1181,54 +1393,6 @@ Mutually exclusive with link. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1241,90 +1405,12 @@ Mutually exclusive with link. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    hometownString
    genderString
    maritalString
    marital_withString
    marital_sinceString (Date)
    sexualString
    politicString
    religionString
    public_keywords StringComma-separated list of words meant to be used for search only.
    likesString (Plaintext)
    dislikesString (Plaintext)
    aboutString (Plaintext)
    musicString (Plaintext)
    bookString (Plaintext)
    tvString (Plaintext)
    filmString (Plaintext)
    interestString (Plaintext)
    romanceString (Plaintext)
    workString (Plaintext)
    educationString (Plaintext)
    social_networksString (Plaintext)
    homepage String (URL)
    usersList of ContactsIf populated, only these contacts have access to the profile.