messageBus
Documentation for message-bus JSON objects
License: MIT
- messageBus
- ~message :
object
- ~postMessage :
object
- ~topicMessage :
object
- ~topicTrackingState :
object
- ~notificationsMessage :
object
- ~message :
messageBus~message : object
Message-bus message
Kind: inner typedef of messageBus
Param | Type | Description |
---|---|---|
global_id | number |
Global Message Id |
message_id | number |
Message id. This is clearly different than global_id, but why? is there significance? |
channel | string |
Channel message relates to |
data | object |
Message data |
messageBus~postMessage : object
Message relating to a post
Kind: inner typedef of messageBus
Param | Type | Description |
---|---|---|
(number) | id Post id of post message relates to | |
post_number | number |
Sequence in the topic of the post |
updated_at | string |
ISO formatted date time of the post action |
type | string |
Message Type |
messageBus~topicMessage : object
Message relating to a topic
Kind: inner typedef of messageBus
Param | Type | Description |
---|---|---|
topic_id | number |
Id of topic |
message_type | string |
Message Type |
payload | topicTrackingState |
Topic Information |
messageBus~topicTrackingState : object
Topic Tracking State
Kind: inner typedef of messageBus
Param | Type | Description |
---|---|---|
topic_id | number |
Topic Id |
highest_post_number | number |
Highest Post Number that's been read in topic |
last_read_post_number | number |
Last read Post Number in topic |
created_at | string |
ISO formatted datetime of topic creation |
category_id | number |
Category ID of the topic |
notification_level | external.topics.NotificationLevel |
Notification level of the topic |
messageBus~notificationsMessage : object
Message relating to notifications
Kind: inner typedef of messageBus
Param | Type | Description |
---|---|---|
unread_notifications | number |
Number of unread notifications |
unread_private_messages | number |
Number of unread Message notifcations |