friends

Retrieves the bot’s friends list in JSON format.

const result = await Bot.friends();
console.log("Friends:", result);

Input

This function does not require any arguments.

Output

Function returns a Promise with the following data:

Variable	Type	Description
`success`	bool	True if command completed successfully
`error`	string	Error string if command has failed
`friends`	array	A JSON array containing the bot’s friends (see below).

Example response

Below is an example of the response.

{
   "friends":[
      {
         "slname":"Glaznah Gassner",
         "theirRights":{
            "canSeeOnMap":true,
            "canSeeOnline":true,
            "canModifyObjects":true
         },
         "uuid":"cd93067e-7c4e-41c0-ba91-be01f4bafe35",
         "online":false,
         "myRights":{
            "canSeeOnMap":false,
            "canSeeOnline":true,
            "canModifyObjects":false
         }
      }
   ],
   "success":true
}