get_alert
Function
| Function Name | Description | Level |
| get_alert | Return alerts of Current user. Like someone quoted or liked your post, or replied to your subscribed topic, or created new topic in you subscribed forum, etc.
Flag 'get_alert' will be returned in get_config to indicate if the plugin support this function. | |
Input Parameters:
| Name | Type | Required? | Description | Level |
| page | Int | | default to be 1 | |
| perpage | Int | | default to be 20 | |
Output Parameters:
| Name | Type | Required? | Description | Level |
| total | Int | yes | Total alerts number | |
| items | Array of Hash table | yes | | |
| user_id | String | yes | Id of user who triggered this alert | |
| username | byte[] | yes | Name of user who triggered this alert | |
| icon_url | String | yes | Avatar url of user who triggered this alert | |
| message | byte[] | yes | alert message, like ('test' replied to thread 'test thread') | |
| timestamp | String | yes | timestamp of alert trigger time | |
| content_type | String | yes | Alert type, like post or user or pm | |
| content_id | String | yes | Id of the alert content (It will always be post id if the target is thread) | |
| topic_id | String | | Topic id if the target is a thread. | |
| position | Int | | For conversation only, indicate the position of the new message in conversation | |
| unread | Boolean | | Indicate if the content is unread | |