Add method doc to IAssetService.Get(string, object, AssetRetrieved) outlining the situations in which AssetRetrieved may be called back with a null AssetBase.

These situations include asset not found and remote service not responding.
integration
Justin Clark-Casey (justincc) 2012-10-30 01:19:32 +00:00
parent cccf695327
commit 9bc4dc6c5f
1 changed files with 5 additions and 1 deletions

View File

@ -68,7 +68,11 @@ namespace OpenSim.Services.Interfaces
/// </summary> /// </summary>
/// <param name="id">The asset id</param> /// <param name="id">The asset id</param>
/// <param name="sender">Represents the requester. Passed back via the handler</param> /// <param name="sender">Represents the requester. Passed back via the handler</param>
/// <param name="handler">The handler to call back once the asset has been retrieved</param> /// <param name="handler">
/// The handler to call back once the asset has been retrieved. This will be called back with a null AssetBase
/// if the asset could not be found for some reason (e.g. if it does not exist, if a remote asset service
/// was not contactable, if it is not in the database, etc.).
/// </param>
/// <returns>True if the id was parseable, false otherwise</returns> /// <returns>True if the id was parseable, false otherwise</returns>
bool Get(string id, Object sender, AssetRetrieved handler); bool Get(string id, Object sender, AssetRetrieved handler);