Hub/docs/serverAPI/message/noticount

 

message/noticount

Description

  • 로그인한 사용자의 신규로 받은 message의 갯수를 가져온다.
  • HiveSocial v2.4.1+ 이상에서 사용가능.

Parameters

  • Request
    • N/A
  • Response
name type description
type String response type
error_code Integer error code (하단 Error Code 참조)
data Dictionary 하단 data info 테이블 참조
  • data info
name type description
messages_count Integer 신규로 받은 message의 갯수
messages_view String message 웹뷰 path. 해당 값으로 CS_hubShowDialog을 호출한다.
messages_write Integer message write 웹뷰 path format. 해당 값의 format으로 CS_hubShowDialog을 호출한다.

Error Code

  • 0 : 성공
  • 그 외 : 실패

출력 JSON

{
    "type": "message/noticount",
    "error_code": 0,
    "data" : {
        "messages_count" : 1
        "messages_view" : "{MESSAGE_VIEW_PATH}", // message
        "messages_write" : "{MESSAGE_WRITE_PATH_FORMAT}" // message/view/{유저 UID}
    }
}

NOTE

  • messages_view는 받은 쪽지의 페이지로 이동하기 위한 path를 제공합니다. 해당 값으로 CS_hubShowDialog를 호출하면 됩니다.
    • ex) CS_hubShowDialog("message")
  • messages_write는 특정 사용자에게 쪽지쓰기 페이지를 보여주기 위한 format을 제공합니다. 특별한 경우가 아니라면 message/view/{유저 UID}을 사용하시면 됩니다.
    • ex) CS_hubShowDialog("message/view/1234567")

Related Method