aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Data/MySQL/MySQLUserData.cs
diff options
context:
space:
mode:
authorJeff Ames2008-06-26 01:12:28 +0000
committerJeff Ames2008-06-26 01:12:28 +0000
commit8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68 (patch)
tree2891fe56398b57e5e9a78fffea9f01c171594bf8 /OpenSim/Data/MySQL/MySQLUserData.cs
parentSeparate POS classes into mutiple files. (diff)
downloadopensim-SC-8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68.zip
opensim-SC-8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68.tar.gz
opensim-SC-8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68.tar.bz2
opensim-SC-8a0a0f9bb563f2cb7ec823587e13e3f4483d3a68.tar.xz
Add patch from bug #1596 - adds Doxygen documentation in OpenSim.Data.MySQL files. Thanks kerunix_Flan!
Diffstat (limited to '')
-rw-r--r--OpenSim/Data/MySQL/MySQLUserData.cs42
1 files changed, 39 insertions, 3 deletions
diff --git a/OpenSim/Data/MySQL/MySQLUserData.cs b/OpenSim/Data/MySQL/MySQLUserData.cs
index 05874f8..11d9c26 100644
--- a/OpenSim/Data/MySQL/MySQLUserData.cs
+++ b/OpenSim/Data/MySQL/MySQLUserData.cs
@@ -56,8 +56,12 @@ namespace OpenSim.Data.MySQL
56 private string m_connectString; 56 private string m_connectString;
57 57
58 /// <summary> 58 /// <summary>
59 /// Initialise User Interface
59 /// Loads and initialises the MySQL storage plugin 60 /// Loads and initialises the MySQL storage plugin
61 /// Warns and uses the obsolete mysql_connection.ini if connect string is empty.
62 /// Checks for migration
60 /// </summary> 63 /// </summary>
64 /// <param name="connect">connect string.</param>
61 override public void Initialise(string connect) 65 override public void Initialise(string connect)
62 { 66 {
63 if (connect == String.Empty) { 67 if (connect == String.Empty) {
@@ -494,7 +498,11 @@ namespace OpenSim.Data.MySQL
494 return returnlist; 498 return returnlist;
495 } 499 }
496 500
497 // see IUserData 501 /// <summary>
502 /// See IUserData
503 /// </summary>
504 /// <param name="uuid">User UUID</param>
505 /// <returns>User profile data</returns>
498 override public UserProfileData GetUserByUUID(LLUUID uuid) 506 override public UserProfileData GetUserByUUID(LLUUID uuid)
499 { 507 {
500 try 508 try
@@ -526,7 +534,7 @@ namespace OpenSim.Data.MySQL
526 /// <summary> 534 /// <summary>
527 /// Returns a user session searching by name 535 /// Returns a user session searching by name
528 /// </summary> 536 /// </summary>
529 /// <param name="name">The account name</param> 537 /// <param name="name">The account name : "Username Lastname"</param>
530 /// <returns>The users session</returns> 538 /// <returns>The users session</returns>
531 override public UserAgentData GetAgentByName(string name) 539 override public UserAgentData GetAgentByName(string name)
532 { 540 {
@@ -545,6 +553,11 @@ namespace OpenSim.Data.MySQL
545 return GetAgentByUUID(profile.ID); 553 return GetAgentByUUID(profile.ID);
546 } 554 }
547 555
556 /// <summary>
557 /// </summary>
558 /// <param name="AgentID"></param>
559 /// <param name="WebLoginKey"></param>
560 /// <remarks>is it still used ?</remarks>
548 override public void StoreWebLoginKey(LLUUID AgentID, LLUUID WebLoginKey) 561 override public void StoreWebLoginKey(LLUUID AgentID, LLUUID WebLoginKey)
549 { 562 {
550 Dictionary<string, string> param = new Dictionary<string, string>(); 563 Dictionary<string, string> param = new Dictionary<string, string>();
@@ -694,9 +707,11 @@ namespace OpenSim.Data.MySQL
694 return false; 707 return false;
695 } 708 }
696 709
710 /// <summary>
697 /// Appearance 711 /// Appearance
698 /// TODO: stubs for now to get us to a compiling state gently 712 /// TODO: stubs for now to get us to a compiling state gently
699 // override 713 /// override
714 /// </summary>
700 override public AvatarAppearance GetUserAppearance(LLUUID user) 715 override public AvatarAppearance GetUserAppearance(LLUUID user)
701 { 716 {
702 try { 717 try {
@@ -723,6 +738,12 @@ namespace OpenSim.Data.MySQL
723 return null; 738 return null;
724 } 739 }
725 } 740 }
741
742 /// <summary>
743 /// Updates an avatar appearence
744 /// </summary>
745 /// <param name="user">The user UUID</param>
746 /// <param name="appearance">The avatar appearance</param>
726 // override 747 // override
727 override public void UpdateUserAppearance(LLUUID user, AvatarAppearance appearance) 748 override public void UpdateUserAppearance(LLUUID user, AvatarAppearance appearance)
728 { 749 {
@@ -741,16 +762,31 @@ namespace OpenSim.Data.MySQL
741 } 762 }
742 } 763 }
743 764
765 /// <summary>
766 /// Adds an attachment item to a user
767 /// </summary>
768 /// <param name="user">the user UUID</param>
769 /// <param name="item">the item UUID</param>
744 override public void AddAttachment(LLUUID user, LLUUID item) 770 override public void AddAttachment(LLUUID user, LLUUID item)
745 { 771 {
746 return; 772 return;
747 } 773 }
748 774
775 /// <summary>
776 /// Removes an attachment from a user
777 /// </summary>
778 /// <param name="user">the user UUID</param>
779 /// <param name="item">the item UUID</param>
749 override public void RemoveAttachment(LLUUID user, LLUUID item) 780 override public void RemoveAttachment(LLUUID user, LLUUID item)
750 { 781 {
751 return; 782 return;
752 } 783 }
753 784
785 /// <summary>
786 /// Get the list of item attached to a user
787 /// </summary>
788 /// <param name="user">the user UUID</param>
789 /// <returns>UUID list of attached item</returns>
754 override public List<LLUUID> GetAttachments(LLUUID user) 790 override public List<LLUUID> GetAttachments(LLUUID user)
755 { 791 {
756 return new List<LLUUID>(); 792 return new List<LLUUID>();