Interface: NotificationApiClientInterface
services/notification.NotificationApiClientInterface
Methods
createCustomNotification
▸ createCustomNotification(data, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
data | CustomNotificationParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:11
disposeBroadcastMessages
▸ disposeBroadcastMessages(banner_ids, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
banner_ids | number[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:16
getUnseenNotification
▸ getUnseenNotification(config?): Promise<SCNotificationUnseenCountType>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:10
listBroadcastMessages
▸ listBroadcastMessages(config?): Promise<SCPaginatedResponse<SCBroadcastMessageType>>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCBroadcastMessageType>>
Defined in
services/notification/index.ts:12
listBroadcastMessagesUndisposedCount
▸ listBroadcastMessagesUndisposedCount(config?): Promise<SCNotificationUnseenCountType>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:14
listBroadcastMessagesUnseenCount
▸ listBroadcastMessagesUnseenCount(config?): Promise<SCNotificationUnseenCountType>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCNotificationUnseenCountType>
Defined in
services/notification/index.ts:13
listUserNotification
▸ listUserNotification(config?): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCNotificationAggregatedType>>
Defined in
services/notification/index.ts:8
markReadBroadcastMessages
▸ markReadBroadcastMessages(banner_ids, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
banner_ids | number[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/notification/index.ts:15
markReadNotification
▸ markReadNotification(sids, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
sids | string[] |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>