RemoteAdmin:admin modify region

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 93: Line 93:
[[Category:RemoteAdmin Commands]]

Latest revision as of 16:28, 24 October 2015

admin_modify_region remotely allows to enable/disable voice and/or enable/disable public access to a region.


[edit] Enabling admin_modify_region

If not all functions are enabled, use admin_modify_region to enable the function in the [RemoteAdmin] section

enabled_methods = admin_modify_region,...

[edit] Parameters

[edit] Required Parameters

These parameters are required

parameter Description Values
region_name Name of the region

[edit] Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
enable_voice enable/disable voice. true, false
public", enable/disable public region access. true, false

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false
error error message when not successfull
region_id uuid of region

[edit] Error messages

When an error occures the following error value are returned

  • region \"{REGION NAME}\" does not exist
  • other...

[edit] Notes

  • region_id not implemented... patch in work by Michelle Argus...

[edit] Example

[edit] PHP

This example needs the RemoteAdmin PHP Class file available here.

// Including the RemoteAdmin PHP class.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 9000, 'secret');
// Invoke admin_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'public' => true);
$myRemoteAdmin->SendCommand('admin_modify_region', $parameters);
Personal tools
About This Wiki