AddFriendsFromPlatform

Links the profiles for the specified externalIds for the given friend platform as internal friends.

Service	Operation
friend	ADD_FRIENDS_FROM_PLATFORM

Method Parameters

Parameter	Description
friendPlatform	Friend platform to query. Valid values are "Facebook", "Steam", and "PlaystationNetwork"
mode	"ADD" to add friends only, "SYNC" to delete any previously saved friends that are not in the externalIds list
externalIds	The list of platform-specific external IDs of the friends to add

Usage

http://localhost:3000

C#

string friendPlatform = "Facebook";
string mode = "ADD";
string[] externalIds = { "external Id 1", "external Id 2" };
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.FriendService.AddFriendsFromPlatform(friendPlatform, mode, externalIds, successCallback, failureCallback);

C++

const char *friendPlatform = "Facebook";
const char *mode = "ADD";
std::vector<std::string> externalIds;
externalIds.push_back("external Id 1");
externalIds.push_back("external Id 2");
_bc->getFriendService()->addFriendsFromPlatform(friendPlatform, mode, externalIds, this);

Objective-C

NSString *friendPlatform = @"Facebook";
NSString *mode = @"ADD";
NSArray *externalIds = @[ @"external Id 1", @"external Id 2" ];
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc friendService] addFriendsFromPlatform:friendPlatform
                       mode:mode
                externalIds:externalIds
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String friendPlatform = "Facebook";
String mode = "ADD";
String[] externalIds = { "external Id 1", "external Id 2" };
this; // implements IServerCallback

_bc.getFriendService().addFriendsFromPlatform(friendPlatform, mode, externalIds, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var friendPlatform = "Facebook";
var mode = "ADD";
var externalIds = [ "external Id 1", "external Id 2" ];

_bc.friend.addFriendsFromPlatform(friendPlatform, mode, externalIds, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  friendPlatform = FriendPlatform.facebook;
var  mode = "ADD";
var  externalIds = [ "external Id 1", "external Id 2" ];

ServerResponse result = await _bc.friendService.addFriendsFromPlatform(friendPlatform:friendPlatform, mode:mode, externalIds:externalIds);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var friendPlatform = "Facebook";
var mode = "ADD";
var externalIds = [ "external Id 1", "external Id 2" ];
var friendProxy = bridge.getFriendServiceProxy();

var postResult = friendProxy.addFriendsFromPlatform(friendPlatform, mode, externalIds);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "friend",
    "operation": "ADD_FRIENDS_FROM_PLATFORM",
    "data": {
        "friendPlatform": "Facebook",
        "mode": "ADD",
        "externalIds": ["111234914143270", "106296724679297"]
    }
}

JSON Response

{
    "data": {
        "server_time": 1623090934620,
        "rejected": [],
        "numRejected": 0,
        "numNewAdded": 2,
        "numDeleted": 0,
        "numExisting": 0
    },
    "status": 200
}