Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel Class Reference

Specifies the level of notification that the client wishes to receive. More...

Inheritance diagram for PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel:
PushTechnology.DiffusionCore.AdvancedEnum< T >

Public Types

enum  Notification {
  Notification.MINIMUM, Notification.PROPERTIES, Notification.METADATA, Notification.FULL,
  Notification.NONE
}
 Describes the notification level. More...
 

Static Public Attributes

static readonly NotificationLevel Minimum = new NotificationLevel(Notification.MINIMUM, "0", false, false)
 The minimum level of notification that can be received which will simply notify of the topic name and its type. More...
 
static readonly NotificationLevel Properties
 This level of notification is the same as MINIMUM plus all properties of the topic. More...
 
static readonly NotificationLevel Metadata
 This level of notification is the same as MINIMUM plus any metadata associated with the topic. More...
 
static readonly NotificationLevel Full = new NotificationLevel(Notification.FULL, "3", true, true)
 This level of notification provides all details of the topic and would be the level needed in order to replicate the topic. More...
 
static readonly NotificationLevel None = new NotificationLevel(Notification.NONE, "4", false, false)
 This special setting may be used to indicate that add notifications are not required. More...
 

Properties

string NotificationCode [get, set]
 Get/set the code representation as used in messages. More...
 
bool NotificationProperties [get, set]
 Get/set whether the notification level includes properties. More...
 
bool NotificationMetadata [get, set]
 Get/set whether the notification level includes metadata. More...
 
- Properties inherited from PushTechnology.DiffusionCore.AdvancedEnum< T >
string Name [get]
 Returns the name of this enum. More...
 

Additional Inherited Members

- Public Member Functions inherited from PushTechnology.DiffusionCore.AdvancedEnum< T >
override string ToString ()
 
Returns
A human readable representation of the value

 
- Static Public Member Functions inherited from PushTechnology.DiffusionCore.AdvancedEnum< T >
static T ValueOf (string name)
 Returns the value of this enum. More...
 
static IEnumerable< T > Values ()
 Returns the values of this enum. More...
 
- Public Attributes inherited from PushTechnology.DiffusionCore.AdvancedEnum< T >
Enum INTERNAL_ENUM
 The internal enum value. More...
 

Detailed Description

Specifies the level of notification that the client wishes to receive.

This should be specified when the handler is created using ExternalClient.CreateTopicNotifyTopicHandler( TopicMessage, TopicNotifyTopicHandler.NotificationLevel, TopicNotifyTopicListener ) and can be changed using TopicNotifyTopicHandler.SetNotificationLevel( TopicNotifyTopicHandler.NotificationLevel ).

Member Enumeration Documentation

Describes the notification level.

Enumerator
MINIMUM 

The minimum level of notification that can be received which will simply notify of the topic name and its type.

PROPERTIES 

This level of notification is the same as MINIMUM plus all properties of the topic.

METADATA 

This level of notification is the same as MINIMUM plus any metadata associated with the topic.

FULL 

This level of notification provides all details of the topic and would be the level needed in order to replicate the topic.

NONE 

This special setting may be used to indicate that add notifications are not required.

Member Data Documentation

readonly NotificationLevel PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.Full = new NotificationLevel(Notification.FULL, "3", true, true)
static

This level of notification provides all details of the topic and would be the level needed in order to replicate the topic.

readonly NotificationLevel PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.Metadata
static
Initial value:
= new NotificationLevel(Notification.METADATA, "2", false,
true)

This level of notification is the same as MINIMUM plus any metadata associated with the topic.

readonly NotificationLevel PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.Minimum = new NotificationLevel(Notification.MINIMUM, "0", false, false)
static

The minimum level of notification that can be received which will simply notify of the topic name and its type.

readonly NotificationLevel PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.None = new NotificationLevel(Notification.NONE, "4", false, false)
static

This special setting may be used to indicate that add notifications are not required.

readonly NotificationLevel PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.Properties
static
Initial value:
= new NotificationLevel(Notification.PROPERTIES, "1", true,
false)

This level of notification is the same as MINIMUM plus all properties of the topic.

Property Documentation

string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.NotificationCode
getset

Get/set the code representation as used in messages.

bool PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.NotificationMetadata
getset

Get/set whether the notification level includes metadata.

bool PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Notify.NotificationLevel.NotificationProperties
getset

Get/set whether the notification level includes properties.