OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService:
Collaboration graph
[legend]

Public Member Functions

 LocalInventoryService (InventoryFolderImpl lib)
 
InventoryFolderBase GetRootFolder (UUID userID)
 Retrieve the root inventory folder for the given user. 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...
 
virtual InventoryItemBase[] GetMultipleItems (UUID principalID, UUID[] itemIDs)
 Get multiple items, given by their UUIDs More...
 
bool AddFolder (InventoryFolderBase folder)
 Add a new folder to the user's inventory More...
 
bool AddItem (InventoryItemBase item)
 Add a new item to the user's inventory More...
 
bool CreateUserInventory (UUID user)
 Create the entire inventory for a given user More...
 
List< InventoryFolderBaseGetInventorySkeleton (UUID userId)
 Gets the skeleton of the inventory – folders only More...
 
InventoryFolderBase GetFolderForType (UUID userID, FolderType type)
 Gets the user folder for the given folder-type More...
 
List< InventoryItemBaseGetFolderItems (UUID userID, UUID folderID)
 Gets the items inside a folder 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 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...
 
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< InventoryItemBaseGetActiveGestures (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 40 of file LocalInventoryService.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.LocalInventoryService ( InventoryFolderImpl  lib)
inline

Definition at line 46 of file LocalInventoryService.cs.

Member Function Documentation

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 123 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.AddItem ( InventoryItemBase  item)
inline

Add a new item to the user's inventory

Parameters
item
Returns
true if the item was successfully added

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 146 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.CreateUserInventory ( UUID  user)
inline

Create the entire inventory for a given user

Parameters
user
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 163 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 210 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.DeleteItems ( UUID  userID,
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 235 of file LocalInventoryService.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetActiveGestures ( UUID  userId)
inline

Get the active gestures of the agent.

Parameters
userId
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 263 of file LocalInventoryService.cs.

int OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 273 of file LocalInventoryService.cs.

InventoryFolderBase OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetFolder ( InventoryFolderBase  folder)
inline

Get a folder, given by its UUID

Parameters
folder
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 249 of file LocalInventoryService.cs.

InventoryCollection OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetFolderContent ( UUID  userID,
UUID  folderID 
)
inline

Gets everything (folders and items) inside a folder

Parameters
userId
folderID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 64 of file LocalInventoryService.cs.

InventoryFolderBase OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 178 of file LocalInventoryService.cs.

List<InventoryItemBase> OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetFolderItems ( UUID  userID,
UUID  folderID 
)
inline

Gets the items inside a folder

Parameters
userID
folderID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 187 of file LocalInventoryService.cs.

List<InventoryFolderBase> OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetInventorySkeleton ( UUID  userId)
inline

Gets the skeleton of the inventory – folders only

Parameters
userId
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 170 of file LocalInventoryService.cs.

InventoryItemBase OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetItem ( InventoryItemBase  item)
inline

Get an item, given by its UUID

Parameters
item
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 242 of file LocalInventoryService.cs.

virtual InventoryCollection [] OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 90 of file LocalInventoryService.cs.

virtual InventoryItemBase [] OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.GetMultipleItems ( UUID  userID,
UUID[]  ids 
)
inlinevirtual

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 102 of file LocalInventoryService.cs.

InventoryFolderBase OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 56 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.HasInventoryForUser ( UUID  userID)
inline

Does the given user have an inventory structure?

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 256 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.MoveFolder ( InventoryFolderBase  folder)
inline

Move an inventory folder to a new location

Parameters
folderA folder containing the details of the new location
Returns
true if the folder was successfully moved

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 202 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.MoveItems ( UUID  ownerID,
List< InventoryItemBase items 
)
inline
bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 217 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 195 of file LocalInventoryService.cs.

bool OpenSim.Region.CoreModules.Framework.Library.LocalInventoryService.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 225 of file LocalInventoryService.cs.


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