Overview   Objects  Tree  Index  Help 
Klipfolio Dashboard API
 PREV OBJECT  NEXT OBJECT FRAMES    NO FRAMES    
SUMMARY: PROPERTY | FUNCTION DETAIL: PROPERTY | FUNCTION

Object Klip

Object
   |
   +--Klip

The Klip object is your script's globally accessible root object. It also provides access to useful text manipulation functions, such as base64encode(), md5digest(), stripTags(), and processEntities().

Properties Summary
 var alerting
          Specifies whether the Klip will alert the user, based on their settings in the 'Alert' tab of the Klip's Customize Klip window when the Klip updates.
 text progressmessage
          Displays a progress message to the user when your Klip is doing a lengthy operation.
 String searchtext
          The text in the search field currently being displayed.
 boolean searchvisible
          Adds a search field to a Klip when set to true.
 String searchwatermark
          Adds the "watermark" text to the search field.
 boolean usedefaultprogressmessages
          Tells Klipfolio Dashboard to use its built-in progress messages (default true).
   
Function Summary
 function alert( <String> text )
           Displays a message to the user in a modal dialog box.
 String base64decode( <String> source )
           Reverses a base64 encoding applied to a string (see RFC 1421).
 String base64encode( <String> source )
           Generates a base64 encoding from a text string (see RFC 1421).
 String collapseWhitespace( <String> text, [<boolean> omit_newlines] )
           Collapses all whitespace (\r \n \t or space characters) to a single space character.
 String convertToText( <String> text, [<boolean> keep_newlines] )
           Processes entities, removes XML tags, and removes whitespace for the given text.
 Timer createTimer( [<integer> interval] )
           Creates a Timer object that will call a JavaScript function every interval.
 function delay( <integer> milliseconds )
           Pauses the current JavaScript thread of execution for a number of milliseconds.
 function destroyTimer( <Timer> timerObject )
           Destroys a Timer object.
 String garble( <String> text )
           Generates an obfuscated version of a text string suitable for storage in preferences.
 function getDataPool( pool_name)
           Deprecated. As of Klipfolio Dashboard 5.0, replaced by Engines.DataPool.getPool().
 String md5digest( <String> text )
           Generates a md5digest from a text string (see RFC 1321).
 function onDrop( <String> url )
           Specifies a Handler Function to call in your JavaScript when an object is dragged and dropped into Klipfolio Dashboard.
 function onLoad()
           Specifies a Handler Function to call in your JavaScript when Klipfolio Dashboard first loads the Klip into memory.
 function onRefresh( <boolean> user_requested )
           Specifies a Handler Function to call in your JavaScript when Klipfolio Dashboard sends the Klip a refresh event.
 function onSearch()
           Specifies a Handler Function to call in your JavaScript when user presses Enter in the search field.
 function onUpgrade( [<String> version] )
           Specifies a Handler Function to call in your JavaScript when Klipfolio Dashboard is upgrading the Klip.
 String processEntities( <String> text )
           Converts XML entities into literal characters.
 function requestRefresh()
           Requests Klipfolio Dashboard to enqueue your Klip for a refresh event after it exits the current event handler.
 function setDataPool( pool_name, value )
           Deprecated. As of Klipfolio Dashboard 5.0, replaced by Engines.DataPool.setPool().
 String sha1digest( <String> text )
           Generates a sha1digest from a text string.
 String sha256digest( <String> text )
           Generates a sha256digest from a text string.
 String stripTags( <String> text )
           Strips all XML tags from a string.
 function trace( <String> text )
           Displays a message to the developer in the Debug Window.
 function traceln( <String> text )
           Displays a message followed by a carriage return and a newline (\r\n) in the Debug Window.
 String ungarble( <String> garbledtext )
           Ungarbles an a garbled string.

Properties Detail

alerting

var alerting

progressmessage

text progressmessage

searchtext

String searchtext

searchvisible

boolean searchvisible

searchwatermark

String searchwatermark

usedefaultprogressmessages

boolean usedefaultprogressmessages
Function Detail

alert

function alert( <String> text )

base64decode

String base64decode( <String> source )

base64encode

String base64encode( <String> source )

collapseWhitespace

String collapseWhitespace( <String> text, [<boolean> omit_newlines] )

convertToText

String convertToText( <String> text, [<boolean> keep_newlines] )

createTimer

Timer createTimer( [<integer> interval] )

delay

function delay( <integer> milliseconds )

destroyTimer

function destroyTimer( <Timer> timerObject )

garble

String garble( <String> text )

getDataPool

function getDataPool( pool_name)

md5digest

String md5digest( <String> text )

onDrop

function onDrop( <String> url )

onLoad

function onLoad()

onRefresh

function onRefresh( <boolean> user_requested )

onSearch

function onSearch()

onUpgrade

function onUpgrade( [<String> version] )

processEntities

String processEntities( <String> text )

requestRefresh

function requestRefresh()

setDataPool

function setDataPool( pool_name, value )

sha1digest

String sha1digest( <String> text )

sha256digest

String sha256digest( <String> text )

stripTags

String stripTags( <String> text )

trace

function trace( <String> text )

traceln

function traceln( <String> text )

ungarble

String ungarble( <String> garbledtext )
Overview   Object  Tree  Index  Help 
Klipfolio Dashboard API
 PREV OBJECT  NEXT OBJECT FRAMES    NO FRAMES    
SUMMARY: PROPERTY | FUNCTION DETAIL: PROPERTY | FUNCTION
© 2011 Klipfolio Inc. All Rights Reserved.