Inheritance diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector:

Collaboration diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector:

Public Member Functions
void	Initialise (IConfigSource source)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

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...

virtual InventoryCollection[]	GetMultipleFoldersContent (UUID principalID, 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 ownerID, 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 ownerID, 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[] itemIDs)
	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...

Properties
Scene	Scene `[get, set]`
	Scene used by this module. This currently needs to be publicly settable for HGInventoryBroker. More...

Type	ReplaceableInterface `[get]`

string	Name `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Detailed Description

Definition at line 47 of file LocalInventoryServiceConnector.cs.

Member Function Documentation

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.AddFolder ( InventoryFolderBase folder )

inline

Add a new folder to the user's inventory

Parameters

folder

Returns: true if the folder was successfully added

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 221 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.AddItem ( InventoryItemBase item )

inline

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

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 261 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 133 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 129 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.CreateUserInventory ( UUID user )

inline

Create the entire inventory for a given user

Parameters

user

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 158 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.DeleteFolders	(	UUID	userID,
		List< UUID >	folderIDs
	)

inline

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 246 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.DeleteItems	(	UUID	ownerID,
		List< UUID >	itemIDs
	)

inline

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 290 of file LocalInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetActiveGestures ( UUID userId )

inline

Get the active gestures of the agent.

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 330 of file LocalInventoryServiceConnector.cs.

int OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetAssetPermissions	(	UUID	userID,
		UUID	assetID
	)

inline

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

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 335 of file LocalInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetFolder ( InventoryFolderBase folder )

inline

Get a folder, given by its UUID

Parameters

folder

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 315 of file LocalInventoryServiceConnector.cs.

InventoryCollection OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetFolderContent	(	UUID	userID,
		UUID	folderID
	)

inline

Gets everything (folders and items) inside a folder

Parameters

userId
folderID

Returns: Inventory content. null if the request failed.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 178 of file LocalInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetFolderForType	(	UUID	userID,
		FolderType	type
	)

inline

Gets the user folder for the given folder-type

Parameters

userID
type

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 173 of file LocalInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetFolderItems	(	UUID	userID,
		UUID	folderID
	)

inline

Gets the items inside a folder

Parameters

userID
folderID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 211 of file LocalInventoryServiceConnector.cs.

List<InventoryFolderBase> OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetInventorySkeleton ( UUID userId )

inline

Gets the skeleton of the inventory – folders only

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 163 of file LocalInventoryServiceConnector.cs.

InventoryItemBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetItem ( InventoryItemBase item )

inline

Get an item, given by its UUID

Parameters

item

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

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 295 of file LocalInventoryServiceConnector.cs.

virtual InventoryCollection [] OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetMultipleFoldersContent	(	UUID	userID,
		UUID[]	folderIDs
	)

inlinevirtual

Gets everything (folders and items) inside a folder

Parameters

userId
folderIDs

Returns: Inventory content.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 198 of file LocalInventoryServiceConnector.cs.

InventoryItemBase [] OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetMultipleItems	(	UUID	userID,
		UUID[]	ids
	)

inline

Get multiple items, given by their UUIDs

Parameters

item

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

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 310 of file LocalInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.GetRootFolder ( UUID userID )

inline

Retrieve the root inventory folder for the given user.

Parameters

userID

Returns: null if no root folder was found

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 168 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.HasInventoryForUser ( UUID userID )

inline

Does the given user have an inventory structure?

Parameters

userID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 325 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 85 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.MoveFolder ( InventoryFolderBase folder )

inline

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

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 241 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.MoveItems	(	UUID	ownerID,
		List< InventoryItemBase >	items
	)

inline

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 280 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.PostInitialise ( )

inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 125 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.PurgeFolder ( InventoryFolderBase folder )

inline

Purge an inventory folder of all its items and subfolders.

Parameters

folder

Returns: true if the folder was successfully purged

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 256 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 150 of file LocalInventoryServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 144 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.UpdateFolder ( InventoryFolderBase folder )

inline

Update a folder in the user's inventory

Parameters

folder

Returns: true if the folder was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 231 of file LocalInventoryServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.UpdateItem ( InventoryItemBase item )

inline

Update an item in the user's inventory

Parameters

item

Returns: true if the item was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 275 of file LocalInventoryServiceConnector.cs.

Property Documentation

string OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.Name

get

Definition at line 81 of file LocalInventoryServiceConnector.cs.

Type OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.ReplaceableInterface

get

Definition at line 76 of file LocalInventoryServiceConnector.cs.

Scene OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory.LocalInventoryServicesConnector.Scene

getset

Scene used by this module. This currently needs to be publicly settable for HGInventoryBroker.

Definition at line 56 of file LocalInventoryServiceConnector.cs.

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

Region/CoreModules/ServiceConnectorsOut/Inventory/LocalInventoryServiceConnector.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation