Klipfolio Dashboard API

Object KlipFolio

Object
   |
   +--Klip
         |
         +--KlipFolio

Deprecated. The KlipFolio object (with an upper-case F) is deprecated as of version 5.5. Use Klipfolio (with a lower-case f) instead.

The KlipFolio object (with an upper-case F) provides an API to access information about the Klipfolio Dashboard application from your Klip.

Example:

The following Klip queries Klipfolio Dashboard about its runtime environment.
<klip>
	<identity>
		<title>
		API: KlipFolio
		</title>
	</identity>
	<locations>
		<icon>
		http://www.klipfolio.com/static/klips/klipfolio/sample_icon.png
		</icon>
		<banner>
		http://www.klipfolio.com/static/klips/klipfolio/sample_banner.png   
		</banner>
	</locations>
	<klipscript>
	<![CDATA[

	function onLoad() {
		traceln( "KlipFolio.buildnum  = " + KlipFolio.buildnum );
		traceln( "KlipFolio.codepage  = " + KlipFolio.codepage );
		traceln( "KlipFolio.corebuild = " + KlipFolio.corebuild );
		traceln( "KlipFolio.language  = " + KlipFolio.language );
		traceln( "KlipFolio.langversion  = " + KlipFolio.langversion );
		traceln( "KlipFolio.version = " + KlipFolio.version );
	}

	function onRefresh() {
		var xml = "<xml><item><link></link><description>" +
		"(See Debug Window for output)" +
		"</description></item></xml>";
	
	return Engines.Data.process( xml );

	}
	]]>
	</klipscript>
</klip>

     	

   
Upon loading, Klipfolio Dashboard will display the following output in the Debug Window.

 KlipFolio.buildnum  = 5903-8
 KlipFolio.codepage  = 1252
 KlipFolio.corebuild = 5903
 KlipFolio.language  = English
 KlipFolio.langversion  = 1.4
 KlipFolio.version = Klipfolio 5.3
 
(Your output will differ depending on your environment and Klipfolio Dashboard version.)


Properties Summary
 integer build
          Deprecated. As of version 5.5, replaced by Klipfolio.corebuild.
 integer buildnum
          Deprecated. As of version 5.5, replaced by Klipfolio.buildnum.
 integer codepage
          Deprecated. As of version 5.5, replaced by Klipfolio.codepage.
 integer corebuild
          Deprecated. As of version 5.5, replaced by Klipfolio.corebuild.
 String language
          Deprecated. As of version 5.5, replaced by Klipfolio.language.
 integer langversion
          Deprecated. As of version 5.5, replaced by Klipfolio.langversion.
 String version
          Deprecated. As of version 5.5, replaced by Klipfolio.version.
   

Properties Detail

build

integer build

buildnum

integer buildnum

codepage

integer codepage

corebuild

integer corebuild

language

String language

langversion

integer langversion

version

String version

Klipfolio Dashboard API

© 2011 Klipfolio Inc. All Rights Reserved.