Class: NotificationApiClient
services/notification.NotificationApiClient
Contains all the endpoints needed to manage notifications.
Constructors
constructor
• new NotificationApiClient(): NotificationApiClient
Returns
Methods
createCustomNotification
▸ createCustomNotification(data, config?): Promise<any>
This endpoint generates a custom notification starting from the user. The recipients of the notification can be the user's friends/followers or the user himself (based on recipients_type value). Es. connections -> "user" added an item to the wishlist.
Parameters
| Name | Type |
|---|---|
data | CustomNotificationParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:58
disposeBroadcastMessages
▸ disposeBroadcastMessages(banner_ids, config?): Promise<any>
This endpoint disposes a broadcast message for a user.
Parameters
| Name | Type |
|---|---|
banner_ids | number[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:109
getUnseenNotification
▸ getUnseenNotification(config?): Promise<SCNotificationUnseenCountType>
This endpoint retrieves the number of unseen/unread notifications.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:49
listBroadcastMessages
▸ listBroadcastMessages(config?): Promise<SCPaginatedResponse<SCBroadcastMessageType>>
This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCBroadcastMessageType>>
Defined in
services/notification/index.ts:66
listBroadcastMessagesUndisposedCount
▸ listBroadcastMessagesUndisposedCount(config?): Promise<SCNotificationUnseenCountType>
This endpoint retrieves the total number of broadcast messages not yet disposed by the user.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:82
listBroadcastMessagesUnseenCount
▸ listBroadcastMessagesUnseenCount(config?): Promise<SCNotificationUnseenCountType>
This endpoint retrieves the total number of broadcast messages not yet seen by the user.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:74
listUserNotification
▸ listUserNotification(config?): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>
List all user notifications (in aggregate form) related to the community.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCNotificationAggregatedType>>
Defined in
services/notification/index.ts:27
markReadBroadcastMessages
▸ markReadBroadcastMessages(banner_ids, config?): Promise<any>
This endpoint marks as viewed/read a broadcast message for a user.
Parameters
| Name | Type |
|---|---|
banner_ids | number[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:95
markReadNotification
▸ markReadNotification(sids, config?): Promise<any>
This endpoint marks as read a list of notifications identified by serialization_ids (sids).
Parameters
| Name | Type |
|---|---|
sids | string[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>