RemoteAdmin:admin close region - Revision history

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

2021-03-16T19:38:31Z

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

Fritigern at 23:18, 24 October 2015

2015-10-24T23:18:44Z

Justincc: /* PHP */

2013-11-08T00:00:31Z

‎PHP

MakoBot: Robot: Cosmetic changes

2012-03-04T04:05:29Z

Robot: Cosmetic changes

Michelle Argus at 17:44, 10 December 2011

2011-12-10T17:44:52Z

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

2011-12-10T15:22:50Z

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

Michelle Argus at 22:11, 9 December 2011

2011-12-09T22:11:33Z

Michelle Argus: Created page with "'''admin_close_region''' remotely allows to close a regions. No changes are done to the database. The region will be shutdown and removed from the map. === Enabling admin_close..."

2011-10-27T14:54:29Z

Created page with "'''admin_close_region''' remotely allows to close a regions. No changes are done to the database. The region will be shutdown and removed from the map. === Enabling admin_close..."

New page

'''admin_close_region''' remotely allows to close a regions. No changes are done to the database. The region will be shutdown and removed from the map.

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

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

=== Optional Parameters ===
These parameters are optional and do not need to be set
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_id''
| region uuid of the region.
|
|}

== 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 when using ''region_name''
|
|-
| ''region_id''
| name uuid of region when using ''region_id''
|
|}

=== Error messages ===
When an error occures the following error value are returned

*region \"{REGION NAME}\" does not exist
*region \"{REGION UUID}\" does not exist

== Notes ==
*use admin_delete_region if you also want to remove the region from the database

== 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');
$myRemoteAdmin->SendCommand('admin_close_region', $parameters);
?>
</source>

[[Category:Development]]

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

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

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

← Older revision		Revision as of 22:11, 9 December 2011
Line 1:		Line 1:
−	'''admin_close_region''' remotely allows to close a regions. No changes are done to the database. The region will be shutdown and removed from the map.	+	'''admin_close_region''' remotely allows to close regions. No changes are done to the database. The region will be shutdown and removed from the map.

@@ Line 78: / Line 78: @@
 == 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 68: / Line 68: @@
 When an error occures the following error value are returned
-*region \"{REGION NAME}\" does not exist
+* region \"{REGION NAME}\" does not exist
-*region \"{REGION UUID}\" does not exist
+* region \"{REGION UUID}\" does not exist
 == Notes ==
-*use admin_delete_region if you also want to remove the region from the database
+* use admin_delete_region if you also want to remove the region from the database