diff options
author | Justin Clarke Casey | 2008-02-11 20:10:44 +0000 |
---|---|---|
committer | Justin Clarke Casey | 2008-02-11 20:10:44 +0000 |
commit | c80c6e977414196fe7b855e885a5872ce5c24821 (patch) | |
tree | ec6ce0b46d57ff610ca311b18574ebb5bcd8251a /OpenSim/Framework/Communications/IInventoryServices.cs | |
parent | Moved share/sql/mysql-AvatarAppearance.sql to OpenSim/Framework/Data.MySQL/Re... (diff) | |
download | opensim-SC_OLD-c80c6e977414196fe7b855e885a5872ce5c24821.zip opensim-SC_OLD-c80c6e977414196fe7b855e885a5872ce5c24821.tar.gz opensim-SC_OLD-c80c6e977414196fe7b855e885a5872ce5c24821.tar.bz2 opensim-SC_OLD-c80c6e977414196fe7b855e885a5872ce5c24821.tar.xz |
Documenting and minor tweaks
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/Communications/IInventoryServices.cs | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/OpenSim/Framework/Communications/IInventoryServices.cs b/OpenSim/Framework/Communications/IInventoryServices.cs index 15a2f02..ddb19ba 100644 --- a/OpenSim/Framework/Communications/IInventoryServices.cs +++ b/OpenSim/Framework/Communications/IInventoryServices.cs | |||
@@ -36,19 +36,54 @@ namespace OpenSim.Framework.Communications | |||
36 | 36 | ||
37 | public delegate void InventoryItemInfo(LLUUID userID, InventoryItemBase itemInfo); | 37 | public delegate void InventoryItemInfo(LLUUID userID, InventoryItemBase itemInfo); |
38 | 38 | ||
39 | /// <summary> | ||
40 | /// Defines all the operations one can perform on a user's inventory. | ||
41 | /// </summary> | ||
39 | public interface IInventoryServices | 42 | public interface IInventoryServices |
40 | { | 43 | { |
41 | void RequestInventoryForUser(LLUUID userID, InventoryFolderInfo folderCallBack, InventoryItemInfo itemCallBack); | 44 | void RequestInventoryForUser(LLUUID userID, InventoryFolderInfo folderCallBack, InventoryItemInfo itemCallBack); |
45 | |||
46 | /// <summary> | ||
47 | /// Add a new folder to the given user's inventory | ||
48 | /// </summary> | ||
49 | /// <param name="userID"></param> | ||
50 | /// <param name="folder"></param> | ||
42 | void AddNewInventoryFolder(LLUUID userID, InventoryFolderBase folder); | 51 | void AddNewInventoryFolder(LLUUID userID, InventoryFolderBase folder); |
52 | |||
43 | void MoveInventoryFolder(LLUUID userID, InventoryFolderBase folder); | 53 | void MoveInventoryFolder(LLUUID userID, InventoryFolderBase folder); |
54 | |||
55 | /// <summary> | ||
56 | /// Add a new item to the given user's inventory | ||
57 | /// </summary> | ||
58 | /// <param name="userID"></param> | ||
59 | /// <param name="item"></param> | ||
44 | void AddNewInventoryItem(LLUUID userID, InventoryItemBase item); | 60 | void AddNewInventoryItem(LLUUID userID, InventoryItemBase item); |
61 | |||
62 | /// <summary> | ||
63 | /// Delete an item from the given user's inventory | ||
64 | /// </summary> | ||
65 | /// <param name="userID"></param> | ||
66 | /// <param name="item"></param> | ||
45 | void DeleteInventoryItem(LLUUID userID, InventoryItemBase item); | 67 | void DeleteInventoryItem(LLUUID userID, InventoryItemBase item); |
68 | |||
69 | /// <summary> | ||
70 | /// Create a new inventory for the given user | ||
71 | /// </summary> | ||
72 | /// <param name="user"></param> | ||
46 | void CreateNewUserInventory(LLUUID user); | 73 | void CreateNewUserInventory(LLUUID user); |
74 | |||
47 | bool HasInventoryForUser(LLUUID userID); | 75 | bool HasInventoryForUser(LLUUID userID); |
76 | |||
77 | /// <summary> | ||
78 | /// Retrieve the root inventory folder for the given user. | ||
79 | /// </summary> | ||
80 | /// <param name="userID"></param> | ||
81 | /// <returns>null if no root folder was found</returns> | ||
48 | InventoryFolderBase RequestRootFolder(LLUUID userID); | 82 | InventoryFolderBase RequestRootFolder(LLUUID userID); |
49 | 83 | ||
50 | /// <summary> | 84 | /// <summary> |
51 | /// Returns the root folder plus any folders in root (so down one level in the Inventory folders tree) | 85 | /// Returns the root folder plus any folders in root (so down one level in the Inventory folders tree) |
86 | /// for the given user. | ||
52 | /// </summary> | 87 | /// </summary> |
53 | /// <param name="userID"></param> | 88 | /// <param name="userID"></param> |
54 | /// <returns></returns> | 89 | /// <returns></returns> |