Gigya Job Openings

comments.getTopStreams JS

Skip to end of metadata
Go to start of metadata

Description

 

The method retrieves the most commented streams in the recent defined time period. The method retrieves only streams that were created within the past predefined number of days.
 

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

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
categoryIDstringThe identifier of the comments category from which to retrieve the top streams.
If this parameter is not specified, the method returns all site top streams (of all categories).
limitintegerThe maximum number of streams to retrieve. The default is 20 streams. The maximum is 100.
maxStreamAgeintegerThe number of days. The method retrieves only streams that were created within the past maxStreamAge days. The default is 3 days. The maximum is 7 days.
includeLastCommentBooleanThis parameter specifies whether to include the most recent comment in each stream. The default value of this parameter is 'false'. If this parameter is set to 'true', the response of this method includes a 'lastComment' field in each of the stream objects (see the Response Data table and Response Example below).
callbackfunction
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.
contextobject
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
streamTagstringThis parameter is used to filter the top streams. The method returns only streams that are associated with this tag.

 

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.
streamsArray of Stream info objectsAn array listing the streams. Each stream is represented by a Stream info object.

 

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) {             
        if ( null!=response.streams && response.streams.length>0) {        
            var msg = 'My top commenting stream is:\n\n';        
            msg += 'Stream title: ' + response.streams[0].<font>streamTitle</font><font> + </font>',  RSS URL: ' + response.streams[0].<font>rssURL;
            </font>alert(msg);
        }
        else {
            alert('No streams were returned');
        }
    } else {
        alert('Error :' + response.errorMessage);
    }
}

var params = {
    callback:printResponse
};

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