IMessaging.Delete()

Description:

The Delete method deletes a message.

This is a synchronous method.

Syntax:

result = so.IMessaging.Delete(criteria);

Arguments:

  • criteria:

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

Table: Criteria object properties

Property

Description

Type

criteria.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

result.ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

result.ErrorMessage

This is a text string that describes the error.

See Messaging Service API error messages.

Example code:

For the complete source of a sample widget that demonstrates how to use this Service API, see the full example.