RemoteAdmin:admin refresh search

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''admin_refresh_search''' remotely allows to refresh search. === Enabling admin_refresh_search=== If not all functions are enabled, use admin_refresh_search to enable the fu...")
 
m (PHP: Fixed broken Google Code link, replacing with internal page)
 
Line 50: Line 50:
 
== Example ==
 
== Example ==
 
=== PHP ===
 
=== 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">
 
<source lang="php">

Latest revision as of 11:35, 16 March 2021

admin_refresh_search remotely allows to refresh search.

Contents

[edit] Enabling admin_refresh_search

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

enabled_methods = admin_refresh_search, ...

[edit] Parameters

[edit] Required Parameters

No parameters are required

parameter Description Values

[edit] Optional Parameters

No optional parameter

parameter Description Values

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false

[edit] Error messages

no region_name or region_id given

[edit] Notes

...

[edit] Example

[edit] 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
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');
// Invoke admin_refresh_search (multiple parameters)
$parameters = array('region_name' => '<REGION_NAME_HERE>', 'region_id' => '<REGION_ID_HERE>');
$myRemoteAdmin->SendCommand('admin_refresh_search', $parameters);
?>
Personal tools
General
About This Wiki