Stream JS

Skip to end of metadata
Go to start of metadata

Description

 

A JSON object containing meta information of a commenting stream.

Field NameTypeDescription
streamIDstringA unique stream ID.
statusstringThe value of this field may be one of the following: 'readonly', 'enabled', or 'disabled'.
streamURLURLThe stream URL assigned to the commenting stream (usually the URL of the page where the commenting stream is presented). For more information, see the Comments add-on parameters.
streamTitlestringThe title assigned to the commenting stream. For more information, see the Comments add-on parameters.
moderationModestring
The value set for the stream moderation mode. May be one of the following values:
  • inherit - the stream will use the category moderation mode settings (this is the default if not set) 
  • pre - all comments will be pending moderator approval
  • post - all comments will be approved automatically (per spamming & other auto moderation rules)
  • guest - all comments submitted by guests will remain hidden until moderation
timestamplongThe GMT in which the stream was created. The timestamp is in Unix Time (i.e. the number of seconds since Jan. 1st 1970). 
firstCommentTSlongThe GMT in which the first comment was posted to the stream. The timestamp is in Unix Time (i.e. the number of seconds since Jan. 1st 1970). 
lastCommentTSlongThe GMT in which the last comment was posted to the stream. The timestamp is in Unix Time (i.e. the number of seconds since Jan. 1st 1970). 
totalCommentsCountintegerThe number of comments in the stream.

Note: A field that does not contain data, will not appear in the object.

Example Object

{
     "streamID": "foo1",
     "status": "enabled",
     "streamURL": "http://wildfiresocial.com/Foo.htm",
     "streamTitle": "Foo",
     "moderationMode": "inherit",    
     "timestamp": 1297087491153,
     "firstCommentTS": 1375877442,
     "lastCommentTS": 1376211780,
     "totalCommentsCount": 56
}