Simias::Storage::Notification Class Reference

Class to hold Notifications. More...

List of all members.

Public Member Functions
	Notification (Node node)
	Constructs a Notification object from a node that represents a notification.
Static Public Member Functions
static Notification	NotificationFactory (NodeEventArgs args)
	Notification factory method that constructs a Notification object from a NodeEventArgs object.
Properties
string	CollectionID [get]
	Gets the identifier of the collection that the notification applies to.
string	CollectionName [get]
	Gets the name of the collection that the notification applies to.
string	FileName [get]
	Gets the name of the file that the notification applies to. Note: This property is only valid for notifications of type NotificationType.SyncFailure_Quota or NotificationType.SyncFailure_ReadOnly.
string	MemberName [get]
	Gets the name of the member that the notification applies to. Note: This property is only valid for notifications of type NotificationType.MemberJoined.
string	NodeID [get]
	Gets the identifier of the node that the notification applies to. Note: This property is only valid for notifications of type NotificationType.CollectionShared, NotificationType.MemberJoined, or NotificationType.ConflictOccurred.
string	SharedCollectionID [get]
	Gets the identifier of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.
string	SharedCollectionName [get]
	Gets the name of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.
string	SharedCollectionType [get]
	Gets the type of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.
DateTime	TimeStamp [get]
	Gets the time stamp of the notification.
NotificationType	Type [get]
	Gets the type of the notification.

---

Detailed Description

Class to hold Notifications.

---

Constructor & Destructor Documentation

Simias::Storage::Notification::Notification

(

Node

node

)

[inline]

Constructs a Notification object from a node that represents a notification.

Parameters:

node

The node that represents the notification.

---

Member Function Documentation

static Notification Simias::Storage::Notification::NotificationFactory

(

NodeEventArgs

args

)

[inline, static]

Notification factory method that constructs a Notification object from a NodeEventArgs object.

Parameters:

args

The NodeEventArgs object to construct the Notification object from. The NodeEventArgs object will be returned while listening to node events on the Notification Log.

Returns:

The Notification object for the event.

---

Property Documentation

string Simias::Storage::Notification::CollectionID [get]

Gets the identifier of the collection that the notification applies to.

string Simias::Storage::Notification::CollectionName [get]

Gets the name of the collection that the notification applies to.

string Simias::Storage::Notification::FileName [get]

Gets the name of the file that the notification applies to. Note: This property is only valid for notifications of type NotificationType.SyncFailure_Quota or NotificationType.SyncFailure_ReadOnly.

string Simias::Storage::Notification::MemberName [get]

Gets the name of the member that the notification applies to. Note: This property is only valid for notifications of type NotificationType.MemberJoined.

string Simias::Storage::Notification::NodeID [get]

Gets the identifier of the node that the notification applies to. Note: This property is only valid for notifications of type NotificationType.CollectionShared, NotificationType.MemberJoined, or NotificationType.ConflictOccurred.

string Simias::Storage::Notification::SharedCollectionID [get]

Gets the identifier of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.

string Simias::Storage::Notification::SharedCollectionName [get]

Gets the name of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.

string Simias::Storage::Notification::SharedCollectionType [get]

Gets the type of the collection that was shared. Note: This property is only valid for notifications of type NotificationType.CollectionShared.

DateTime Simias::Storage::Notification::TimeStamp [get]

Gets the time stamp of the notification.

NotificationType Simias::Storage::Notification::Type [get]

Gets the type of the notification.

---

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

• src/core/Notifications/Notification.cs