Files: 18ca2b47b86cd361c03c92c0682500c5fa00451f / tmpl / docs / message-types / about.md
About
About-messages set attributes about someone or something. They can be used to set a name, picture, description, or other property for users, files, or messages.
An About message may set one property or multiple.
If the message sets only one property, then a reply or vote
on the message can be more specific.
If there are multiple properties to assign, combining them into one About message can reduce data overhead.
{ type: 'about', about: Link, name: String, image: BlobLink, description: String }
Names
There's no global registry of names. Each user can choose a name for themselves and for others, and conflicts are allowed.
Its up to your application to decide which names to use. Generally speaking, names by followed users are trusted, and the local user gets to override all decisions. Self-given names may also be prioritized.
An application may apply a rule for names, such as to allow A-z0-9._-
, and not allow a trailing .
.
Images
For images, a common size is 512x512. Square images are recommended but not required.
Some recommended attributes on the image
link:
width
in pixelsheight
in pixelsname
a string filenamesize
in bytestype
a mimetype
The image field may also be a plain blob id instead of a link object, but it is better to include the full object so that clients can make use of the metadata.
Description
A description may be a markdown string describing the referenced entity. A client may show description data for a user on their profile page.
Built with git-ssb-web