Simias::Client::Event::FileSyncEventArgs Class Reference

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

Inheritance diagram for Simias::Client::Event::FileSyncEventArgs:

[legend]

Collaboration diagram for Simias::Client::Event::FileSyncEventArgs:

[legend]

List of all members.

Public Member Functions
	FileSyncEventArgs (string name, long size, long sizeToSync, long sizeRemaining, Direction direction, SyncStatus status)
	Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.
	FileSyncEventArgs (string collectionID, ObjectType objectType, bool delete, string name, long size, long sizeToSync, long sizeRemaining, Direction direction)
	Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.
	FileSyncEventArgs (string collectionID, ObjectType objectType, bool delete, string name, long size, long sizeToSync, long sizeRemaining, Direction direction, SyncStatus status)
	Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.
Properties
string	CollectionID [get]
	Gets the ID of the collection that the sync event belongs to.
ObjectType	ObjectType [get]
	Gets the type of object being synced.
bool	Delete [get]
	Gets a value that indicates if the sync operation is a delete.
string	Name [get]
	Gets the name of the file that the event belongs to.
long	Size [get]
	Gets the size of the file that the event belongs to.
long	SizeToSync [get]
	Gets the total amount of data to be synced.
long	SizeRemaining [get]
	Gets the amount of data that still needs to be synced.
Direction	Direction [get]
	Gets the direction of the sync.
SyncStatus	Status [get]
	Gets the status of the sync.

---

Detailed Description

The arguments for a file sync event.

---

Constructor & Destructor Documentation

Simias::Client::Event::FileSyncEventArgs::FileSyncEventArgs	(	string	name,
		long	size,
		long	sizeToSync,
		long	sizeRemaining,
		Direction	direction,
		SyncStatus	status
	)			[inline]

Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.

Parameters:

	name	The name of the file that the event belongs to.
	size	The size of the file that the event belongs to.
	sizeToSync	The total amount of data to be synced.
	sizeRemaining	The amount of data that still needs to be synced.
	direction	The direction of the sync.

Simias::Client::Event::FileSyncEventArgs::FileSyncEventArgs	(	string	collectionID,
		ObjectType	objectType,
		bool	delete,
		string	name,
		long	size,
		long	sizeToSync,
		long	sizeRemaining,
		Direction	direction
	)			[inline]

Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.

Parameters:

	collectionID	The ID of the collection that the sync event belongs to.
	objectType	The type of object being synced.
	delete	Set to true if the synced object is being deleted.
	name	The name of the file that the event belongs to.
	size	The size of the file that the event belongs to.
	sizeToSync	The total amount of data to be synced.
	sizeRemaining	The amount of data that still needs to be synced.
	direction	The direction of the sync.

Simias::Client::Event::FileSyncEventArgs::FileSyncEventArgs	(	string	collectionID,
		ObjectType	objectType,
		bool	delete,
		string	name,
		long	size,
		long	sizeToSync,
		long	sizeRemaining,
		Direction	direction,
		SyncStatus	status
	)			[inline]

Constructs a FileSyncEventArgs that will be used by FileSyncHandler delegates.

Parameters:

	collectionID	The ID of the collection that the sync event belongs to.
	objectType	The type of object being synced.
	delete	Set to true if the synced object is being deleted.
	name	The name of the file that the event belongs to.
	size	The size of the file that the event belongs to.
	sizeToSync	The total amount of data to be synced.
	sizeRemaining	The amount of data that still needs to be synced.
	direction	The direction of the sync.
	status	The status of the sync.

---

Property Documentation

string Simias::Client::Event::FileSyncEventArgs::CollectionID [get]

Gets the ID of the collection that the sync event belongs to.

ObjectType Simias::Client::Event::FileSyncEventArgs::ObjectType [get]

Gets the type of object being synced.

bool Simias::Client::Event::FileSyncEventArgs::Delete [get]

Gets a value that indicates if the sync operation is a delete.

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

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

long Simias::Client::Event::FileSyncEventArgs::Size [get]

Gets the size of the file that the event belongs to.

long Simias::Client::Event::FileSyncEventArgs::SizeToSync [get]

Gets the total amount of data to be synced.

long Simias::Client::Event::FileSyncEventArgs::SizeRemaining [get]

Gets the amount of data that still needs to be synced.

Direction Simias::Client::Event::FileSyncEventArgs::Direction [get]

Gets the direction of the sync.

SyncStatus Simias::Client::Event::FileSyncEventArgs::Status [get]

Gets the status of the sync.

---

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

• src/core/SimiasClient/FileSyncEventArgs.cs