Inheritance diagram for OpenSim.Services.Connectors.XInventoryServicesConnector:

Collaboration diagram for OpenSim.Services.Connectors.XInventoryServicesConnector:

Public Member Functions
	XInventoryServicesConnector ()

	XInventoryServicesConnector (string serverURI)

	XInventoryServicesConnector (IConfigSource source)

virtual void	Initialise (IConfigSource source)

bool	CreateUserInventory (UUID principalID)
	Create the entire inventory for a given user More...

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

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

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

InventoryCollection	GetFolderContent (UUID principalID, 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 principalID, 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 principalID, 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 principalID, List< InventoryItemBase > items)

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

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

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

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

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

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

Public Member Functions inherited from OpenSim.Services.Connectors.BaseServiceConnector
	BaseServiceConnector ()

	BaseServiceConnector (IConfigSource config, string section)

void	Initialise (IConfigSource config, string section)

Properties
int	RequestsMade `[get, set]`
	Number of requests made to the remote inventory service. More...

Additional Inherited Members
Protected Attributes inherited from OpenSim.Services.Connectors.BaseServiceConnector
IServiceAuth	m_Auth

Detailed Description

Definition at line 44 of file XInventoryServicesConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.XInventoryServicesConnector.XInventoryServicesConnector ( )

inline

Definition at line 68 of file XInventoryServicesConnector.cs.

OpenSim.Services.Connectors.XInventoryServicesConnector.XInventoryServicesConnector ( string serverURI )

inline

Definition at line 72 of file XInventoryServicesConnector.cs.

OpenSim.Services.Connectors.XInventoryServicesConnector.XInventoryServicesConnector ( IConfigSource source )

inline

Definition at line 77 of file XInventoryServicesConnector.cs.

Member Function Documentation

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 344 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 412 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.CreateUserInventory ( UUID user )

inline

Create the entire inventory for a given user

Parameters

user

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 142 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 386 of file XInventoryServicesConnector.cs.

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

List<InventoryItemBase> OpenSim.Services.Connectors.XInventoryServicesConnector.GetActiveGestures ( UUID userId )

inline

Get the active gestures of the agent.

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 638 of file XInventoryServicesConnector.cs.

int OpenSim.Services.Connectors.XInventoryServicesConnector.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 656 of file XInventoryServicesConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.XInventoryServicesConnector.GetFolder ( InventoryFolderBase folder )

inline

Get a folder, given by its UUID

Parameters

folder

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 616 of file XInventoryServicesConnector.cs.

InventoryCollection OpenSim.Services.Connectors.XInventoryServicesConnector.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 206 of file XInventoryServicesConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.XInventoryServicesConnector.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 192 of file XInventoryServicesConnector.cs.

List<InventoryItemBase> OpenSim.Services.Connectors.XInventoryServicesConnector.GetFolderItems	(	UUID	userID,
		UUID	folderID
	)

inline

Gets the items inside a folder

Parameters

userID
folderID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 325 of file XInventoryServicesConnector.cs.

List<InventoryFolderBase> OpenSim.Services.Connectors.XInventoryServicesConnector.GetInventorySkeleton ( UUID userId )

inline

Gets the skeleton of the inventory – folders only

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 152 of file XInventoryServicesConnector.cs.

InventoryItemBase OpenSim.Services.Connectors.XInventoryServicesConnector.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 523 of file XInventoryServicesConnector.cs.

virtual InventoryCollection [] OpenSim.Services.Connectors.XInventoryServicesConnector.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 244 of file XInventoryServicesConnector.cs.

virtual InventoryItemBase [] OpenSim.Services.Connectors.XInventoryServicesConnector.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 553 of file XInventoryServicesConnector.cs.

InventoryFolderBase OpenSim.Services.Connectors.XInventoryServicesConnector.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 179 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.HasInventoryForUser ( UUID userID )

inline

Does the given user have an inventory structure?

Parameters

userID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 682 of file XInventoryServicesConnector.cs.

virtual void OpenSim.Services.Connectors.XInventoryServicesConnector.Initialise ( IConfigSource source )

inlinevirtual

Definition at line 83 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 374 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.MoveItems	(	UUID	principalID,
		List< InventoryItemBase >	items
	)

inline

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 486 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 402 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 359 of file XInventoryServicesConnector.cs.

bool OpenSim.Services.Connectors.XInventoryServicesConnector.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 448 of file XInventoryServicesConnector.cs.

Property Documentation

int OpenSim.Services.Connectors.XInventoryServicesConnector.RequestsMade

getset

Number of requests made to the remote inventory service.

Definition at line 53 of file XInventoryServicesConnector.cs.

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

Services/Connectors/Inventory/XInventoryServicesConnector.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation