Inheritance diagram for OpenSim.Services.Interfaces.IInventoryService:

Public Member Functions
bool	CreateUserInventory (UUID user)
	Create the entire inventory for a given user More...

List< InventoryFolderBase >	GetInventorySkeleton (UUID userId)
	Gets the skeleton of the inventory – folders only More...

InventoryFolderBase	GetRootFolder (UUID userID)
	Retrieve the root inventory folder for the given user. More...

InventoryFolderBase	GetFolderForType (UUID userID, FolderType type)
	Gets the user folder for the given folder-type More...

InventoryCollection	GetFolderContent (UUID userID, UUID folderID)
	Gets everything (folders and items) inside a folder More...

InventoryCollection[]	GetMultipleFoldersContent (UUID userID, UUID[] folderIDs)
	Gets everything (folders and items) inside a folder More...

List< InventoryItemBase >	GetFolderItems (UUID userID, UUID folderID)
	Gets the items inside a folder More...

bool	AddFolder (InventoryFolderBase folder)
	Add a new folder to the user's inventory More...

bool	UpdateFolder (InventoryFolderBase folder)
	Update a folder in the user's inventory More...

bool	MoveFolder (InventoryFolderBase folder)
	Move an inventory folder to a new location More...

bool	DeleteFolders (UUID userID, List< UUID > folderIDs)
	Delete an item from the user's inventory More...

bool	PurgeFolder (InventoryFolderBase folder)
	Purge an inventory folder of all its items and subfolders. More...

bool	AddItem (InventoryItemBase item)
	Add a new item to the user's inventory More...

bool	UpdateItem (InventoryItemBase item)
	Update an item in the user's inventory More...

bool	MoveItems (UUID ownerID, List< InventoryItemBase > items)

bool	DeleteItems (UUID userID, List< UUID > itemIDs)
	Delete an item from the user's inventory More...

InventoryItemBase	GetItem (InventoryItemBase item)
	Get an item, given by its UUID More...

InventoryItemBase[]	GetMultipleItems (UUID userID, UUID[] ids)
	Get multiple items, given by their UUIDs More...

InventoryFolderBase	GetFolder (InventoryFolderBase folder)
	Get a folder, given by its UUID More...

bool	HasInventoryForUser (UUID userID)
	Does the given user have an inventory structure? More...

List< InventoryItemBase >	GetActiveGestures (UUID userId)
	Get the active gestures of the agent. More...

int	GetAssetPermissions (UUID userID, UUID assetID)
	Get the union of permissions of all inventory items that hold the given assetID. More...

Detailed Description

Definition at line 41 of file IInventoryService.cs.

Member Function Documentation

bool OpenSim.Services.Interfaces.IInventoryService.AddFolder ( InventoryFolderBase folder )

Add a new folder to the user's inventory

Parameters

folder

Returns: true if the folder was successfully added

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.AddItem ( InventoryItemBase item )

Add a new item to the user's inventory

Parameters

item	The item to be added. If item.FolderID == UUID.Zero then the item is added to the most suitable system folder. If there is no suitable folder then the item is added to the user's root inventory folder.

Returns: true if the item was successfully added, false if it was not

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.CreateUserInventory ( UUID user )

Create the entire inventory for a given user

Parameters

user

Returns

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Services.InventoryService.XInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.DeleteFolders	(	UUID	userID,
		List< UUID >	folderIDs
	)

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Services.HypergridService.HGInventoryService, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.DeleteItems	(	UUID	userID,
		List< UUID >	itemIDs
	)

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

List<InventoryItemBase> OpenSim.Services.Interfaces.IInventoryService.GetActiveGestures ( UUID userId )

Get the active gestures of the agent.

Parameters

userId

Returns

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

int OpenSim.Services.Interfaces.IInventoryService.GetAssetPermissions	(	UUID	userID,
		UUID	assetID
	)

Get the union of permissions of all inventory items that hold the given assetID.

Parameters

userID
assetID

Returns: The permissions or 0 if no such asset is found in the user's inventory

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryFolderBase OpenSim.Services.Interfaces.IInventoryService.GetFolder ( InventoryFolderBase folder )

Get a folder, given by its UUID

Parameters

folder

Returns

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryCollection OpenSim.Services.Interfaces.IInventoryService.GetFolderContent	(	UUID	userID,
		UUID	folderID
	)

Gets everything (folders and items) inside a folder

Parameters

userId
folderID

Returns: Inventory content. null if the request failed.

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryFolderBase OpenSim.Services.Interfaces.IInventoryService.GetFolderForType	(	UUID	userID,
		FolderType	type
	)

Gets the user folder for the given folder-type

Parameters

userID
type

Returns

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, and OpenSim.Services.HypergridService.HGInventoryService.

List<InventoryItemBase> OpenSim.Services.Interfaces.IInventoryService.GetFolderItems	(	UUID	userID,
		UUID	folderID
	)

Gets the items inside a folder

Parameters

userID
folderID

Returns

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

List<InventoryFolderBase> OpenSim.Services.Interfaces.IInventoryService.GetInventorySkeleton ( UUID userId )

Gets the skeleton of the inventory – folders only

Parameters

userId

Returns

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

InventoryItemBase OpenSim.Services.Interfaces.IInventoryService.GetItem ( InventoryItemBase item )

Get an item, given by its UUID

Parameters

item

Returns: null if no item was found, otherwise the found item

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Services.HypergridService.HGInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryCollection [] OpenSim.Services.Interfaces.IInventoryService.GetMultipleFoldersContent	(	UUID	userID,
		UUID[]	folderIDs
	)

Gets everything (folders and items) inside a folder

Parameters

userId
folderIDs

Returns: Inventory content.

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Services.HypergridService.HGInventoryService, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryItemBase [] OpenSim.Services.Interfaces.IInventoryService.GetMultipleItems	(	UUID	userID,
		UUID[]	ids
	)

Get multiple items, given by their UUIDs

Parameters

item

Returns: null if no item was found, otherwise the found item

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

InventoryFolderBase OpenSim.Services.Interfaces.IInventoryService.GetRootFolder ( UUID userID )

Retrieve the root inventory folder for the given user.

Parameters

userID

Returns: null if no root folder was found

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Services.HypergridService.HGInventoryService, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.HasInventoryForUser ( UUID userID )

Does the given user have an inventory structure?

Parameters

userID

Returns

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.MoveFolder ( InventoryFolderBase folder )

Move an inventory folder to a new location

Parameters

folder A folder containing the details of the new location

Returns: true if the folder was successfully moved

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.MoveItems	(	UUID	ownerID,
		List< InventoryItemBase >	items
	)

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.PurgeFolder ( InventoryFolderBase folder )

Purge an inventory folder of all its items and subfolders.

Parameters

folder

Returns: true if the folder was successfully purged

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, OpenSim.Services.HypergridService.HGInventoryService, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.UpdateFolder ( InventoryFolderBase folder )

Update a folder in the user's inventory

Parameters

folder

Returns: true if the folder was successfully updated

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

bool OpenSim.Services.Interfaces.IInventoryService.UpdateItem ( InventoryItemBase item )

Update an item in the user's inventory

Parameters

item

Returns: true if the item was successfully updated

Implemented in OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.HGInventoryBroker, OpenSim.Services.InventoryService.XInventoryService, OpenSim.Services.Connectors.XInventoryServicesConnector, OpenSim.Services.HypergridService.HGSuitcaseInventoryService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.RemoteXInventoryServicesConnector, and OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.

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

Services/Interfaces/IInventoryService.cs

Public Member Functions

Detailed Description

Member Function Documentation