OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector Class Reference

Permissions bitflags More...

Inheritance diagram for OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector:
Collaboration graph
[legend]

Public Member Functions

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...
 
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...
 
 SimianInventoryServiceConnector ()
 
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...
 
 SimianInventoryServiceConnector (IConfigSource source)
 
 SimianInventoryServiceConnector (string url)
 
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...
 
bool CreateUserInventory (UUID userID)
 Create the entire inventory for a given user More...
 
List< InventoryFolderBaseGetInventorySkeleton (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...
 
InventoryItemBase GetItem (InventoryItemBase item)
 Get an item, given by its UUID More...
 
InventoryItemBase[] GetMultipleItems (UUID principalID, UUID[] itemIDs)
 Get multiple items, given by their UUIDs More...
 
InventoryFolderBase GetFolder (InventoryFolderBase folder)
 Get a folder, given by its UUID 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< InventoryItemBaseGetFolderItems (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 DeleteItems (UUID userID, List< UUID > itemIDs)
 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 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...
 

Properties

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

Permissions bitflags

Connects avatar inventories to the SimianGrid backend

Definition at line 66 of file SimianInventoryServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.SimianInventoryServiceConnector ( )
inline

Definition at line 87 of file SimianInventoryServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.SimianInventoryServiceConnector ( IConfigSource  source)
inline

Definition at line 94 of file SimianInventoryServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.SimianInventoryServiceConnector ( string  url)
inline

Definition at line 99 of file SimianInventoryServiceConnector.cs.

Member Function Documentation

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 457 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 578 of file SimianInventoryServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 89 of file SimianInventoryServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 85 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.CreateUserInventory ( UUID  userID)
inline

Create the entire inventory for a given user

Parameters
user
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 159 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 507 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 517 of file SimianInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.GetActiveGestures ( UUID  userID)
inline

Get the active gestures of the agent.

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 714 of file SimianInventoryServiceConnector.cs.

int OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 741 of file SimianInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.GetFolder ( InventoryFolderBase  folder)
inline

Get a folder, given by its UUID

Parameters
folder
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 340 of file SimianInventoryServiceConnector.cs.

InventoryCollection OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 371 of file SimianInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 243 of file SimianInventoryServiceConnector.cs.

List<InventoryItemBase> OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.GetFolderItems ( UUID  userID,
UUID  folderID 
)
inline

Gets the items inside a folder

Parameters
userID
folderID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 423 of file SimianInventoryServiceConnector.cs.

List<InventoryFolderBase> OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.GetInventorySkeleton ( UUID  userID)
inline

Gets the skeleton of the inventory – folders only

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 181 of file SimianInventoryServiceConnector.cs.

InventoryItemBase OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.GetItem ( InventoryItemBase  item)
inline

Get an item, given by its UUID

Parameters
item
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 280 of file SimianInventoryServiceConnector.cs.

virtual InventoryCollection [] OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 405 of file SimianInventoryServiceConnector.cs.

InventoryItemBase [] OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 320 of file SimianInventoryServiceConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 212 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.HasInventoryForUser ( UUID  userID)
inline

Does the given user have an inventory structure?

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 704 of file SimianInventoryServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 110 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 496 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.MoveItems ( UUID  ownerID,
List< InventoryItemBase items 
)
inline
void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 84 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 552 of file SimianInventoryServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 83 of file SimianInventoryServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 90 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 486 of file SimianInventoryServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.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 657 of file SimianInventoryServiceConnector.cs.

Property Documentation

string OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.Name
get

Definition at line 88 of file SimianInventoryServiceConnector.cs.

Type OpenSim.Services.Connectors.SimianGrid.SimianInventoryServiceConnector.ReplaceableInterface
get

Definition at line 82 of file SimianInventoryServiceConnector.cs.


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