ChangeStatus()

Description:

The ChangeStatus method changes the read status of a message. The status can be "Read", "Unread", "Replied", or "Forwarded".

This is a synchronous method.

Syntax:

ChangeStatus(parameters:Object):Object

Arguments:

  • parameters:

    This is an object that specifies the message whose status to change and the new status. The following table describes the properties of this object.

Table: Parameters object properties

Property

Description

Type

Value

parameters.MessageId

Specifies the unique ID of the message whose status to change.

number

  

parameters.Status

Specifies the new read status for the message.

string

Possible values:

  • "Read"

  • "Unread"

  • "Replied"

  • "Forwarded"

Replied and Forwarded are only valid for email messages.

Note: The Messaging Service does not currently support emails.

Return value:

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

Table: Return value properties for ChangeStatus

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 the use of ChangeStatus:

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