diff options
author | Justin Clark-Casey (justincc) | 2009-08-14 19:59:42 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2009-08-14 19:59:42 +0100 |
commit | a668a5b0d39f04497e5ea170e5af0e659a43febb (patch) | |
tree | d2554561dac21460bbe4830ffcd7c6a0f613e4ce /OpenSim/Services | |
parent | Remove NRE catching on TestReplicateArchivePathToUserInventory() since race f... (diff) | |
download | opensim-SC_OLD-a668a5b0d39f04497e5ea170e5af0e659a43febb.zip opensim-SC_OLD-a668a5b0d39f04497e5ea170e5af0e659a43febb.tar.gz opensim-SC_OLD-a668a5b0d39f04497e5ea170e5af0e659a43febb.tar.bz2 opensim-SC_OLD-a668a5b0d39f04497e5ea170e5af0e659a43febb.tar.xz |
Add standard doc and standard doc formatting to IAssetService
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Services/Interfaces/IAssetService.cs | 46 |
1 files changed, 37 insertions, 9 deletions
diff --git a/OpenSim/Services/Interfaces/IAssetService.cs b/OpenSim/Services/Interfaces/IAssetService.cs index ec8a71b..6dfe78d 100644 --- a/OpenSim/Services/Interfaces/IAssetService.cs +++ b/OpenSim/Services/Interfaces/IAssetService.cs | |||
@@ -34,25 +34,53 @@ namespace OpenSim.Services.Interfaces | |||
34 | 34 | ||
35 | public interface IAssetService | 35 | public interface IAssetService |
36 | { | 36 | { |
37 | // Three different ways to retrieve an asset | 37 | /// <summary> |
38 | // | 38 | /// Get an asset synchronously. |
39 | /// </summary> | ||
40 | /// <param name="id"></param> | ||
41 | /// <returns></returns> | ||
39 | AssetBase Get(string id); | 42 | AssetBase Get(string id); |
43 | |||
44 | /// <summary> | ||
45 | /// Get an asset's metadata | ||
46 | /// </summary> | ||
47 | /// <param name="id"></param> | ||
48 | /// <returns></returns> | ||
40 | AssetMetadata GetMetadata(string id); | 49 | AssetMetadata GetMetadata(string id); |
50 | |||
41 | byte[] GetData(string id); | 51 | byte[] GetData(string id); |
42 | 52 | ||
53 | /// <summary> | ||
54 | /// Get an asset asynchronously | ||
55 | /// </summary> | ||
56 | /// <param name="id">The asset id</param> | ||
57 | /// <param name="sender">Represents the requester. Passed back via the handler</param> | ||
58 | /// <param name="handler">The handler to call back once the asset has been retrieved</param> | ||
59 | /// <returns>True if the id was parseable, false otherwise</returns> | ||
43 | bool Get(string id, Object sender, AssetRetrieved handler); | 60 | bool Get(string id, Object sender, AssetRetrieved handler); |
44 | 61 | ||
45 | // Creates a new asset | 62 | /// <summary> |
46 | // Returns a random ID if none is passed into it | 63 | /// Creates a new asset |
47 | // | 64 | /// </summary> |
65 | /// Returns a random ID if none is passed into it | ||
66 | /// <param name="asset"></param> | ||
67 | /// <returns></returns> | ||
48 | string Store(AssetBase asset); | 68 | string Store(AssetBase asset); |
49 | 69 | ||
50 | // Attachments and bare scripts need this!! | 70 | /// <summary> |
51 | // | 71 | /// Update an asset's content |
72 | /// </summary> | ||
73 | /// Attachments and bare scripts need this!! | ||
74 | /// <param name="id"> </param> | ||
75 | /// <param name="data"></param> | ||
76 | /// <returns></returns> | ||
52 | bool UpdateContent(string id, byte[] data); | 77 | bool UpdateContent(string id, byte[] data); |
53 | 78 | ||
54 | // Kill an asset | 79 | /// <summary> |
55 | // | 80 | /// Delete an asset |
81 | /// </summary> | ||
82 | /// <param name="id"></param> | ||
83 | /// <returns></returns> | ||
56 | bool Delete(string id); | 84 | bool Delete(string id); |
57 | } | 85 | } |
58 | } | 86 | } |