DeleteMessages

Deletes the local copies of messages from the user's mailbox.

Service	Operation
messaging	DELETE_MESSAGES

Method Parameters

Parameter	Description
msgbox	The msgbox that we are deleting messages from
msgIds	An array of ids of the messages to delete

Usage

http://localhost:3000

C#

string msgbox = "inbox";
string[] msgIds = { "msgId1", "msgId2" };
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.DeleteMessages(msgbox, msgIds, successCallback, failureCallback);

C++

const char *msgbox = "inbox";
std::vector<std::string> msgIds;
msgIds.push_back("msgId1");
msgIds.push_back("msgId2");
_bc->getMessagingService()->deleteMessages(msgbox, msgIds, this);

Objective-C

NSString *msgbox = @"inbox";
NSArray *msgIds = @[ @"msgId1", @"msgId2" ];
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc messagingService] deleteMessages:msgbox
                     msgIds:msgIds
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String msgbox = "inbox";
String[] msgIds = { "msgId1", "msgId2" };
this; // implements IServerCallback

_bc.getMessagingService().deleteMessages(msgbox, msgIds, 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 msgbox = "inbox";
var msgIds = [ "msgId1", "msgId2" ];

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

Dart

var  msgBox = "inbox";
var  msgIds = [ "msgId1", "msgId2" ];

ServerResponse result = await _bc.messagingService.deleteMessages(msgBox:msgBox, msgIds:msgIds);

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

Cloud Code

var msgbox = "inbox";
var msgIds = [ "msgId1", "msgId2" ];
var messagingProxy = bridge.getMessagingServiceProxy();

var postResult = messagingProxy.deleteMessages(msgbox, msgIds);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "messaging",
    "operation": "DELETE_MESSAGES",
    "data": {
        "msgbox": "inbox",
        "msgIds": [
            "msgId1",
            "msgId2"
        ]
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "actual": 0,
        "requested": 2
    }
}

Common Error Code

Status Codes

Code	Name	Description
40601	RTT_NOT_ENABLED	RTT must be enabled for this feature