comments.setUserOptions JS

Skip to end of metadata
Go to start of metadata

Description

 

Sets a comments user's subscribe settings, to be used for subscribing to comments streams by email or to follow a certain user's 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.setUserOptions.

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
replyNotificationsstringThe possible values for this parameter are:
  • "disabled" (default)
  • "immediate" -  when used, the user will receive notifications of replies to his comments, in this way "following" his comments.
notificationsEmailstringThe email address to which to send the notification.
notificationsLanguagestringDefault value is "en" (English). The language to be used by comment email templates.

 

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 = {
  notificationsEmail: " tanya@gmail.com"
};

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