Returns meta information of a specified commenting stream.
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.getStreamInfo.
The following table lists the available parameters:
|||categoryID||string||The identifier of the comments category to which the requested stream belongs.|
|||streamID||string||The unique ID of the stream that you would like to retrieve.|
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.
|||includeLastComment||Boolean||This parameter specifies whether to include the most recent comment in the 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 the streamInfo object (see the Response Data table and Response Example below).|
Indicates whether to return the ratingDetails object in the response. ratingDetails is an array of all dimensions and "_overall". For example:
The ratings array represents the number of users who gave a specific rating, where the position in the array represents the given rating. So in the above example, 0 users gave a rating of 1 star, 5 users gave a rating of 2 stars, 3 users gave a rating of 3 stars etc. The average of the ratings is also returned.
|||streamIDs||array or string|
A comma delimited list of stream IDs or an array of stream IDs, i.e. "['stream1','stream2']". When this parameter exists, it overrides the streamID parameter.
This parameter supports up to 100 stream IDs.
Response Object Data Members
|streamInfo||Stream info object||A JSON object containing meta information of the requested commenting stream. When multiple streamIDs are requested, the response streamInfo is an array of Stream info objects.|
|streamTags||array||An array of tags that are associated with the stream.|