OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin Class Reference

Inheritance diagram for OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin:

List of all members.

Public Member Functions
void	Initialise ()
	Default-initialises the plugin.
void	Initialise (OpenSimBase openSim)
XmlRpcResponse	XmlRpcRestartMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcAlertMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcLoadHeightmapMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcShutdownMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcCreateRegionMethod (XmlRpcRequest request)
	Create a new region. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcDeleteRegionMethod (XmlRpcRequest request)
	Delete a new region. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcCreateUserMethod (XmlRpcRequest request)
	Create a new user account. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcCreateUserMethodEmail (XmlRpcRequest request)
	Create a new user account. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcUserExistsMethod (XmlRpcRequest request)
	Check whether a certain user account exists. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcUpdateUserAccountMethod (XmlRpcRequest request)
	Update the password of a user account. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcLoadOARMethod (XmlRpcRequest request)
	Load an OAR file into a region.. Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcSaveOARMethod (XmlRpcRequest request)
	Save a region to an OAR file Parameters: request  incoming XML RPC request .
XmlRpcResponse	XmlRpcLoadXMLMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcSaveXMLMethod (XmlRpcRequest request)
XmlRpcResponse	XmlRpcRegionQueryMethod (XmlRpcRequest request)
void	Dispose ()
Properties
string	Version [get]
	Returns the plugin version.
string	Name [get]
	Returns the plugin name.

---

Member Function Documentation

void OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::Initialise

(

)

[inline]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

void OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::Initialise

(

OpenSimBase

openSim

)

[inline]

Implements OpenSim::IApplicationPlugin.

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcRestartMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcAlertMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcLoadHeightmapMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcShutdownMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcCreateRegionMethod

(

XmlRpcRequest

request

)

[inline]

Create a new region.

Parameters:

request

incoming XML RPC request

.

XmlRpcCreateRegionMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>region_name</term> desired region name <term>region_id</term> (optional) desired region UUID <term>region_x</term> desired region X coordinate (integer) <term>region_y</term> desired region Y coordinate (integer) <term>region_master_first</term> firstname of region master <term>region_master_last</term> lastname of region master <term>region_master_uuid</term> explicit UUID to use for master avatar (optional) <term>listen_ip</term> internal IP address (dotted quad) <term>listen_port</term> internal port (integer) <term>external_address</term> external IP address <term>persist</term> if true, persist the region info ('true' or 'false')

XmlRpcCreateRegionMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false <term>region_uuid</term> UUID of the newly created region <term>region_name</term> name of the newly created region

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcDeleteRegionMethod

(

XmlRpcRequest

request

)

[inline]

Delete a new region.

Parameters:

request

incoming XML RPC request

.

XmlRpcCreateRegionMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>region_name</term> desired region name <term>region_id</term> (optional) desired region UUID

XmlRpcCreateRegionMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcCreateUserMethod

(

XmlRpcRequest

request

)

[inline]

Create a new user account.

Parameters:

request

incoming XML RPC request

.

XmlRpcCreateUserMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>user_firstname</term> avatar's first name <term>user_lastname</term> avatar's last name <term>user_password</term> avatar's password <term>start_region_x</term> avatar's start region coordinates, X value <term>start_region_y</term> avatar's start region coordinates, Y value

XmlRpcCreateUserMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false <term>avatar_uuid</term> UUID of the newly created avatar account; UUID.Zero if failed.

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcCreateUserMethodEmail

(

XmlRpcRequest

request

)

[inline]

Create a new user account.

Parameters:

request

incoming XML RPC request

.

XmlRpcCreateUserMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>user_firstname</term> avatar's first name <term>user_lastname</term> avatar's last name <term>user_password</term> avatar's password <term>start_region_x</term> avatar's start region coordinates, X value <term>start_region_y</term> avatar's start region coordinates, Y value <term>user_email</term> email of avatar

XmlRpcCreateUserMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false <term>avatar_uuid</term> UUID of the newly created avatar account; UUID.Zero if failed.

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcUserExistsMethod

(

XmlRpcRequest

request

)

[inline]

Check whether a certain user account exists.

Parameters:

request

incoming XML RPC request

.

XmlRpcUserExistsMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>user_firstname</term> avatar's first name <term>user_lastname</term> avatar's last name

XmlRpcCreateUserMethod returns

<term>name</term>description</listheader> <term>user_firstname</term> avatar's first name <term>user_lastname</term> avatar's last name <term>success</term> true or false <term>error</term> error message if success is false

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcUpdateUserAccountMethod

(

XmlRpcRequest

request

)

[inline]

Update the password of a user account.

Parameters:

request

incoming XML RPC request

.

XmlRpcUpdateUserAccountMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>user_firstname</term> avatar's first name (cannot be changed) <term>user_lastname</term> avatar's last name (cannot be changed) <term>user_password</term> avatar's password (changeable) <term>start_region_x</term> avatar's start region coordinates, X value (changeable) <term>start_region_y</term> avatar's start region coordinates, Y value (changeable)

XmlRpcCreateUserMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcLoadOARMethod

(

XmlRpcRequest

request

)

[inline]

Load an OAR file into a region..

Parameters:

request

incoming XML RPC request

.

XmlRpcLoadOARMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>filename</term> file name of the OAR file <term>region_uuid</term> UUID of the region <term>region_name</term> region name

region_uuid

takes precedence over

region_name

if both are present; one of both must be present.

XmlRpcLoadOARMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcSaveOARMethod

(

XmlRpcRequest

request

)

[inline]

Save a region to an OAR file

Parameters:

request

incoming XML RPC request

.

XmlRpcSaveOARMethod takes the following XMLRPC parameters

<term>parameter name</term>description</listheader> <term>password</term> admin password as set in OpenSim.ini <term>filename</term> file name for the OAR file <term>region_uuid</term> UUID of the region <term>region_name</term> region name

region_uuid

takes precedence over

region_name

if both are present; one of both must be present.

XmlRpcLoadOARMethod returns

<term>name</term>description</listheader> <term>success</term> true or false <term>error</term> error message if success is false

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcLoadXMLMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcSaveXMLMethod

(

XmlRpcRequest

request

)

[inline]

XmlRpcResponse OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::XmlRpcRegionQueryMethod

(

XmlRpcRequest

request

)

[inline]

void OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::Dispose

(

)

[inline]

---

Property Documentation

string OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::Version [get]

Returns the plugin version.

Returns:

Plugin version in MAJOR.MINOR.REVISION.BUILD format

Implements OpenSim::Framework::IPlugin.

string OpenSim::ApplicationPlugins::RemoteController::RemoteAdminPlugin::Name [get]

Returns the plugin name.

Returns:

Plugin name, eg MySQL User Provider

Implements OpenSim::Framework::IPlugin.

---

The documentation for this class was generated from the following file:

• /home/sdague/opensim-docs/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs

---