comments.subscribe JS

Skip to end of metadata
Go to start of metadata

Description

 

Allows a user to subscribe to a comments stream by email notification.

 

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

Syntax

 

Parameters

The following table lists the available parameters:

    lang    string    The language to be used by comment email templates for comment stream subscription emails and comment reply notification emails.

RequiredNameTypeDescription
categoryIDstringThe identifier of the comment category to which the user subscribes.
streamIDstringThe identifier of the comment stream to which the user subscribes.
emailstringThe email address to which to send the notification. If the user is a guest, then this field is Required. If the user is logged in this email address overrides the address stored in the userOptions object (see comments.setUserOptions).
langstringDefault 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 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.
unsubscribeTokenstringA secured ticket that can be used to unsubscribe the user from the comments stream.

 

Code Sample

var params = {
  categoryID: "789",  
    streamID: "abc",  
    email: "tanya@gmail.com"
};

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