Site:API

From Metrixstream
(Difference between revisions)
Jump to: navigation, search
(Created page with "= Forums = == Add Forum == This callback allows you know when the media player is done with playback for the current media. === Parameters === ;obj :this is an object. :;mode...")
 
(Add Forum)
Line 3: Line 3:
 
== Add Forum ==
 
== Add Forum ==
  
This callback allows you know when the media player is done with playback for the current media.
+
This API call is responsible for adding a forum to a site.
  
=== Parameters ===
+
=== Security ===
  
;obj
 
:this is an object.
 
:;mode
 
::the mode param has the following values: pre and post. The pre value is before the next transition begins and the post value is after the next transition begins.
 
:;playState
 
::this is actual state of the playback. Possible values are pre, play, or post. The pre/post roll functionality uses pre and post values.
 
:;playerId
 
::this is the HTML DOM id of the media player.
 
  
=== Example Usage ===
+
=== Parameters ===
 +
 
 +
;action=forum
 +
;verb=addforum
 +
;title
 +
:required
 +
;description
 +
:optional
 +
;layout
 +
:optional
 +
;label
 +
:optional
 +
;canonical_id
 +
:optional; if left blank, this is calculated for you.
  
<script type="text/javascript">
+
=== Successful Response ===
  
function metrix_onComplete(obj) {
+
;status=ok
  alert("This player is done playing.");
+
;item
  return true;
+
::;forum
}
+
::::;id
 +
::::;canonical_id

Revision as of 17:30, 10 April 2012

Contents

Forums

Add Forum

This API call is responsible for adding a forum to a site.

Security

Parameters

action=forum
verb=addforum
title
required
description
optional
layout
optional
label
optional
canonical_id
optional; if left blank, this is calculated for you.

Successful Response

status=ok
item
forum
id
canonical_id
Personal tools