GetRecentChatMessages

Returns a list of max \<n> messages from history.

Service	Operation
chat	GET_RECENT_MESSAGES

Method Parameters

Parameter	Description
channelId	The chat channel to retrieve messages from
maxReturn	Maximum number of messages to return

Usage

http://localhost:3000

C#

string channelId = "22817:gl:CHAT_TRADE"; // APP_ID:CHANNEL_TYPE:CHANNEL_ID
int maxReturn = 25;
SuccessCallback successCallback = (response, cbObject) =>
{
    Dictionary<string, object> jsonMessage = (Dictionary<string, object>)JsonFx.Json.JsonReader.Deserialize(response);
    Dictionary<string, object> jsonData = (Dictionary<string, object>)jsonMessage["data"];
    var messages = (Dictionary<string, object>[]) jsonData["messages"];
    
    foreach (Dictionary<string, object> message in messages)
    {
        var content = (Dictionary<string, object>)message["content"];
        var item = (Dictionary<string, object>)content["SELL_ITEM"];
        
        string itemType = item["ITEM_TYPE"].ToString();
        string itemId = item["ITEM_ID"].ToString();
        string price = item["PRICE"].ToString();
        string currency = item["CURRENCY"].ToString();
        string logMessage = string.Join(" | ", new[] {itemType, itemId, price, currency});
        Debug.Log(logMessage);  // COUCH | d05a5b9d-374e-41e2-a498-c7387bf15c76 | 105 | GOLDCOINS
    }
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("[GetRecentChatMessages Failed] {0}  {1}  {2}", status, code, error));
};

_bc.ChatService.GetRecentChatMessages(channelId, maxReturn, successCallback, failureCallback);

C++

const char *channelId = "55555:gl:bcDev";
int maxReturn = 25;
_bc->getChatService()->getRecentChatMessages(channelId, maxReturn, this);

Objective-C

NSString *channelId = @"55555:gl:bcDev";
int maxReturn = 25;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc chatService] getRecentChatMessages:channelId
                  maxReturn:maxReturn
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String channelId = "22817:gl:CHAT_TRADE"; // APP_ID:CHANNEL_TYPE:CHANNEL_ID
int maxReturn = 25;
this; // implements IServerCallback

_bc.getChatService().getRecentChatMessages(channelId, maxReturn, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var channelId = "22817:gl:CHAT_TRADE"; // APP_ID:CHANNEL_TYPE:CHANNEL_ID
var maxReturn = 25;

_bc.chat.getRecentChatMessages(channelId, maxReturn, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  channelId = "22817:gl:CHAT_TRADE";
var  maxReturn = 25;

ServerResponse result = await _bc.chatService.getRecentChatMessages(channelId:channelId, maxReturn:maxReturn);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var chatProxy = bridge.getChatServiceProxy();
var getResult = chatProxy.getRecentChatMessages( channelId, 25 );
if (getResult.status == 200 ) {
    msgArray = getResult.data.messages;
}

Raw

{
  "channelId": "55555:gl:bcDev",
  "maxReturn": 25
}

JSON Response

{
    "data": {
        "messages": [{
            "date": 1530649082684,
            "ver": 1,
            "msgId": "783692330334210",
            "from": {
                "id": "a7b7de02-8432-4547-8c40-9af94537fce0",
                "name": "RedBomber",
                "pic": null
            },
            "chId": "22817:gl:CHAT_TRADE",
            "content": {
                "text": "Looking to sell a couch for 105 gold coins.",
                "rich": {
                    "SELL_ITEM": {
                        "ITEM_TYPE": "COUCH",
                        "ITEM_ID": "d05a5b9d-374e-41e2-a498-c7387bf15c76",
                        "PRICE": "105",
                        "CURRENCY": "GOLDCOINS"
                    }
                }
            }
        }, 
        {
            "date": 1530650080029,
            "ver": 1,
            "msgId": "783692840974851",
            "from": {
                "id": "805cc012-0bf1-40a0-9716-b896d8f4c424",
                "name": "Chantel",
                "pic": null
            },
            "chId": "22817:gl:CHAT_TRADE",
            "content": {
                "text": "For that couch, how about 25 gems instead?"
            }
        }, 
        {
            "date": 1530650218944,
            "ver": 1,
            "msgId": "783692912099332",
            "from": {
                "id": "a7b7de02-8432-4547-8c40-9af94537fce0",
                "name": "RedBomber",
                "pic": null
            },
            "chId": "22817:gl:CHAT_TRADE",
            "content": {
                "text": "Sold!"
            }
        }]
    },
    "status": 200
}

Common Error Code

Status Codes

Code	Name	Description
40601	RTT_NOT_ENABLED	RTT must be enabled for this feature
40603	CHAT_UNRECOGNIZED_CHANNEL	The specified channel is invalid