Flags a specified comment. Gigya's commenting service allows users to flag specific comments that they find offensive or inappropriate. A comment cannot be flagged twice. To learn more about flagging comments and moderation, please refer to the Flagging section Comments Moderation guide.
Note: The method returns an error if the comment had been approved by the moderator after previous flagging.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer toREST API > comments.flagComment.
The following table lists the available parameters:
|||commentID||string||The identifier of the comment to flag.|
|||categoryID||string||The category identifier to which the comment to flag belongs.|
|||streamID||string||The stream identifier to which the comment to flag belongs.|
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.
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
|||actionAttributes||JSON object||In Gamification users receive points for actions they perform on your site, in this case flagging a comment 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 actionAttributes here, the comment action also receives an attribute, for example "tv-show":"glee". |
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.
Response Object Data Members