RemoteAdmin:admin modify region - Revision history

JeffKelley: /* PHP */ Fixed broken Google Code link, replacing with internal page

2021-03-16T19:37:59Z

‎PHP: Fixed broken Google Code link, replacing with internal page

Fritigern at 23:28, 24 October 2015

2015-10-24T23:28:23Z

Justincc at 00:01, 8 November 2013

2013-11-08T00:01:21Z

MakoBot: Robot: Cosmetic changes

2012-03-04T04:06:39Z

Robot: Cosmetic changes

Michelle Argus: /* Returned Parameters */

2012-02-17T16:28:08Z

‎Returned Parameters

Michelle Argus at 17:43, 10 December 2011

2011-12-10T17:43:10Z

Michelle Argus: moved Remoteadmin:admin modify region to RemoteAdmin:admin modify region: spelling

2011-12-10T15:23:28Z

moved Remoteadmin:admin modify region to RemoteAdmin:admin modify region: spelling

Michelle Argus: /* Notes */

2011-12-09T18:03:31Z

‎Notes

Michelle Argus: Created page with "'''admin_modify_region''' remotely allows to enable/disable voice and/or enable/disable public access to a region. === Enabling admin_modify_region === If not all functions ar..."

2011-12-09T17:08:41Z

Created page with "'''admin_modify_region''' remotely allows to enable/disable voice and/or enable/disable public access to a region. === Enabling admin_modify_region === If not all functions ar..."

New page

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

=== Enabling admin_modify_region ===
If not all functions are enabled, use admin_modify_region to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_modify_region,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_name''
| Name of the region
|
|}

=== Optional Parameters ===
These parameters are optional and do not need to be set
{| cellspacing="0" cellpadding="4" border="1"
|-
! 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

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|-
| ''region_name''
| name 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...

== Example ==
=== PHP ===
<source lang="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_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'public' => true);
$myRemoteAdmin->SendCommand('admin_modify_region', $parameters);
?>
</source>

[[Category:Development]]

@@ Line 93: / Line 93: @@
 </source>
 [[RemoteAdmin]]
-[[RemoteAdmin:Commands]]

← Older revision		Revision as of 17:43, 10 December 2011
Line 92:		Line 92:
	</source>		</source>

−	[[~~Category~~:~~Development~~]]	+	[[RemoteAdmin]]
		+	[[RemoteAdmin:Commands]]

@@ Line 76: / Line 76: @@
 == Example ==
 === PHP ===
-This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
+This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].
 <source lang="php">

@@ Line 67: / Line 67: @@
 When an error occures the following error value are returned
-*region \"{REGION NAME}\" does not exist
+* region \"{REGION NAME}\" does not exist
-*other...
+* other...
 == Notes ==
-*region_id not implemented... patch in work by Michelle Argus...
+* region_id not implemented... patch in work by Michelle Argus...
 == Example ==

@@ Line 59: / Line 59: @@
+|
 |-
-| ''region_name''
+| ''region_id''
-| name of region
+| uuid of region
+|
 |}
 === Error messages ===