Gigya Job Openings

comments.deleteComment JS

Skip to end of metadata
Go to start of metadata

 

Description

This method deletes a specified comment, allowing users to delete their own comments.

Note: Only logged-in users can delete their comments.

 

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

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
UIDstringThe unique ID of a logged-in user, whose comment is to be deleted. This is the UID you receive from Gigya after a successful login of this user.
categoryIDstringThe identifier of the comments category to delete.
streamIDstringThe identifier of the comments stream to delete.
commentIDstringThe identifier of the comment to delete.

 

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 = {
    UID: "_gid_3VgBvTtCGqDTEtcZMGL08w==",
    categoryID :  "12345", 
    streamID : "abc",
    commentID : "20344085"};

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