diff options
author | Justin Clark-Casey (justincc) | 2012-10-20 02:26:08 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2012-10-20 02:26:08 +0100 |
commit | ac037dfe210f416e6355bd7c1210f25d6cb90f63 (patch) | |
tree | fbccc62994ae979298047f525cb3004f852bef1e | |
parent | Relocate temporary debug message for sending group IMs to online members only... (diff) | |
download | opensim-SC-ac037dfe210f416e6355bd7c1210f25d6cb90f63.zip opensim-SC-ac037dfe210f416e6355bd7c1210f25d6cb90f63.tar.gz opensim-SC-ac037dfe210f416e6355bd7c1210f25d6cb90f63.tar.bz2 opensim-SC-ac037dfe210f416e6355bd7c1210f25d6cb90f63.tar.xz |
Add method doc for IPresenceService
-rw-r--r-- | OpenSim/Services/Interfaces/IPresenceService.cs | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/OpenSim/Services/Interfaces/IPresenceService.cs b/OpenSim/Services/Interfaces/IPresenceService.cs index 8d583ff..90f9842 100644 --- a/OpenSim/Services/Interfaces/IPresenceService.cs +++ b/OpenSim/Services/Interfaces/IPresenceService.cs | |||
@@ -61,13 +61,49 @@ namespace OpenSim.Services.Interfaces | |||
61 | 61 | ||
62 | public interface IPresenceService | 62 | public interface IPresenceService |
63 | { | 63 | { |
64 | /// <summary> | ||
65 | /// Store session information. | ||
66 | /// </summary> | ||
67 | /// <returns>/returns> | ||
68 | /// <param name='userID'></param> | ||
69 | /// <param name='sessionID'></param> | ||
70 | /// <param name='secureSessionID'></param> | ||
64 | bool LoginAgent(string userID, UUID sessionID, UUID secureSessionID); | 71 | bool LoginAgent(string userID, UUID sessionID, UUID secureSessionID); |
72 | |||
73 | /// <summary> | ||
74 | /// Remove session information. | ||
75 | /// </summary> | ||
76 | /// <returns></returns> | ||
77 | /// <param name='sessionID'></param> | ||
65 | bool LogoutAgent(UUID sessionID); | 78 | bool LogoutAgent(UUID sessionID); |
79 | |||
80 | /// <summary> | ||
81 | /// Remove session information for all agents in the given region. | ||
82 | /// </summary> | ||
83 | /// <returns></returns> | ||
84 | /// <param name='regionID'></param> | ||
66 | bool LogoutRegionAgents(UUID regionID); | 85 | bool LogoutRegionAgents(UUID regionID); |
67 | 86 | ||
87 | /// <summary> | ||
88 | /// Update data for an existing session. | ||
89 | /// </summary> | ||
90 | /// <returns></returns> | ||
91 | /// <param name='sessionID'></param> | ||
92 | /// <param name='regionID'></param> | ||
68 | bool ReportAgent(UUID sessionID, UUID regionID); | 93 | bool ReportAgent(UUID sessionID, UUID regionID); |
69 | 94 | ||
95 | /// <summary> | ||
96 | /// Get session information for a given session ID. | ||
97 | /// </summary> | ||
98 | /// <returns></returns> | ||
99 | /// <param name='sessionID'></param> | ||
70 | PresenceInfo GetAgent(UUID sessionID); | 100 | PresenceInfo GetAgent(UUID sessionID); |
101 | |||
102 | /// <summary> | ||
103 | /// Get session information for a collection of users. | ||
104 | /// </summary> | ||
105 | /// <returns>Session information for the users.</returns> | ||
106 | /// <param name='userIDs'></param> | ||
71 | PresenceInfo[] GetAgents(string[] userIDs); | 107 | PresenceInfo[] GetAgents(string[] userIDs); |
72 | } | 108 | } |
73 | } | 109 | } \ No newline at end of file |