쪽지 기능

뒤끝은 게임 유저 간의 쪽지기능을 제공합니다.
각각의 보낸 쪽지 리스트와 받은 쪽지 리스트는 콘솔에서 설정한 최대 보유수 만큼만 보유 가능합니다. 쪽지 기능은 게이머 닉네임이 존재해야만 사용 가능합니다.

쪽지 보내기

다른 게임 유저에게 쪽지를 보내는 기능입니다. 쪽지 contents의 글자수는 콘솔에서 설정한 글자수 만큼만 보낼 수 있습니다.

동기

SendMessage( String gamerIndate, String contents ) -> BackendReturnObject

// example
Backend.Social.Message.SendMessage("gamerIndate", "오늘 하루도 좋은 하루 보내");

비동기

SendMessage( String gamerIndate, String contents, Function callback ) -> void

// example
Backend.Social.Message.SendMessage( "gamerIndate", "오늘 하루도 좋은 하루 보내", (callback) => 
{
    // 이후 처리
});

Parameters

ValueTypeDescription
gamerIndateString쪽지를 받을 게이머의 indate
contentsString쪽지 내용

Error cases

  • 받는 사람의 메세지가 꽉찬 경우
    statusCode : 405
    errorCode : MethodNotAllowedParameterException
    message : MethodNotAllowed The recipients message is full., 이용할 수 없는 The recipients message is full. 입니다

  • contents 글자수가 콘솔에서 설정한 글자수보다 큰 경우
    statusCode : 412
    errorCode : PreconditionFailed
    message : content length 사전 조건을 만족하지 않습니다.

  • 보내는 사람과 받는 사람이 같은 경우
    statusCode : 400
    errorCode : BadParameterException
    message : bad Sender and recipient can not be the same., 잘못된 Sender and recipient can not be the same. 입니다

  • 보내는 사람의 닉네임이 없는 경우
    statusCode : 401
    errorCode : BadUnauthorizedException
    message : bad senderNickname, 잘못된 senderNickname 입니다

  • 쪽지 최대보유수가 0인 경우
    statusCode : 403
    errorCode : ForbiddenException
    message : Forbidden send message 0, 금지된 send message 0

받은 쪽지 리스트

받은 쪽지 리스트를 반환합니다.
콘솔에서 설정한 최대 보유수 만큼 리스트를 보유할 수 있으며, 쪽지가 가득찬 경우 쪽지를 받을 수 없습니다.

동기

GetReceivedMessageList() -> BackendReturnObject

// example
Backend.Social.Message.GetReceivedMessageList();

비동기

GetReceivedMessageList( Function callback ) -> void

// example
Backend.Social.Message.GetReceivedMessageList( ( callback ) => 
{
    // 이후 처리
});

보낸 쪽지 리스트

보낸 쪽지 리스트를 반환합니다.
콘솔에서 설정한 최대 보유수 만큼 리스트를 보유할 수 있으며, 리스트가 가득찬 상태에서 쪽지를 보내면 가장 오래된 쪽지가 삭제되고 최신 쪽지가 리스트에 추가됩니다.

동기

GetSentMessageList() -> BackendReturnObject

// example
Backend.Social.Message.GetSentMessageList();

비동기

GetSentMessageList( Function callback ) -> void

// example
Backend.Social.Message.GetSentMessageList( ( callback ) => 
{
    // 이후 처리
});

결과값 예시 (GetReceivedMessageList, GetSentMessageList)

{
    { 
        rows:
        [
            {
                receiver: // 쪽지 받은 사람의 inDate
                    { S : "2018-12-18T01:58:18.722Z" },
                sender: // 쪽지 보낸 사람의 inDate
                    { S : "2018-12-27T00:21:31.322Z" },
                content: // 쪽지 내용
                    { S : "hello this is user7. How are you doing?" },
                inDate: // 쪽지의 inDate
                    { S : "2018-12-27T00:26:22.083Z" },
                senderNickname: // 쪽지 보낸 사람의 닉네임
                    { S : "user7" },
                isRead: // 받은 사람이 읽었는지 판단하는 기준
                    { BOOL : false },
                receiverNickname: // 쪽지 받은 사람의 닉네임
                    { S : "ryan" },
                isReceiverDelete: // 쪽지 받은 사람의 쪽지 삭제 여부
                    { BOOL : false },
                isSenderDelete:  // 쪽지 보낸 사람의 쪽지 삭제 여부
                    { BOOL : false }
            },
            { 
                receiver: [Object],
                sender: [Object],
                content: [Object],
                inDate: [Object],
                senderNickname: [Object],
                isRead: [Object],
                receiverNickname: [Object], 
                isReceiverDelete: [Object],
                isSenderDelete: [Object]
            }
        ]
    }
}

받은 쪽지 읽기

받은 쪽지 한개를 읽는 기능입니다.
이 메소드 호출 이후, 해당 메세지의 isRead 의 값이 true 로 전환됩니다.

동기

GetReceivedMessage( String messageIndate ) -> BackendReturnObject

// example
Backend.Social.Message.GetReceivedMessage("messageIndate");

비동기

GetReceivedMessage( String messageIndate, Function callback ) -> void

// example
Backend.Social.Message.GetReceivedMessage( "messageIndate", ( callback ) => 
{
    // 이후 처리
});

Parameter

ValueTypeDescription
messageIndateString읽고자하는 받은 쪽지의 indate

보낸 쪽지 읽기

보낸 쪽지 한개를 읽는 기능입니다.

동기

GetSentMessage( String messageIndate ) -> BackendReturnObject

// example
Backend.Social.Message.GetSentMessage("messageIndate");

비동기

GetSentMessage( String messageIndate, Function callback ) -> void

// example
Backend.Social.Message.GetSentMessage( "messageIndate", ( callback ) => 
{
    // 이후 처리
});

Parameter

ValueTypeDescription
messageIndateString읽고자하는 보낸 쪽지의 indate

결과값 예시 (GetReceivedMessage, GetSentMessage)

{ 
    { 
        row:
        {
            receiver: // 쪽지 받은 사람의 inDate
                { S : "2018-12-18T01:58:18.722Z" },
            sender: // 쪽지 보낸 사람의 inDate
                { S : "2018-12-27T00:21:31.322Z" },
            content: // 쪽지 내용
                { S : "hello this is user7. How are you doing?" },
            inDate: // 쪽지의 inDate
                { S : "2018-12-27T00:26:22.083Z" },
            senderNickname: // 쪽지 보낸 사람의 닉네임
                { S : "user7" },
            isRead: // 받은 사람이 읽었는지 판단하는 기준
                { BOOL : false },
            receiverNickname: // 쪽지 받은 사람의 닉네임
                { S : "ryan" },
            isReceiverDelete: // 쪽지 받은 사람의 쪽지 삭제 여부
                { BOOL : false },
            isSenderDelete:  // 쪽지 보낸 사람의 쪽지 삭제 여부
                { BOOL : false }
        }
    }
}

받은 쪽지 삭제

받은 쪽지 리스트에 있는 쪽지를 삭제합니다.

동기

DeleteReceivedMessage( String messageIndate ) -> BackendReturnObject

// example
Backend.Social.Message.DeleteReceivedMessage("messageIndate");

비동기

DeleteReceivedMessage( String messageIndate,  Function callback ) -> void

// example
Backend.Social.Message.DeleteReceivedMessage( "messageIndate", ( callback ) => 
{
    // 이후 처리
});

Parameter

ValueTypeDescription
messageIndateString삭제하려는 받은 쪽지의 indate

보낸 쪽지 삭제

보낸 쪽지 리스트에 있는 쪽지를 삭제합니다.
보낸 쪽지를 삭제하더라고 받은 사람의 받은 쪽지 목록은 남아있습니다.

동기

DeleteSentMessage( String messageIndate ) -> BackendReturnObject

// example
Backend.Social.Message.DeleteSentMessage("messageIndate");

비동기

DeleteSentMessage( String messageIndate,  Function callback ) -> void

// example
Backend.Social.Message.DeleteSentMessage( "messageIndate", ( callback ) => 
{
    // 이후 처리
});

Parameter

ValueTypeDescription
messageIndateString삭제하려는 보낸 쪽지의 indate