Skip to content

Messaging Protocol

Yannik Marchand edited this page Apr 30, 2021 · 11 revisions

NEX Protocols > Messaging (23)

Method ID Method Name
1 DeliverMessage
2 GetNumberOfMessages
3 GetMessagesHeaders
4 RetrieveAllMessagesWithinRange
5 RetrieveMessages
6 DeleteMessages
7 DeleteAllMessages
8 DeliverMessageMultiTarget

(1) DeliverMessage

Request

Type Name
Data oUserMessage

Response

Type Name
Data oModifiedMessage
List<Uint32> lstSandboxNodeId
List<PID> lstParticipants

(2) GetNumberOfMessages

Request

Type Name
MessageRecipient recipient

Response

Type Name
Uint32 uiNbMessages

(3) GetMessagesHeaders

Request

Type Name
MessageRecipient recipient
ResultRange range

Response

Type Name
List<UserMessage> lstMsgHeaders

(4) RetrieveAllMessagesWithinRange

Request

Type Name
MessageRecipient recipient
ResultRange range

Response

Type Name
List<Data> lstMessages

(5) RetrieveMessages

Request

Type Name
MessageRecipient recipient
List<Uint32> lstMsgIDs
Bool bLeaveOnServer

Response

Type Name
List<Data> lstMessages

(6) DeleteMessages

Request

Type Name
MessageRecipient recipient
List<Uint32> lstMessagesToDelete

Response

This method does not return anything.

(7) DeleteAllMessages

Request

Type Name
MessageRecipient recipient

Response

Type Name
Uint32 uiNbDeletedMessages

Types

MessageRecipient (Structure)

Type Name
Uint32 m_uiRecipientType
PID m_principalId
Uint32 m_gatheringId

Recipient type:

Type Description
1 Principal id
2 Gathering id

UserMessage (Structure)

This structure inherits from Data
Type Name
Uint32 m_uiID
Uint32 m_uiParentID
PID m_pidSender
DateTime m_receptiontime
Uint32 m_uiLifeTime
Uint32 m_uiFlags
String m_strSubject
String m_strSender
MessageRecipient m_messageRecipient

TextMessage (Structure)

This structure inherits from UserMessage
Type Name
String m_strTextBody

BinaryMessage (Structure)

This structure inherits from UserMessage
Type Name
qBuffer m_binaryBody
Clone this wiki locally