Integrate the SuprSend React Headless Inbox, providing control over inbox UI and features like notifications and event handling.
Props | Type | Description |
---|---|---|
workspaceKey | string (Mandatory) | You can find it in SuprSend Dashboard inside _Settings -> API Keys_. |
distinctId | string (Mandatory) | Unique identifier for the user. |
subscriberId | string (Mandatory) | This is unique string for every distinctId used for authentication to inbox service. You check generation docs |
tenantId | string (Optional) | If you use multi-tenant architecture you can get inbox notifications for that specific tenant/brand only. |
pageSize | number (Optional) | Notifications to get in one API call. Used for pagination to get older notifications. Maximum allowed is 50. Defaults to 20. |
stores | Store (optional) | Pass stores array if you want to use multi tab feature |
Returns | Type | Description |
---|---|---|
unSeenCount | number | Use this variable to show the unseen notification count anywhere in your application. |
markAllSeen | method | Used to mark seen for all notifications. Call this method on clicking the bell icon so that it will reset the unSeenCount to 0. |
Parameter | Type | Description |
---|---|---|
storeId | string (Optional) | Optional parameter which return data of that specific store if you are using multi-tab feature. You can ignore this if you are not using multi-tab feature. |
Returns | Type | Description |
---|---|---|
notifications | IRemoteNotification\[] | Contains information related to notifications. This array can be looped to display notifications. |
markClicked | (id: string) => void | used to mark notification as clicked. |
markRead | (id: string) => void | used to mark notification as read. |
markUnRead | (id: string) => void | used to mark notification as unread. |
markArchived | (id: string) => void | used to mark notification as archived |
markAllRead | ( ) => void | Method used to mark all notifications as read. |
initialLoading | boolean | used for showing initial loader while fetching notifications first time |
hasNext | boolean | check if older notifications are present and then call _fetchPrevious_ method if its true to get older notifications. |
fetchPrevious | ( ) => void | used to get older notifications if you implement pagination, by checking _hasNext_ flag |
fetchMoreLoading | boolean | used to show loader while getting fetch older notifications. |