NotificationAPI

APIs. Namespace

NotificationAPI

Description:

  • NotificationAPI namespace

See:

Methods

(static) *common(req, res)

Parameters:
Name Type Description
req Object
res Object
Throws:
status message description
404 NOTIFICATION_NOT_FOUND if notification is not found

(static) CNotification API(req, res)

Description:

  • 알림 생성 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/notifications"
user Object
body Object
Properties
Name Type Attributes Description
toUserList Array.<Object>
toUserList[i].user string

objectId of user
toUserList[i].userId string
toUserList[i].userName string
category string <nullable>
title string
description string
res Object
Properties
Name Type Description
notifications Array.<Object>

created notifications

(static) DNotification API(req, res)

Description:

  • 알림 삭제 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "DELETE"
url "/notifications/:_id"
user Object
res Object

(static) RNotification API(req, res)

Description:

  • 알림 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/notifications/:_id"
user Object
res Object
Properties
Name Type Description
notification Object

(static) RNotifications API(req, res)

Description:

  • 알림 목록 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/notifications"
query Object
Properties
Name Type Attributes Description
type "received" | "sent"
checked boolean <nullable>
user Object
res Object
Properties
Name Type Description
notifications Array.<Object>

(static) UCheckNotification API(req, res)

Description:

  • 알림 확인 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/notifications/:_id/check"
user Object
res Object