notifications

Documentation for notification JSON objects

License: MIT

notifications.notificationTypes : enum

Notification Type Enum

Kind: static enum property of notifications
Read only: true
Properties

Name Type Default Description
mentioned string 1 Notification was generated by an @mention of username
replied string 2 Notification was generated by a direct reply to post
quoted string 3 Notification was generated by quoting current users post
edited string 4 Notification was generated by another user editing current users post
liked string 5 Notification was generated by another user liking a post by the current user
private_message string 6 Notification was generated by another user posting in a Private Message
invited_to_private_message string 7 Notification was generated by another user inviting current user to a Private Message
invitee_accepted string 8 Notification was generated by another user accepting current users invite (to what?)
posted string 9 Notification was generated by another user replying in a watched topic
moved_post string 10 Notification was generated by another user moving a post owned by the current user
linked string 11 Notification was generated by another user linking to a post by current user
granted_badge string 12 Notification was generated by the current user being awarded a badge
invited_to_topic string 13 Notification was generated by a user inviting current user to topic
custom string 14 Notification was generated by a custom plugin?

notifications~notifiactions : object

Notifications contatiner

Kind: inner typedef of notifications

Param Type Description
notifications Array.<notification> Array of notifcations for the current user
total_rows_notifications number Total notifications for the current user
load_more_notifications string Relative URL to load next "page" of notifications

notifications~notification : object

Notification Object

Kind: inner typedef of notifications

Param Type Description
id number Notification Id
notification_type number ID of the notification type
read boolean Notification read marker
created_at string ISO formatted date time of post creation
post_number number Topic specific post number for relevant post
topic_id number Id of the topic for relevant post
slug string URL slug of the topic for relevant post
data topicNotificationData | badgeNotificationData Notification payload

notifications~topicNotificationData : object

Topic relating notification payload

Kind: inner typedef of notifications

Param Type Description
topic_title string Title of the referenced topic
original_post_id number Post Id of referenced post
original_username string Username of the original poster
display_username string Username to display for notification

notifications~badgeNotificationData : object

Badge relating notification payload

Kind: inner typedef of notifications

Param Type Description
badge_id number Id of the awarded badge
badge_name string Display name of the awarded badge