IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::NSSyncInfo Class Reference

This class provides a set of APIs for Notification service SyncInfo . More...

Public Types

enum  NSSyncType { NSSyncType::NS_SYNC_UNREAD = 0, NSSyncType::NS_SYNC_READ = 1, NSSyncType::NS_SYNC_DELETED = 2 }
 NSSyncType - enumeration for Notification service SyncType. More...
 

Public Member Functions

 NSSyncInfo ()
 Constructor of NSSyncInfo. More...
 
 NSSyncInfo (::NSSyncInfo *syncInfo)
 Constructor of NSSyncInfo. More...
 
 NSSyncInfo (const uint64_t &messageId, const std::string &providerId, const NSSyncType &state)
 Constructor of NSSyncInfo. More...
 
 ~NSSyncInfo ()=default
 Destructor of NSSyncInfo. More...
 
uint64_t getMessageId () const
 This method is for getting Message Id from the Notification service sync info. More...
 
std::string getProviderId () const
 This method is for getting Provider Id from the Notification service sync info. More...
 
NSSyncType getState () const
 This method is for getting state from the Notification service sync info. More...
 

Detailed Description

This class provides a set of APIs for Notification service SyncInfo .

Member Enumeration Documentation

NSSyncType - enumeration for Notification service SyncType.

Enumerator
NS_SYNC_UNREAD 
NS_SYNC_READ 
NS_SYNC_DELETED 

Constructor & Destructor Documentation

OIC::Service::NSSyncInfo::NSSyncInfo ( )
inline

Constructor of NSSyncInfo.

OIC::Service::NSSyncInfo::NSSyncInfo ( ::NSSyncInfo syncInfo)

Constructor of NSSyncInfo.

Parameters
syncInfo- pointer to NSSyncInfo struct to initialize.
OIC::Service::NSSyncInfo::NSSyncInfo ( const uint64_t &  messageId,
const std::string &  providerId,
const NSSyncType state 
)
inline

Constructor of NSSyncInfo.

Parameters
messageId- messageId of the Notification SyncInfo.
providerId- providerId of the Notification SyncInfo.
state- state of the Notification SyncInfo.
OIC::Service::NSSyncInfo::~NSSyncInfo ( )
default

Destructor of NSSyncInfo.

Member Function Documentation

uint64_t OIC::Service::NSSyncInfo::getMessageId ( ) const

This method is for getting Message Id from the Notification service sync info.

Returns
Id as uint64_t.
std::string OIC::Service::NSSyncInfo::getProviderId ( ) const

This method is for getting Provider Id from the Notification service sync info.

Returns
Id as string.
NSSyncType OIC::Service::NSSyncInfo::getState ( ) const

This method is for getting state from the Notification service sync info.

Returns
state as NSSyncType.

The documentation for this class was generated from the following file: