Home docs nex protocols Messaging (23)
Post

Messaging (23)

Methods

(1) DeliverMessage

Request

TypeName
AnyoUserMessage

Response

TypeName
AnyoModifiedMessage
List<Uint32>lstSandboxNodeId
List<PID>lstParticipants

(2) GetNumberOfMessages

Request

TypeName
MessageRecipientrecipient

Response

TypeName
Uint32uiNbMessages

(3) GetMessagesHeaders

Request

TypeName
MessageRecipientrecipient
ResultRangerange

Response

TypeName
List<UserMessage>lstMsgHeaders

(4) RetrieveAllMessagesWithinRange

Request

TypeName
MessageRecipientrecipient
ResultRangerange

Response

TypeName
List<Any>lstMessages

(5) RetrieveMessages

Request

TypeName
MessageRecipientrecipient
List<Uint32>lstMsgIDs
BoolbLeaveOnServer

Response

TypeName
List<Any>lstMessages

(6) DeleteMessages

Request

TypeName
MessageRecipientrecipient
List<Uint32>lstMessagesToDelete

Response

This method does not return anything.

(7) DeleteAllMessages

Request

TypeName
MessageRecipientrecipient

Response

TypeName
Uint32uiNbDeletedMessages

(8) DeliverMessageMultiTarget

Request

TypeName
List<PID>lstTarget
AnyoUserMessage

Response

TypeName
AnyoModifiedMessage
List<Uint32>lstSandboxNodeId
List<PID>lstParticipants

Types

MessageRecipient (Structure)

TypeName
Uint32m_idRecipient
Uint32m_uiRecipientType

In NEX version 4.0, the recipient id was split into the principal id and the gathering id:

TypeName
Uint32m_uiRecipientType
PIDm_principalId
Uint32m_gatheringId

Recipient type:

TypeDescription
1Principal id
2Gathering id

UserMessage (Structure)

This structure inherits from Data

TypeName
Uint32m_uiID
Uint32m_idRecipient
Uint32m_uiRecipientType
Uint32m_uiParentID
PIDm_pidSender
DateTimem_receptiontime
Uint32m_uiLifeTime
Uint32m_uiFlags
Stringm_strSubject
Stringm_strSender

In NEX version 4.0, the m_idRecipient and m_uiRecipientType fields were removed and the message recipient was added:

TypeName
Uint32m_uiID
Uint32m_uiParentID
PIDm_pidSender
DateTimem_receptiontime
Uint32m_uiLifeTime
Uint32m_uiFlags
Stringm_strSubject
Stringm_strSender
MessageRecipientm_messageRecipient

TextMessage (Structure)

This structure inherits from UserMessage

TypeName
Stringm_strTextBody

BinaryMessage (Structure)

This structure inherits from UserMessage

TypeName
qBufferm_binaryBody
Contents