diff options
Diffstat (limited to 'OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs')
-rw-r--r-- | OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs b/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs new file mode 100644 index 0000000..4fc4363 --- /dev/null +++ b/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs | |||
@@ -0,0 +1,107 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using OpenSim.Framework; | ||
29 | using OpenSim.Services.Interfaces; | ||
30 | using OpenMetaverse; | ||
31 | |||
32 | namespace OpenSim.Services.Connectors | ||
33 | { | ||
34 | /// <summary> | ||
35 | /// Defines all operations to access a remote inventory service | ||
36 | /// using session authentication as a form of security. | ||
37 | /// </summary> | ||
38 | public interface ISessionAuthInventoryService | ||
39 | { | ||
40 | string Host | ||
41 | { | ||
42 | get; | ||
43 | } | ||
44 | |||
45 | /// <summary> | ||
46 | /// Request the inventory for a user. This is an asynchronous operation that will call the callback when the | ||
47 | /// inventory has been received | ||
48 | /// </summary> | ||
49 | /// <param name="userID"></param> | ||
50 | /// <param name="callback"></param> | ||
51 | void GetUserInventory(string userID, UUID session_id, InventoryReceiptCallback callback); | ||
52 | |||
53 | /// <summary> | ||
54 | /// Add a new folder to the user's inventory | ||
55 | /// </summary> | ||
56 | /// <param name="folder"></param> | ||
57 | /// <returns>true if the folder was successfully added</returns> | ||
58 | bool AddFolder(string userID, InventoryFolderBase folder, UUID session_id); | ||
59 | |||
60 | /// <summary> | ||
61 | /// Update a folder in the user's inventory | ||
62 | /// </summary> | ||
63 | /// <param name="folder"></param> | ||
64 | /// <returns>true if the folder was successfully updated</returns> | ||
65 | bool UpdateFolder(string userID, InventoryFolderBase folder, UUID session_id); | ||
66 | |||
67 | /// <summary> | ||
68 | /// Move an inventory folder to a new location | ||
69 | /// </summary> | ||
70 | /// <param name="folder">A folder containing the details of the new location</param> | ||
71 | /// <returns>true if the folder was successfully moved</returns> | ||
72 | bool MoveFolder(string userID, InventoryFolderBase folder, UUID session_id); | ||
73 | |||
74 | /// <summary> | ||
75 | /// Purge an inventory folder of all its items and subfolders. | ||
76 | /// </summary> | ||
77 | /// <param name="folder"></param> | ||
78 | /// <returns>true if the folder was successfully purged</returns> | ||
79 | bool PurgeFolder(string userID, InventoryFolderBase folder, UUID session_id); | ||
80 | |||
81 | /// <summary> | ||
82 | /// Add a new item to the user's inventory | ||
83 | /// </summary> | ||
84 | /// <param name="item"></param> | ||
85 | /// <returns>true if the item was successfully added</returns> | ||
86 | bool AddItem(string userID, InventoryItemBase item, UUID session_id); | ||
87 | |||
88 | /// <summary> | ||
89 | /// Update an item in the user's inventory | ||
90 | /// </summary> | ||
91 | /// <param name="item"></param> | ||
92 | /// <returns>true if the item was successfully updated</returns> | ||
93 | bool UpdateItem(string userID, InventoryItemBase item, UUID session_id); | ||
94 | |||
95 | /// <summary> | ||
96 | /// Delete an item from the user's inventory | ||
97 | /// </summary> | ||
98 | /// <param name="item"></param> | ||
99 | /// <returns>true if the item was successfully deleted</returns> | ||
100 | bool DeleteItem(string userID, InventoryItemBase item, UUID session_id); | ||
101 | |||
102 | InventoryItemBase QueryItem(string userID, InventoryItemBase item, UUID session_id); | ||
103 | |||
104 | InventoryFolderBase QueryFolder(string userID, InventoryFolderBase item, UUID session_id); | ||
105 | |||
106 | } | ||
107 | } | ||