RemoteAdmin:admin dialog
From OpenSimulator
(Difference between revisions)
(Created page with "=== PHP === This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here]. <source lang="php"> <?php // Inc...") |
JeffKelley (Talk | contribs) m (→PHP: Fixed broken Google Code link, replacing with internal page) |
||
(4 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
+ | '''admin_dialog''' remotely allows to send admin_dialog. | ||
+ | |||
+ | === Enabling admin_dialog=== | ||
+ | If not all functions are enabled, use admin_dialog to enable the function in the [RemoteAdmin] section | ||
+ | <source lang="csharp"> | ||
+ | enabled_methods = admin_dialog, ... | ||
+ | </source> | ||
+ | |||
+ | == Parameters == | ||
+ | === Required Parameters === | ||
+ | No parameters are required | ||
+ | {| cellspacing="0" cellpadding="4" border="1" | ||
+ | |- | ||
+ | ! parameter | ||
+ | ! Description | ||
+ | ! Values | ||
+ | |} | ||
+ | |||
+ | === Optional Parameters === | ||
+ | No optional parameter | ||
+ | |||
+ | {| cellspacing="0" cellpadding="4" border="1" | ||
+ | |- | ||
+ | ! parameter | ||
+ | ! Description | ||
+ | ! Values | ||
+ | |} | ||
+ | |||
+ | == Returned Parameters == | ||
+ | === Returned Parameters === | ||
+ | These parameters are returned by Remote Admin | ||
+ | |||
+ | {| cellspacing="0" cellpadding="4" border="1" | ||
+ | |- | ||
+ | ! parameter | ||
+ | ! Description | ||
+ | ! Values | ||
+ | |- | ||
+ | | ''accepted'' | ||
+ | | true when successfull | ||
+ | | true, false | ||
+ | |- | ||
+ | | ''success'' | ||
+ | | true when successfull | ||
+ | | true, false | ||
+ | |} | ||
+ | |||
+ | === Error messages === | ||
+ | ... | ||
+ | |||
+ | == Notes == | ||
+ | ... | ||
+ | |||
+ | == Example == | ||
=== PHP === | === PHP === | ||
− | This example needs the RemoteAdmin PHP Class file available [ | + | This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]]. |
+ | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
Line 12: | Line 67: | ||
?> | ?> | ||
</source> | </source> | ||
+ | |||
+ | [[Category:RemoteAdmin]] | ||
+ | [[Category:RemoteAdmin Commands]] |
Latest revision as of 11:35, 16 March 2021
admin_dialog remotely allows to send admin_dialog.
Contents |
[edit] Enabling admin_dialog
If not all functions are enabled, use admin_dialog to enable the function in the [RemoteAdmin] section
enabled_methods = admin_dialog, ...
[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 |
---|---|---|
accepted | true when successfull | true, false |
success | true when successfull | true, false |
[edit] Error messages
...
[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_dialog (multiple parameters) $parameters = array('message' => '<MESSAGE_HERE>', 'from' => '<UUID_HERE>'); $myRemoteAdmin->SendCommand('admin_dialog', $parameters); ?>