Gigya Job Openings

comments.updateComment JS

Skip to end of metadata
Go to start of metadata

Description

This method allows updating of an existing comment.

 

Note: This method is available to moderators only, unless user editing is enabled. When user editing is enabled, whether through the comments.setCategoryInfo API method or via the Comments Settings in the console, users can edit the following fields: commentText, commentTitle, ratings, mediaItems and taggedUsers.

 

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.updateComment.

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
categoryID
stringThe identifier of the comments category to which you would like to update the comment.
streamIDstringThe identifier of the comments stream to which you would like to update the comment. 
commentID
stringThe identifier of the comment you would like to update.
commentText
stringChange the comment text to this string. The string may be up to 5000 characters long. Allowed HTML elements: div, br, p, span - always allowed; ul, li, u, b, i, em - allowed when RichText is enabled. Other than these exceptions, the text is sanitized and all other HTML elements are removed.
commentTitle
stringChange the comment title to this string.
ratings
JSON objectAn object that redefines user ratings for this stream. The object structure is: {'_overall': ratingValue}, where ratingValue is an integer between 1-5.
Old values are overwritten by new ones. To reset a dimension's value, pass a null value to that dimension.
mediaItems
arrayAn array of URLs of media items to attach to the comment. This parameter is only accepted if clientSettings.enableMediaItems is set to true for the category via comments.setCategoryInfo.
taggedUsersarrayAn array of users (UIDs) tagged in the comment body. The taggedUsers array replaces the users that are tagged in the comment.
The comment body should have special markup elements that refer to the index of the tagged user in the array. Nulls are allowed members of the array. This parameter is only accepted if clientSettings.enableUserTagging is set to true for the category via comments.setCategoryInfo.

 

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.
commentComment objectThe posted comment. The comment is returned only if it has been approved.

 

Code Sample

var params = {
    categoryID: "12345", 
    streamID:"abc",
    commentID: "1000",
    commentText: "I love this!"};

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