Difference between revisions of "Bot Playground/Events/friendship offer"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:friendship_offer}} <onlyinclude>Fires when bot receives a friendship offer</onlyinclude> <syntaxhighlight lang="javascript"> Bot.on("friendship_offer", functio...")
 
Line 5: Line 5:
 
Bot.on("friendship_offer", function(event) { ... });
 
Bot.on("friendship_offer", function(event) { ... });
 
</syntaxhighlight>
 
</syntaxhighlight>
 
offer_friendship: {"name":"offer_friendship","bot_slname":"Fashion Firethorn","bot_uuid":"13e0bc21-bc8d-4c8e-8354-19965817dee6",,"":"Vikky Dryke","":"042536ca-dc19-45ef-bd3c-2f3c829d4e56","":"df65047c-7e93-d33a-dcfa-ca4ad3599c28"}
 
  
  
Line 17: Line 15:
  
 
{{API Variables Table End}}
 
{{API Variables Table End}}
 +
 +
== See also ==
 +
 +
[Bot_Playground/Commands/acceptFriendshipOffer|acceptFriendshipOffer] command.
  
 
== Example ==
 
== Example ==

Revision as of 16:32, 17 October 2022

Fires when bot receives a friendship offer

Bot.on("friendship_offer", function(event) { ... });


Reference

This event comes with the following event object:

Variable Required Description
event object properties:
avatar_name name of the sender
avatar_uuid UUID of the sender
message Text message sent along with the offer
session_id Session UUID to accept an offer.

See also

[Bot_Playground/Commands/acceptFriendshipOffer|acceptFriendshipOffer] command.

Example

Bot.on("friendship_offer", function(event) {
	console.log(`Friendship offfer from ${event.avatar_name}`);
});

console.log("Bot is listening to friendship offers");