Delete()

Description:

The Delete method deletes a message.

This is a synchronous method.

Syntax:

Delete(parameters:Object):Object

Arguments:

  • parameters:

    This is an object that specifies the message to delete. The following table describes the properties of this object.

Table: Parameters object properties

Property

Description

Type

parameters.MessageId

Specifies the unique ID of the message to delete.

number

Return value:

The Delete method returns an object that contains an error code and an error message.

Table: Return value properties for Delete

Property

Description

Value

ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

ErrorMessage

This is a text string that describes the error.

Example code:

The following sample code illustrates how to delete a message:

import com.nokia.lib.Service;
var messaging = new Service("Service.Messaging", "IMessaging");
var inParams = {MessageId:messageId};//valid messageId which is a number
var outParams = messaging.Delete(inParams);
var errorId = outParams.ErrorCode;//various possible errorcodes