API Reference

Friends.addFriend

Adds a new friend-relationship between two users.

Syntax

bool friends.addFriend ( int uid1, int uid2 = NULL, bool autoConfirm = false, bool twoWay = true )

Arguments

Name	Type	Required	Default value	Description
uid1	int	Required	none	The ID of the user that will be added as a friend
uid2	int	Optional	NULL	If uid2 is not specified the current logged in user will be used here
autoConfirm	bool	Optional	false	Set this to true to automatically confirm the friend-relationship status
twoWay	bool	Optional	true	Make the friendship bidirectional

Response

Upon success the response will be 1.

Name	Type	Description
response	INT	The response will be 1.

Sample Response

Code examples

PHP-RPC

$path = 'https://api.newspark.ca/services/php';

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'friends.addFriend',
  'uid1' => $uid1,
  'uid2' => $uid2,
  'autoConfirm' => $autoConfirm,
  'twoWay' => $twoWay
);

// http_build_query basically turns an array into a url-encoded list of variables
$url = $path .'?' . http_build_query($arguments,null,'&');

// get the contents from the specified url
$data = file_get_contents($url);

// transform it back into php data structures
$data = unserialize($data);

// the actual data is stored in $data['result']

print_r($data['result']);

PEAR XMLRPC client

// Include the client
require_once 'XML/RPC.php';

// Create the XMLRPC Client
$client = new XML_RPC_Client('/services/xmlrpc?APIKEY={YOURAPIKEY}', 'api.newspark.ca');

// PEAR's XML-RPC client requires all arguments to wrapped in a special value class
// XML_RPC_encode converts this automatically

$arguments = array(
  XML_RPC_encode($uid1),
  XML_RPC_encode($uid2),
  XML_RPC_encode($autoConfirm),
  XML_RPC_encode($twoWay)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('friends.addFriend',$arguments);

// Sending the message to the server
$response = $client->send($message);

// We also need to decode the response back to normal PHP types
$response = XML_RPC_decode($response);

print_r($response);

SabreTooth XMLRPC client

// Include the client
require_once 'Sabre/XMLRPC/Client.php';

// Create the XMLRPC Client
$xmlrpc = new Sabre_XMLRPC_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $uid1,
  $uid2,
  $autoConfirm,
  $twoWay
);

$data = $xmlrpc->invoke('friends.addFriend',$arguments);

print_r($data);

Zend XMLRPC client

// Include the client
require_once 'Zend/XmlRpc/Client.php';

// Create the XMLRPC Client
$client = new Zend_XmlRpc_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $uid1,
  $uid2,
  $autoConfirm,
  $twoWay
);

$data = $client->call('friends.addFriend',$arguments);

print_r($data);

Actionscript 2

    /*
     *     In ActionScript 2 remote service calls are done using the RemotingConnector Component.
     *     An instance of the component must exist on the stage and have an instance name.
     *
     *     Results and Faults are handled by addEventListener's and the call parameters are placed inside of an associative array
     *
     *     You must also specify the service class and method names under the appropriate property fields of the component
     */

    var gatewayURL:String = "/services/amf2";
    //Set up service call
    myRemConn_rc.gatewayUrl = gatewayURL;
    myRemConn_rc.serviceName = "friends";
    myRemConn_rc.methodName = "addFriend";
    myRemConn_rc.params = {uid1:uid1, uid2:uid2, autoConfirm:autoConfirm, twoWay:twoWay};
    myRemConn_rc.addEventListener("result", widgetResult);
    myRemConn_rc.addEventListener("status", widgetFault);

    //Make the call
    myRemConn_rc.trigger();

    /*
    *  Handles service result.
    */
    function widgetResult(ev:Object){
        //Do stuff
        //Data is returned inside of ev.target.results
        //(i.e. ev.traget.results.description or ev.traget.results.settings.color)
    }

    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object){
        //Display Error
        trace("Categories Error - " + ev.code + " -  " + ev.data.faultstring);
    }

Actionscript 3

    /*
     *  In ActionScript 3 remote service calls are done using the NetConnection Object.
     *  A Responder Object controls what functions handle successful or failed calls
     *  and any parameters for the call are placed in an array and passed as a parameter
     *  in the NetConnection.call() method.
     */

    var gatewayURL:String = "/services/amf2";
    var parameters:Array = new Array(uid1, uid2, autoConfirm, twoWay);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("friends.addFriend", new Responder(widgetResult, widgetFault), parameters);


    /*
     *   Handles service result.
     */
    function widgetResult(ev:Object):void{
        //Do stuff
        //Data is returned inside of ev
        //(i.e. ev.description or ev.settings.color)
    }


    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object):void{
        //Display Error
        error.showError(parentClip, ev.code + " -  " + ev.description, "Please refresh your browser to try again.");
        error.x = (parentClip.width - error.width) / 2;
        error.y = (parentClip.height - error.height) / 2;
    }

REST service example

<%@ Page Language="vb" %>
<%


' REST gateway
dim gateway as string = "http://api.newspark.ca/services/rest/"

' Service + method we're calling.
dim method as string = "friends/addFriend"

dim apiKey as string = "YOURAPIKEY"

dim url as string = gateway & method & "?APIKEY=" & apiKey &  "&uid1=" & uid1

' HTTP Client
dim wcHTTPScrape as new System.net.WebClient()

' Opening a stream
dim objInput as System.IO.Stream = wcHTTPScrape.OpenRead(url)

dim objReader as new System.IO.StreamReader ( objInput )

' Reading the entire HTTP response and output it
Response.Write ( objReader.ReadToEnd () )


objReader.Close ()
objInput.Close ()

%>

jQuery JSON

/*
* jQuery post example
*/

function addFriend ( uid1, uid2, autoConfirm, twoWay ) {

var params = {
    "method" :      'friends.addFriend',
    "uid1" :        uid1,
    "uid2" :        uid2,
    "autoConfirm" : autoConfirm,
    "twoWay" :      twoWay}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Local API

// Get the Service Mapper

$mapper = Sabre_ServiceMap_Mapper::getMapper();

// Calling the method
$data = $mapper->friends->addFriend( $uid1, $uid2, $autoConfirm, $twoWay );

print_r($data);

0 comments

Be the first to comment on addFriend.

Developer Documentation Portal