MessageType Property

This is the type of the current message.

Syntax

 xmpp.getMessageType([callback])
 xmpp.setMessageType( messageType, [callback])

Possible Values

  0 (mtNormal), 
  1 (mtChat), 
  2 (mtGroupChat), 
  3 (mtHeadline), 
  4 (mtError)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getMessageType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setMessageType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:


normal (mtNormal - 0)	A single message.
chat (mtChat - 1)	A message sent in the context of two-way chat between two entities.
groupchat (mtGroupChat - 2)	A message sent in the context of multi-user chat among multiple entities.
headline (mtHeadline - 3)	A message that represents one of a list of items (e.g., in a news feed or information ticker).
error (mtError - 4)	A message returned to a sender specifying an error associated with a previous message sent by the sender to an intended recipient.

This property is not available at design time.

Data Type

Integer