Simias::Client::Event::NodeEventArgs Class Reference

The event arguments for a Collection event. More...

Inheritance diagram for Simias::Client::Event::NodeEventArgs:

[legend]

Collaboration diagram for Simias::Client::Event::NodeEventArgs:

[legend]

List of all members.

Public Types
enum	EventFlags { LocalOnly = 1 }
	Flags for the node event. More...
Public Member Functions
	NodeEventArgs (string source, string node, string collection, string type, EventType changeType, int eventId, DateTime time, ulong masterRev, ulong slaveRev, long fileSize)
	Constructs a SimiasEventArgs that will be used by CollectionHandler delegates. Describes the node affected by the event.
	NodeEventArgs (string source, string node, string collection, string modifier, string type, EventType changeType, int eventId, DateTime time, ulong masterRev, ulong slaveRev, long fileSize)
	Constructs a SimiasEventArgs that will be used by CollectionHandler delegates. Describes the node affected by the event.
Properties
string	Source [get]
	Gets the string that represents the source of the event.
string	ID [get]
	Gets the ID of the affected Node/Collection.
string	Collection [get]
	Gets the containing collection ID.
string	Modifier [get]
	Gets the ID of the user that modified the node.
string	Type [get]
	Gets the Type of the affected Node.
int	EventId [get]
	Gets a Sets an event ID. Usually 0. Used by a publisher. Can be used to detect circular events.
string	Node [get]
	Gets the Node ID.
ushort	Flags [get, set]
	Gets or sets the flags.
bool	LocalOnly [get, set]
	Gets or sets if the event refers to local only changes.
ulong	MasterRev [get]
	Gets the master revision for the node.
ulong	SlaveRev [get]
	Gets the slave revision for the node.
long	FileSize [get]
	Gets the file size for the node. If the node is not a file type, zero is returned.
EventType	EventType [get]
	Gets the type of event that occurred.

---

Detailed Description

The event arguments for a Collection event.

---

Member Enumeration Documentation

enum Simias::Client::Event::NodeEventArgs::EventFlags

Flags for the node event.

---

Constructor & Destructor Documentation

Simias::Client::Event::NodeEventArgs::NodeEventArgs	(	string	source,
		string	node,
		string	collection,
		string	type,
		EventType	changeType,
		int	eventId,
		DateTime	time,
		ulong	masterRev,
		ulong	slaveRev,
		long	fileSize
	)			[inline]

Constructs a SimiasEventArgs that will be used by CollectionHandler delegates. Describes the node affected by the event.

Parameters:

	source	The source of the event.
	node	The object of the event.
	collection	The Collection that the node belongs to.

\

Parameters:

	type	The Type of the Node.
	changeType	The type of change that occured.
	eventId	A user defined event ID. Only has meaning to a publisher.
	time	The time of the event.
	masterRev	The master revision for the node.
	slaveRev	The local revision for the node.
	fileSize	The length of the file if the node is a BaseFileNode. Otherwise the value of this parameter will be zero.

Simias::Client::Event::NodeEventArgs::NodeEventArgs	(	string	source,
		string	node,
		string	collection,
		string	modifier,
		string	type,
		EventType	changeType,
		int	eventId,
		DateTime	time,
		ulong	masterRev,
		ulong	slaveRev,
		long	fileSize
	)			[inline]

Constructs a SimiasEventArgs that will be used by CollectionHandler delegates. Describes the node affected by the event.

Parameters:

	source	The source of the event.
	node	The object of the event.
	collection	The Collection that the node belongs to.
	modifier	The user that modified the node.
	type	The Type of the Node.
	changeType	The type of change that occured.
	eventId	A user defined event ID. Only has meaning to a publisher.
	time	The time of the event.
	masterRev	The master revision for the node.
	slaveRev	The local revision for the node.
	fileSize	The length of the file if the node is a BaseFileNode. Otherwise the value of this parameter will be zero.

---

Property Documentation

string Simias::Client::Event::NodeEventArgs::Source [get]

Gets the string that represents the source of the event.

string Simias::Client::Event::NodeEventArgs::ID [get]

Gets the ID of the affected Node/Collection.

string Simias::Client::Event::NodeEventArgs::Collection [get]

Gets the containing collection ID.

string Simias::Client::Event::NodeEventArgs::Modifier [get]

Gets the ID of the user that modified the node.

string Simias::Client::Event::NodeEventArgs::Type [get]

Gets the Type of the affected Node.

int Simias::Client::Event::NodeEventArgs::EventId [get]

Gets a Sets an event ID. Usually 0. Used by a publisher. Can be used to detect circular events.

string Simias::Client::Event::NodeEventArgs::Node [get]

Gets the Node ID.

ushort Simias::Client::Event::NodeEventArgs::Flags [get, set]

Gets or sets the flags.

bool Simias::Client::Event::NodeEventArgs::LocalOnly [get, set]

Gets or sets if the event refers to local only changes.

ulong Simias::Client::Event::NodeEventArgs::MasterRev [get]

Gets the master revision for the node.

ulong Simias::Client::Event::NodeEventArgs::SlaveRev [get]

Gets the slave revision for the node.

long Simias::Client::Event::NodeEventArgs::FileSize [get]

Gets the file size for the node. If the node is not a file type, zero is returned.

EventType Simias::Client::Event::NodeEventArgs::EventType [get]

Gets the type of event that occurred.

---

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

• src/core/SimiasClient/NodeEventArgs.cs