Gigya Job Openings

comments.setStreamInfo JS

Skip to end of metadata
Go to start of metadata

Description

 

Sets meta information of a specified commenting stream for the usage of RSS.

 

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

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
categoryIDstringThe identifier of the comments category to which the stream of discussion belongs.
streamTitlestringThe title assigned to the commenting stream. This title you assign here will be assigned to each comment posted to be used for RSS & HTML outputs.
streamURLstringThe stream URL assigned to the commenting stream (usually the URL of the page where the commenting stream is presented). This URL you assign will be assigned to each comment posted to be used for RSS & HTML outputs. This URL will link back from the RSS or HTML page to the original post where the comment was added.
Note: Gigya will verify that the streamURL belongs to your site (as configured for your API key in the Administration Console page on Gigya's website).
streamIDstringThe unique ID of the stream to which you would like to set information. Note: the string is limited to 150 characters and is case sensitive.
streamInfoSigstringThis field is not required the first time this method is called, when the streamTitle and streamURL fields in Gigya's DB are empty. Gigya requires this call to be signed, when overriding existing values.
Calculate the signature (SHA1 signature) in the same manner as described under Generating the Signature section, using the following base string “categoryID_streamID_streamTitle_streamURL”.
streamTagsarray
or
string
Either a comma separated list or an array of tags (strings) that should be associated with the stream. The tags you assign here will be assigned to the stream, to be used to filter the top streams in comments.getTopStreams.
moderationModesObject

An object containing string values that specify the moderation mode for different comments according to their content type (see Moderation Modes for more information).

{
    "text": "post|pre|guest|inherit",
    "image": "post|pre|guest|inherit",
    "video": "post|pre|guest|inherit",
    "url": "post|pre|guest|inherit",
    "other": "post|pre|guest|inherit"
}

When using this field, it is not necessary to set the moderation mode for all content types. Content types that are not referred to will retain their previous moderation state. The default state for each content type is "inherit" (the stream will use the category moderation mode settings). 

moderationModestringDeprecated. Use moderationModes instead.

 

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 = {
    categoryID: "12345",
    streamID: "abc",
    streamTitle: "Today's story",
    streamURL: "http://yousite.com/TodaysStory.htm"
};

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