Simias::Client::Event::CollectionSyncEventArgs Class Reference

The arguments for a collection sync event. More...

Inheritance diagram for Simias::Client::Event::CollectionSyncEventArgs:

[legend]

Collaboration diagram for Simias::Client::Event::CollectionSyncEventArgs:

[legend]

List of all members.

Public Member Functions
	CollectionSyncEventArgs (string name, string id, Action action, bool connected, bool yielded)
	Constructs a CollectionSyncEventArgs that will be used by CollectionSyncHandler delegates.
Properties
string	Name [get]
	Gets the name of the collection that the event belongs to.
string	ID [get]
	Gets the id of the collection that the event belongs to.
Action	Action [get]
	Gets the sync action for the event.
bool	Connected [get]
	Gets a value indicating if the server that host the collection is available.
bool	Yielded [get]
	Gets a value indicating if the sync process yielded to allow another collection to synchronize.

---

Detailed Description

The arguments for a collection sync event.

---

Constructor & Destructor Documentation

Simias::Client::Event::CollectionSyncEventArgs::CollectionSyncEventArgs	(	string	name,
		string	id,
		Action	action,
		bool	connected,
		bool	yielded
	)			[inline]

Constructs a CollectionSyncEventArgs that will be used by CollectionSyncHandler delegates.

Parameters:

	name	The name of the collection that the event belongs to.
	id	The id of the collection that the event belongs to.
	action	The sync action for the event.
	connected	A value indicating if the server is available.
	yielded	A value indicating if the sync yielded to let other collections sync.

---

Property Documentation

string Simias::Client::Event::CollectionSyncEventArgs::Name [get]

Gets the name of the collection that the event belongs to.

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

Gets the id of the collection that the event belongs to.

Action Simias::Client::Event::CollectionSyncEventArgs::Action [get]

Gets the sync action for the event.

bool Simias::Client::Event::CollectionSyncEventArgs::Connected [get]

Gets a value indicating if the server that host the collection is available.

bool Simias::Client::Event::CollectionSyncEventArgs::Yielded [get]

Gets a value indicating if the sync process yielded to allow another collection to synchronize.

---

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

• src/core/SimiasClient/CollectionSyncEventArgs.cs