Was this article helpful?

socialize.getReactionsCount

Last modified 15:13, 17 Mar 2013

Description

The method retrieves the number of times certain reaction buttons were clicked.
 

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to REST API > socialize.getReactionsCount.

 

Syntax

gigya.socialize.getReactionsCount(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Required barID string A unique identifier of the reactions bar that identifies the content item to which the user reacted. 
Optional buttonIDs string A comma delimited list of button IDs, which identify the buttons in the reactions bar. When not specified, the method gets the counts for all the buttons previously reported for this bar. Note that buttons with 0 count will not be returned unless specifically specified.

 

Response Object Data Members

Field Type Description
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
operation string The name of the API method that generated this response.
context object The context object passed by the application as parameter to the API method, or null if no context object has been passed.
counts array Array of JSON objects, each contains the following fields: 'buttonId' and 'count'.


Note: A field that does not contain data, will not appear in the response.

 

Code Sample

function printResponse(response) { 
    if ( response.errorCode == 0 ) {            
        var myCounts = response['counts'];         
        if ( null!=myCounts && myCounts.length>0) {       
            var msg = 'Reaction Counts: \n';       
     for (var index in myCounts) {
                msg += myCounts[index].buttonId + ': ' + myCounts[index].count + '\n';
            }
            alert(msg);
        }
        else {
            alert('No Counts were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}


var params ={
barID:'myID',
callback:printResponse
};


gigya.socialize.getReactionsCount(params);

Notes:
  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the socialize.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider? prior to calling the API method. You can learn more in the Social Login guide.

Was this article helpful?
Page statistics
2258 view(s) and 3 edit(s)
Social share
Share this page?

Tags

This page has no custom tags set.

Comments

You must to post a comment.

Attachments