Difference between revisions of "Bot Playground/Commands/im"
From SmartBots Developers Docs
| Line 13: | Line 13: | ||
{{API Variable|message |yes}}The message to send | {{API Variable|message |yes}}The message to send | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
| − | {{API Return | + | {{API Return promise}} |
| + | {{API Return none}} | ||
{{API Variables Table End}} | {{API Variables Table End}} | ||
== Comments == | == Comments == | ||
Revision as of 14:00, 28 June 2016
Sends Instant Message to specific avatar.
Bot.im( firstName, message );
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| firstName | yes | The name of the avatar | |
| message | yes | The message to send | |
| Output: | |||
| Function returns a Promise with the following data: | |||
| success | bool | true if command completed successfully | |
| error | string | error string if command has failed | |
| result | This function does not return anything | ||