Inheritance diagram for OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule:

Public Member Functions
bool	DearchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream)
	Dearchive a user's inventory folder from the given stream More...

bool	DearchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream, Dictionary< string, object > options)
	Dearchive a user's inventory folder from the given stream More...

bool	ArchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream)
	Archive a user's inventory folder to the given stream More...

bool	ArchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream, Dictionary< string, object > options)
	Archive a user's inventory folder to the given stream More...

Events
InventoryArchiveSaved	OnInventoryArchiveSaved
	Fired when an archive inventory save has been completed. More...

InventoryArchiveLoaded	OnInventoryArchiveLoaded
	Fired when an archive inventory load has been completed. More...

Detailed Description

Member Function Documentation

bool OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.ArchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	saveStream
	)

Archive a user's inventory folder to the given stream

Parameters

id	ID representing this request. This will later be returned in the save event
firstName
lastName
invPath	The inventory path from which the inventory should be saved.
saveStream	The stream to which the inventory archive will be saved

Returns: true if the first stage of the operation succeeded, false otherwise

bool OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.ArchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	saveStream,
		Dictionary< string, object >	options
	)

Archive a user's inventory folder to the given stream

Parameters

id	ID representing this request. This will later be returned in the save event
firstName
lastName
invPath	The inventory path from which the inventory should be saved.
saveStream	The stream to which the inventory archive will be saved
options	Archiving options. Currently, there are none.

Returns: true if the first stage of the operation succeeded, false otherwise

bool OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.DearchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	loadStream
	)

Dearchive a user's inventory folder from the given stream

Parameters

firstName
lastName
invPath	The inventory path in which to place the loaded folders and items
loadStream	The stream from which the inventory archive will be loaded

Returns: true if the first stage of the operation succeeded, false otherwise

bool OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.DearchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	loadStream,
		Dictionary< string, object >	options
	)

Dearchive a user's inventory folder from the given stream

Parameters

firstName
lastName
invPath	The inventory path in which to place the loaded folders and items
loadStream	The stream from which the inventory archive will be loaded
options	Dearchiving options. At the moment, the only option is ("merge", true). This merges the loaded IAR with existing folders where possible.

Returns: true if the first stage of the operation succeeded, false otherwise

InventoryArchiveLoaded OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.OnInventoryArchiveLoaded

Fired when an archive inventory load has been completed.

InventoryArchiveSaved OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.OnInventoryArchiveSaved

Fired when an archive inventory save has been completed.

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