Caplin.DataSource.Notification.NotificationConfiguration Class Reference

The type NotificationConfiguration, which can be used to create a NotificationProvider instance. More...

Public Member Functions
	NotificationConfiguration (string sourceName)
	Instantiates a new NotificationConfiguration. More...
virtual void	SetNotificationUsingImageFlag (bool useImageFlag)
	Set the Notification records' image flags to be set to true on publishing initial message. More...
override string	ToString ()

Public Attributes
Caplin.XLang.Container.Configuration	internalConfiguration

Properties
virtual string	ChannelNamespace [get]
	Gets the channel namespace. More...
virtual bool	IsNotificationUsingImageFlag [get]
	Returns true if image flags are set to true on each Notification record for its initial message, otherwise false. More...
virtual string	ItemNamespace [get]
	Gets the item namespace. More...
virtual string	SourceName [get]
	Gets the notification source name. More...

Detailed Description

The type NotificationConfiguration, which can be used to create a NotificationProvider instance.

Constructor & Destructor Documentation

Caplin.DataSource.Notification.NotificationConfiguration.NotificationConfiguration ( string  sourceName )

inline

Instantiates a new NotificationConfiguration.

The sourceName can anything but without spaces is preferable. It will appear in the logging.

Parameters

sourceName

the NotificationProvider identifier

Member Function Documentation

virtual void Caplin.DataSource.Notification.NotificationConfiguration.SetNotificationUsingImageFlag ( bool  useImageFlag )

inlinevirtual

Set the Notification records' image flags to be set to true on publishing initial message.

The default, recommended setting is true. The use case for setting to false is to prevent notifications' fields being overwritten when two providers provide for the same Notifications.

Parameters

useImageFlag

boolean used to set the channel items image flags

Property Documentation

virtual string Caplin.DataSource.Notification.NotificationConfiguration.ChannelNamespace

get

Gets the channel namespace.

the channel namespace in the notification configuration

virtual bool Caplin.DataSource.Notification.NotificationConfiguration.IsNotificationUsingImageFlag

get

Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.

Returns true if Notification records use image flags

virtual string Caplin.DataSource.Notification.NotificationConfiguration.ItemNamespace

get

Gets the item namespace.

the item namespace in the notification configuration

virtual string Caplin.DataSource.Notification.NotificationConfiguration.SourceName

get

Gets the notification source name.

the notification source name in the notification configuration