IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NSCommon.h File Reference

This file provides APIs of Notification Service for common functions. More...

Go to the source code of this file.

Classes

struct  _nsTopic
 Topic linked list. More...
 
struct  NSConsumer
 Consumer information. More...
 
struct  NSProvider
 Provider information. More...
 
struct  NSMediaContents
 Media Contents of Notification Message (Optional) More...
 
struct  NSMessage
 Notification Message. More...
 
struct  NSSyncInfo
 Synchronization information of the notification message. More...
 

Macros

#define NS_UUID_STRING_SIZE   37
 

Typedefs

typedef enum eResult NSResult
 Result code of notification service. More...
 
typedef struct _nsTopic NSTopicLL
 Topic linked list. More...
 

Enumerations

enum  eResult { NS_OK = 100, NS_ERROR = 200, NS_SUCCESS = 300, NS_FAIL = 400 }
 Result code of notification service. More...
 
enum  NSProviderState {
  NS_ALLOW = 1, NS_DENY = 2, NS_TOPIC = 3, NS_DISCOVERED = 11,
  NS_STOPPED = 12
}
 Provider state of notification consumer service. More...
 
enum  NSSyncType { NS_SYNC_UNREAD = 0, NS_SYNC_READ = 1, NS_SYNC_DELETED = 2 }
 Notification message status to synchronize. More...
 
enum  NSMessageType {
  NS_MESSAGE_ALERT = 1, NS_MESSAGE_NOTICE = 2, NS_MESSAGE_EVENT = 3, NS_MESSAGE_INFO = 4,
  NS_MESSAGE_WARNING = 5, NS_MESSAGE_READ = 11, NS_MESSAGE_DELETED = 12
}
 Notification Message Type Alert mean is High / critical Notice mean is low / critical Event mean is High / Normal Information mean is Low / Normal. More...
 
enum  NSTopicState { NS_TOPIC_UNSUBSCRIBED = 0, NS_TOPIC_SUBSCRIBED = 1 }
 Notification topic state. More...
 

Detailed Description

This file provides APIs of Notification Service for common functions.

Macro Definition Documentation

#define NS_UUID_STRING_SIZE   37

Typedef Documentation

typedef enum eResult NSResult

Result code of notification service.

typedef struct _nsTopic NSTopicLL

Topic linked list.

Enumeration Type Documentation

enum eResult

Result code of notification service.

Enumerator
NS_OK 
NS_ERROR 
NS_SUCCESS 
NS_FAIL 

Notification Message Type Alert mean is High / critical Notice mean is low / critical Event mean is High / Normal Information mean is Low / Normal.

Enumerator
NS_MESSAGE_ALERT 
NS_MESSAGE_NOTICE 
NS_MESSAGE_EVENT 
NS_MESSAGE_INFO 
NS_MESSAGE_WARNING 
NS_MESSAGE_READ 
NS_MESSAGE_DELETED 

Provider state of notification consumer service.

Enumerator
NS_ALLOW 
NS_DENY 
NS_TOPIC 
NS_DISCOVERED 
NS_STOPPED 
enum NSSyncType

Notification message status to synchronize.

Enumerator
NS_SYNC_UNREAD 
NS_SYNC_READ 
NS_SYNC_DELETED 

Notification topic state.

Enumerator
NS_TOPIC_UNSUBSCRIBED 
NS_TOPIC_SUBSCRIBED