IMessaging.CancelNotification()

Description:

The CancelNotification method cancels notification of new incoming messages.

This is a synchronous method.

Syntax:

result = so.IMessaging.CancelNotification(criteria);

Arguments:

  • criteria:

    This is an object that specifies the request for cancelling notification of new messages. The object must contain the Type property (string), and this property must contain the value "NewMessage":

    criteria.Type = "NewMessage";

Return value:

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

Table: Return value properties for CancelNotification

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.