Klipfolio Dashboard 5 API

Object KlipFolio

Object
   |
   +--Klip
         |
         +--KlipFolio

The KlipFolio object 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 Klipfolio Dashboard 5.3, replaced by KlipFolio.corebuild.
 integer buildnum
          Returns the numeric core and manifest versions for Klipfolio Dashboard, e.g . 5903-8 (read-only).
 integer codepage
          Returns numeric codepage of the local language for Klipfolio Dashboard (read-only).
 integer corebuild
          Returns the numeric core version for Klipfolio Dashboard, e.g . 5903 (read-only).
 String language
          Returns the English name of the local language currently in use (read-only).
 integer langversion
          Returns the version string of the local language currently in use (read-only).
 String version
          Returns the full version text for Klipfolio Dashboard (read-only).
   

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 5 API

© 2010 Klipfolio Inc. All Rights Reserved.