Base

Start all your queries with: "@context": "https://www.w3.org/ns/activitystreams",

Type

An Activity streams message supports multiple types. In Broid context the list of types are:

  • Create: New message is sent
  • Update: Message already sent is updated
  • Delete: Message already sent is deleted

Generator

This object represents the channel where the message comes from. The object contains 3 fields:

Description
id int64 or string the unique identifier of the channel, generated by Broid (useful when you plug multiple accounts to one channel)
name string the name of the channel list here
type string should always be equal to Service

Target / To

Describes the indirect target of the message.

Description
id int64 or string the identifier provided by the channel for the user or room
name string the full name/username of the user on the channel
type string the type of the user, the value can be Person, Group or Application

If you want to send your message in a thread, use the object Context in Object.

Actor

This object represents the entities capable of carrying out the message.

Description
id int64 or string the identifier provided by the channel for the user
name string the full name/username of the user on the channel
type string the type of the user, the value can be Person or Application

Object

Describes a message of any kind. The Object type serves as the base type for most of the other kinds of messages defined in the Activity Streams Vocabulary. In Broid context the object should only be one of these types: Note, Image, Video, Place, Document and , Collection (carousel).

Base of object should always contains theses fields:

Description
id int64 or string the identifier of the object (generated by Broid or provide by the channel)
type string the type of the object (Note, Image, Video, Audio, Place, and Document)
content string (optional) the content of the message encoded as a JSON string.
name string (optional) name for the image, video, place, or document.
url string (optional) link for the image, video, or document.
mediaType string (optional) identifies the MIME media type of the image, video, or document.
latitude float (optional) used for the object type place.
longitude float (optional) used for the object type place.
item object (optional) used for the object type collection, allows carousel.
tag object (optional) one or more "tags" can be associated with a message.
context object (optional) usefull to representing message leaving in the thread (Slack thread, Flowdock thread etc..).
attachment object (optional) this can be button, quick reply or media object.