Difference between revisions of "PHP/Available Actions"

From SmartBots Developers Docs
Jump to: navigation, search
(Added get_balance)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:SmartBots PHP API}}
 
 
== Available Actions ==
 
== Available Actions ==
  
−
This section shows all of the available actions which you can use with this API. Currently, all API actions available from SmartBots can be used with this API.
+
This section shows all of the available actions which you can use with this API.
 +
Currently, all API actions available from SmartBots can be used with this API.
  
−
indicates a required parameter, the command will not work if this parameter is left empty.
+
<span style="color: red">*</span> indicates a required parameter, the command will not work if this parameter is left empty.
  
 +
{| class="wikitable"
 +
! style="font-weight: bold;" | Action
 +
! style="font-weight: bold;" | Method
 +
|-
 +
| login
 +
| <source lang="php" enclose="none">login( region*, custom );</source>
 +
|-
 +
| logout
 +
| <source lang="php" enclose="none">logout( custom* );</source>
 +
|-
 +
| set_http_callback
 +
| <source lang="php" enclose="none">set_http_callback( url, events*, custom );</source>
 +
|-
 +
| activate_group
 +
| <source lang="php" enclose="none">activate_group( uuid*, custom );</source>
 +
|-
 +
| attachment_touch
 +
| <source lang="php" enclose="none">attachment_touch( objectname*, linkset*, custom );</source>
 +
|-
 +
| attachments
 +
| <source lang="php" enclose="none">attachments( skipnames, matchnames, matchuuid, custom );</source>
 +
|-
 +
| avatar_groups
 +
| <source lang="php" enclose="none">avatar_groups( avatar*, skipnames, matchnames, matchuuid, custom );</source>
 +
|-
 +
| avatar_picks
 +
| <source lang="php" enclose="none">avatar_picks( avatar*, skipnames, matchnames, matchuuid, custom );</source>
 +
|-
 +
| get_balance
 +
| <source lang="php" enclose="none">get_balance( custom );</source>
 +
|-
 +
| give_inventory
 +
| <source lang="php" enclose="none">give_inventory( avatar*, object*, custom );</source>
 +
|-
 +
| give_money
 +
| <source lang="php" enclose="none">give_money( avatar*, amount*, comment, custom );</source>
 +
|-
 +
| give_money_object
 +
| <source lang="php" enclose="none">give_money_object( object_uuid*, amount*, object_name, custom );</source>
 +
|-
 +
| group_eject
 +
| <source lang="php" enclose="none">group_eject( avatar*, groupuuid*, custom );</source>
 +
|-
 +
| group_invite
 +
| <source lang="php" enclose="none">group_invite( avatar*, groupuuid*, roleuuid*, check_membership, message, custom );</source>
 +
|-
 +
| group_join
 +
| <source lang="php" enclose="none">group_join( groupuuid*, custom );</source>
 +
|-
 +
| group_leave
 +
| <source lang="php" enclose="none">group_leave( groupuuid*, custom );</source>
 +
|-
 +
| im
 +
| <source lang="php" enclose="none">im( slname*, message*, custom );</source>
 +
|-
 +
| key2name
 +
| <source lang="php" enclose="none">key2name( uuid*, custom );</source>
 +
|-
 +
| list_group_roles
 +
| <source lang="php" enclose="none">list_group_roles( groupuuid*, custom );</source>
 +
|-
 +
| listgroups
 +
| <source lang="php" enclose="none">listgroups( custom );</source>
 +
|-
 +
| listinventory
 +
| <source lang="php" enclose="none">listinventory( uuid, extended, custom );</source>
 +
|-
 +
| move
 +
| <source lang="php" enclose="none">move( instruction*, param1*, custom );</source>
 +
|-
 +
| name2key
 +
| <source lang="php" enclose="none">name2key( name*, custom );</source>
 +
|-
 +
| offer_friendship
 +
| <source lang="php" enclose="none">offer_friendship( avatar*, message, custom );</source>
 +
|-
 +
| offer_teleport
 +
| <source lang="php" enclose="none">offer_teleport( avatar*, message, custom );</source>
 +
|-
 +
| parcel_info
 +
| <source lang="php" enclose="none">parcel_info( x, y, getvalue, custom );</source>
 +
|-
 +
| rebake
 +
| <source lang="php" enclose="none">rebake( custom );</source>
 +
|-
 +
| reply_dialog
 +
| <source lang="php" enclose="none">reply_dialog( channel*, object*, button*, custom );</source>
 +
|-
 +
| say_chat_channel
 +
| <source lang="php" enclose="none">say_chat_channel( channel*, message*, custom );</source>
 +
|-
 +
| send_group_im
 +
| <source lang="php" enclose="none">send_group_im( groupuuid*, message*, custom );</source>
 +
|-
 +
| send_notice
 +
| <source lang="php" enclose="none">send_notice( groupuuid*, subject*, text*, attachment, custom );</source>
 +
|-
 +
| setrole
 +
| <source lang="php" enclose="none">setrole( groupuuid*, roleuuid*, member*, custom );</source>
 +
|-
 +
| sit
 +
| <source lang="php" enclose="none">sit( uuid*, save, custom );</source>
 +
|-
 +
| takeoff
 +
| <source lang="php" enclose="none">takeoff( uuid*, custom );</source>
 +
|-
 +
| teleport
 +
| <source lang="php" enclose="none">teleport( location*, custom );</source>
 +
|-
 +
| touch_prim
 +
| <source lang="php" enclose="none">touch_prim( uuid*, custom );</source>
 +
|-
 +
| touch_prim_coord
 +
| <source lang="php" enclose="none">touch_prim_coord( x*, y*, z*, precision, custom );</source>
 +
|-
 +
| wear
 +
| <source lang="php" enclose="none">wear( uuid*, custom );</source>
 +
|}
  
−
 
+
[[PHP/Multiple_Bots|Prev Section (Multiple Bots)]]
−
[[HTTP_API/PHP/Performing_Actions|Prev Section (Performing Actions)]]<div class="floatright">[[HTTP_API/PHP/Available_Actions|Next Section (Available Actions)]]</div>
+
 
{{NavMenu}}
 
{{NavMenu}}
 +
__NOTOC__

Latest revision as of 09:22, 23 December 2016

Available Actions

This section shows all of the available actions which you can use with this API. Currently, all API actions available from SmartBots can be used with this API.

* indicates a required parameter, the command will not work if this parameter is left empty.

Action Method
login login( region*, custom );
logout logout( custom* );
set_http_callback set_http_callback( url, events*, custom );
activate_group activate_group( uuid*, custom );
attachment_touch attachment_touch( objectname*, linkset*, custom );
attachments attachments( skipnames, matchnames, matchuuid, custom );
avatar_groups avatar_groups( avatar*, skipnames, matchnames, matchuuid, custom );
avatar_picks avatar_picks( avatar*, skipnames, matchnames, matchuuid, custom );
get_balance get_balance( custom );
give_inventory give_inventory( avatar*, object*, custom );
give_money give_money( avatar*, amount*, comment, custom );
give_money_object give_money_object( object_uuid*, amount*, object_name, custom );
group_eject group_eject( avatar*, groupuuid*, custom );
group_invite group_invite( avatar*, groupuuid*, roleuuid*, check_membership, message, custom );
group_join group_join( groupuuid*, custom );
group_leave group_leave( groupuuid*, custom );
im im( slname*, message*, custom );
key2name key2name( uuid*, custom );
list_group_roles list_group_roles( groupuuid*, custom );
listgroups listgroups( custom );
listinventory listinventory( uuid, extended, custom );
move move( instruction*, param1*, custom );
name2key name2key( name*, custom );
offer_friendship offer_friendship( avatar*, message, custom );
offer_teleport offer_teleport( avatar*, message, custom );
parcel_info parcel_info( x, y, getvalue, custom );
rebake rebake( custom );
reply_dialog reply_dialog( channel*, object*, button*, custom );
say_chat_channel say_chat_channel( channel*, message*, custom );
send_group_im send_group_im( groupuuid*, message*, custom );
send_notice send_notice( groupuuid*, subject*, text*, attachment, custom );
setrole setrole( groupuuid*, roleuuid*, member*, custom );
sit sit( uuid*, save, custom );
takeoff takeoff( uuid*, custom );
teleport teleport( location*, custom );
touch_prim touch_prim( uuid*, custom );
touch_prim_coord touch_prim_coord( x*, y*, z*, precision, custom );
wear wear( uuid*, custom );

Prev Section (Multiple Bots)

Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=PHP/Available_Actions&oldid=972"