RemoteAdmin:admin modify region

From OpenSimulator

Revision as of 16:28, 24 October 2015 by Fritigern (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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


Contents

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,...

Parameters

Required Parameters

These parameters are required

parameter Description Values
region_name Name of the region


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


Returned Parameters

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

Error messages

When an error occures the following error value are returned

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


Notes

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

Example

PHP

This example needs the RemoteAdmin PHP Class file available here.

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