RemoteAdmin:admin acl list

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''admin_acl_list''' remotely allows to retrieve a list of users who can access the region === Enabling admin_acl_list === If not all functions are enabled, use admin_acl_list...")
 
(Returned Parameters)
Line 52: Line 52:
 
| true when successfull
 
| true when successfull
 
| true, false
 
| true, false
|-
 
| ''region_name''
 
| name of the new region
 
|
 
 
|-
 
|-
 
| ''users''
 
| ''users''
Line 61: Line 57:
 
|
 
|
 
|}
 
|}
 
  
 
=== Error messages ===
 
=== Error messages ===

Revision as of 13:24, 9 December 2011

admin_acl_list remotely allows to retrieve a list of users who can access the region


Contents

Enabling admin_acl_list

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

enabled_methods = admin_acl_list,...


Parameters

Required Parameters

These parameters are required

parameter Description Values
region_name Name of the new region, optionaly region_uuid


Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
region_uuid region uuid


Returned Parameters

Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false
users list of users allowed access

Error messages

No error messages


Notes

Example

PHP

<?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_acl_list (multiple parameters)
$parameters = array('region_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_acl_list', $parameters);
?>
Personal tools
General
About This Wiki