Klipfolio Dashboard 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  = 5905-1
 Klipfolio.codepage  = 1252
 Klipfolio.corebuild = 5905
 Klipfolio.language  = English
 Klipfolio.langversion  = 1.4
 Klipfolio.version = Klipfolio Dashboard 5.5
 
(Your output will differ depending on your environment and Klipfolio Dashboard version.)

Since:
5.5. Replaced the KlipFolio object.


Properties Summary
 integer buildnum
          Returns the numeric core and manifest versions for Klipfolio Dashboard, e.g . 5905-1 (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 . 5904 (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

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.