user.notifications

Available methods

Description

Provides methods to manage user notifications.

Namespace:

user.notifications

Method: deleteNotifications

HTTP POST

Description:

Deletes multiple notifications

Parameters:

  • string sessionKey

  • int array notifications - The list of notification IDs to delete.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getNotifications

HTTP GET

Description:

Get all notifications from a user.

Parameters:

  • string sessionKey

  • boolean unread - If true, return only unread notifications.

Returns:

  • array :

  • struct notification

    • long "id"

    • read array "boolean" - $desc

    • message array "string" - $desc

    • summary array "string" - $desc

    • details array "string" - $desc

    • type array "notificationType" - $desc

    • created array "date" - $desc

Method: setAllNotificationsRead

HTTP POST

Description:

Set all notifications from a user as read

Parameters:

  • string sessionKey

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setNotificationsRead

HTTP POST

Description:

Set notifications of the given user as read

Parameters:

  • string sessionKey

  • int array notifications - The list of notification IDs to set as 'read'.

Returns:

  • int - 1 on success, exception thrown otherwise.