API Reference

Media.logShare

Syntax

media.logShare ( int mid, string sharetype, mixed post = NULL, int uid = 1, string logShareSetting = 'AnonMultShares' )

Arguments

Name	Type	Required	Default value	Description
mid	int	Required	none	The id of the media you want to log a share for.
sharetype	string	Required	none	The share type, which can be one of the following: 'facebook share','facebook like','linkedin','twitter','pinterest','googleplus','digg'.
post	mixed	Optional	NULL	This field contains any information that you want to store that is a result of the share.
uid	int	Optional	1	The id of the user of the logshare.
logShareSetting	string	Optional	'AnonMultShares'	The log share setting: can be one of the following: 'AnonMultShares' - anonymous users are allowed multiple shares (This is the default for anonymous users) 'Anon0Shares' - anonymous users are not allowed any shares 'LoggedIn1Share' - logged in users are allowed only 1 share 'LoggedInMultShares' - logged in users are allowed multiple shares

Sharetype parameters

A list of the different sharetypes that can be passed to this method.

Name	Type	Description
facebook	STRING	Use this share type when logging a Facebook share.
linkedin	STRING	This is for a LinkedIn share event, obviously it too can be logged.
twitter	STRING	Twitter is another share type that can be logged.
pinterest	STRING	Pinterest is another share type that can be logged.
reddit	STRING	This is a Google+ share event that can be logged.
digg	STRING	This is a Digg share event that can be logged.
stumbleupon	STRING	This is a stumbleupon based share that can be logged.
delicious	STRING	This is a delicious based share that can be logged.
email	STRING	This is an email based share that can be logged.

Response

The response returned on success and failure of media update.

Name	Type	Description	Possible Values
result	String	The returned result of the request to log a share. Returns 1 upon success; upon failure, the error is returned.	true / Error type
status	boolean	The status of the request as a whole. Unrelated to the success of updating the media item but rather was the request executed in full.	true/false

Sample Response

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'media.logShare',
  'mid' => $mid,
  'sharetype' => $sharetype,
  'post' => $post,
  'uid' => $uid,
  'logShareSetting' => $logShareSetting
);

// 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($mid),
  XML_RPC_encode($sharetype),
  XML_RPC_encode($post),
  XML_RPC_encode($uid),
  XML_RPC_encode($logShareSetting)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('media.logShare',$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(
  $mid,
  $sharetype,
  $post,
  $uid,
  $logShareSetting
);

$data = $xmlrpc->invoke('media.logShare',$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(
  $mid,
  $sharetype,
  $post,
  $uid,
  $logShareSetting
);

$data = $client->call('media.logShare',$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 = "media";
    myRemConn_rc.methodName = "logShare";
    myRemConn_rc.params = {mid:mid, sharetype:sharetype, post:post, uid:uid, logShareSetting:logShareSetting};
    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(mid, sharetype, post, uid, logShareSetting);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("media.logShare", 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 = "media/logShare"

dim apiKey as string = "YOURAPIKEY"

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

' 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 logShare ( mid, sharetype, post, uid, logShareSetting ) {

var params = {
    "method" :      'media.logShare',
    "mid" :         mid,
    "sharetype" :   sharetype,
    "post" :        post,
    "uid" :         uid,
    "logShareSetting" : logShareSetting}

$.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->media->logShare( $mid, $sharetype, $post, $uid, $logShareSetting );

print_r($data);

0 comments

Be the first to comment on logShare.

Developer Documentation Portal