Gigya Job Openings

comments.vote JS

Skip to end of metadata
Go to start of metadata

Description

Votes on a specified comment or review.

 

Note: Only logged-in users are allowed to vote.

 

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 > comments.vote.

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription

commentIDstringThe identifier of the comment on which to vote.
categoryIDstringThe category identifier to which the comment on which to vote belongs.
streamIDstringThe stream identifier to which the comment on which to vote belongs.
votestringThe vote on the comment. The vote value may be one of the following:
  • "pos" - a positive vote, in favor of the specified comment.
  • "neg" - a negative vote, opposing the specified comment.
  • "none" - no vote. This will undo a previous vote on the specified comment.
callbackfunction
A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(Response).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
contextobject
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
actionAttributesJSON objectIn Gamification your users receive points for actions they perform on your site, in this case voting grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user votes, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. 
actionAttributes contain a JSON object comprised of a series of attribute keys (categories) with associated values. You can also use a generic "tags" key.

No more than three values can be given, they can be with a single key or each have their own key.

For more information see Variants and Action Attributes. Action attributes are later used to filter GM Plugins by a certain attribute.
Example:  {"<attribute key1>": ["<attribute value1>", "<attribute value2>"],  "<attribute key2>": "<attribute value3>" }

 

Response Object Data Members

FieldTypeDescription
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 Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.

 

Code Sample

var params = {
    commentID: "123456",
    categoryID: "789",  
    streamID:"abc",  
    vote: "pos"
};

gigya.comments.vote(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 gigya.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.