Skip to content

News Protocol

Yannik Marchand edited this page Jan 27, 2021 · 1 revision

NEX Protocols > News (31)

Method ID Method Name
1 GetChannels
2 GetChannelsByTypes
3 GetSubscribableChannels
4 GetChannelsByIDs
5 GetSubscribedChannels
6 SubscribeChannel
7 UnsubscribeChannel
8 GetNewsHeaders
9 GetNewsMessages
10 GetNumberOfNews
11 GetChannelByType
12 GetNewsHeadersByType
13 GetNewsMessagesByType

(1) GetChannels

Request

Type Name
ResultRange resultRange

Response

Type Name
List<NewsChannel> channels

(2) GetChannelsByTypes

Request

Type Name
List<String> newsChannelTypes
ResultRange resultRange

Response

Type Name
List<NewsChannel> channels

(3) GetSubscribableChannels

Request

Type Name
ResultRange resultRange

Response

Type Name
List<NewsChannel> channels

(4) GetChannelsByIDs

Request

Type Name
List<Uint32> newsChannelIDs

Response

Type Name
List<NewsChannel> channels

(5) GetSubscribedChannels

Request

Type Name
ResultRange resultRange

Response

Type Name
List<NewsChannel> channels

(6) SubscribeChannel

Request

Type Name
Uint32 newsChannelID

Response

This method does not return anything.

(7) UnsubscribeChannel

Request

Type Name
Uint32 newsChannelID

Response

This method does not return anything.

(8) GetNewsHeaders

Request

Type Name
NewsRecipient recipient
ResultRange range

Response

Type Name
List<NewsHeader> newsHeaders

(9) GetNewsMessages

Request

Type Name
List<Uint32> newsMessageIDs

Response

Type Name
List<NewsMessage> newsMessages

(10) GetNumberOfNews

Request

Type Name
NewsRecipient recipient

Response

Type Name
Uint32 numberOfNews

(11) GetChannelByType

Request

Type Name
String newsChannelType

Response

Type Name
NewsChannel channel

(12) GetNewsHeadersByType

Request

Type Name
String newsChannelType
ResultRange range

Response

Type Name
List<NewsHeader> newsHeaders

(13) GetNewsMessagesByType

Request

Type Name
String newsChannelType
ResultRange range

Response

Type Name
List<NewsMessage> newsMessages

Types

NewsChannel (Structure)

Type Name
Uint32 m_ID
Uint32 m_ownerPID
String m_name
String m_description
DateTime m_creationTime
DateTime m_expirationTime
String m_type
String m_locale
Bool m_subscribable

NewsHeader (Structure)

Type Name
Uint32 m_ID
Uint32 m_recipientID
Uint32 m_recipientType
Uint32 m_publisherPID
String m_publisherName
DateTime m_publicationTime
DateTime m_displayTime
DateTime m_expirationTime
String m_title
String m_link

NewsMessage (Structure)

Type Name
String m_body

NewsRecipient (Structure)

Type Name
Uint32 m_recipientID
Uint32 m_recipientType
Clone this wiki locally