PresenceService - Revision history

Justincc: /* getagents */

2015-02-19T00:45:58Z

‎getagents

Justincc: /* Calls */

2013-03-11T21:31:09Z

‎Calls

Justincc at 04:36, 20 November 2012

2012-11-20T04:36:33Z

Justincc: /* Introduction */

2012-11-20T04:36:12Z

‎Introduction

Justincc: Created page with "=Introduction= The OpenSimulator presence service stores session information for online users. '''TODO: Document remaining operations'''. =API= == Calls == === getagents === ..."

2012-11-20T04:34:24Z

Created page with "=Introduction= The OpenSimulator presence service stores session information for online users. '''TODO: Document remaining operations'''. =API= == Calls == === getagents === ..."

New page

=Introduction=

The OpenSimulator presence service stores session information for online users.

'''TODO: Document remaining operations'''.

=API=
== Calls ==
=== getagents ===

This returns session information about a given set of users for each online user. POST field is a urlencoded string like so

METHOD=getagents&uuids[]=e4f3924a-5a7c-4e1a-bee7-aa96580f2515&uuids[]=e92bcf57-00e3-44b1-9e3b-586bfdcac4c3

where

* '''uuids[]''' are the UUIDs of the users to query. If there is more than one user, then each must be in a separate uuids[] param as shown above. In this case we are asking for details on two users, e4f3924a-5a7c-4e1a-bee7-aa96580f2515 and e92bcf57-00e3-44b1-9e3b-586bfdcac4c3
* '''METHOD''' is the XMLRPC method, in this case "getagents".

If no online users were found, return is

<source lang="xml">
<?xml version="1.0"?>
<ServerResponse>
<result>null</result>
</ServerResponse>
</source>

If online users were found, then an example return is

<source lang="xml">
<?xml version="1.0"?>
<ServerResponse>
<presence0 type="List">
<UserID>e4f3924a-5a7c-4e1a-bee7-aa96580f2515</UserID>
<RegionID>aaaaaaaa-bf88-45ac-aace-35bd76426c81</RegionID>
</presence0>
<presence1 type="List">
<UserID>e92bcf57-00e3-44b1-9e3b-586bfdcac4c3</UserID>
<RegionID>aaaaaaaa-bf88-45ac-aace-35bd76426c81</RegionID>
</presence1>
</ServerResponse>
<source>

Each presence element has its index number appended (e.g. presence1 for the second user). User ID is listed and the RegionID that the user is in.

@@ Line 43: / Line 43: @@
 </source>
-Each user online will have a presence elemnt.  Offline users will have no element.
+Each user online will have a presence element.  Offline users will have no element.
 Each presence element has its index number appended (e.g. presence1 for the second user).  User ID is listed and the RegionID that the user is in.

@@ Line 41: / Line 41: @@
    </presence1>
 </ServerResponse>
-<source>
+</source>
 Each presence element has its index number appended (e.g. presence1 for the second user).  User ID is listed and the RegionID that the user is in.

@@ Line 3: / Line 3: @@
 The OpenSimulator presence service stores session information for online users.
-'''TODO: Document remaining operations'''.
+'''TODO: Document remaining operations: login (simulators only), logout (simulators only), logoutregion (simulators only), report (simulators only), getagent (which is like getagents but confusingly requires a session id instead of a user id)'''.
 =API=