GetMessageBoxes

Returns the list of messageboxes for this user. brainCloud currently only supports the default "inbox" and "sent" messageboxes.

None.

Service	Operation
messaging	GET_MESSAGE_BOXES

Method Parameters

None.

Usage

http://localhost:3000

C#

SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.MessagingService.GetMessageBoxes(successCallback, failureCallback);

C++

_bc->getMessagingService()->getMessageBoxes(this);

Objective-C

BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc messagingService] getMessageBoxes:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

this; // implements IServerCallback

_bc.getMessagingService().getMessageBoxes(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

_bc.messaging.getMessageBoxes(result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

ServerResponse result = await _bc.messagingService.getMessageBoxes();

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

Cloud Code

var messagingProxy = bridge.getMessagingServiceProxy();

var postResult = messagingProxy.getMessageBoxes();
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "messaging",
    "operation": "GET_MESSAGE_BOXES",
    "data": {}
}

JSON Response

{
    "status": 200,
    "data": {
        "items": [
            "inbox",
            "sent"
        ]
    }
}

Common Error Code

Status Codes

Code	Name	Description
40601	FEATURE_NOT_ENABLED	Messaging feature is not enabled for app.