Klipfolio Dashboard 5 API
   A B C D E F G H I K L M N O P Q R S T U V X

- class
 

A

Actions - class Actions
 
Actions() - Constructor in class Actions
 
Actions.Button - class Actions.Button
 
Actions.Button() - Constructor in class Actions.Button
 
Actions.Window - class Actions.Window
 
Actions.Window() - Constructor in class Actions.Window
 
Actions.Window.Back - class Actions.Window.Back
 
Actions.Window.Back() - Constructor in class Actions.Window.Back
 
Actions.Window.Done - class Actions.Window.Done
 
Actions.Window.Done() - Constructor in class Actions.Window.Done
 
Actions.Window.Next - class Actions.Window.Next
 
Actions.Window.Next() - Constructor in class Actions.Window.Next
 
acceptgzip - Instance field in class Engines.HTTP.HTTPRequest
 
actions( text1, function1[, text2, function2, ...]) - Instance method in class Items
 
actions( text1, function1[, text2, function2, text3, function3, ...]) - Instance method in class Item
 
addButton( label ) - Instance method in class Page
 
addButton( label ) - Instance method in class Tab
 
addCheckbox( label ) - Instance method in class Page
 
addCheckbox( label ) - Instance method in class Tab
 
addComboBox( [item1] [, item2] [, etc ...] ) - Instance method in class Tab
 
addComboBox( item1 [, item2] [, ...] ) - Instance method in class Page
 
addItem( name ) - Instance method in class ComboBox
 
addItem( name, [checked, [selected]] ) - Instance method in class ListControl
 
addListControl( [checked [, multiselect [, item1 [, item2 [, etc ...]]]]] ) - Instance method in class Page
 
addListControl( [checked [, multiselect [, item1 [, item2 [, etc ...]]]]] ) - Instance method in class Tab
 
addPage( pageName ) - Instance method in class Stack
 
addSpacer( [line] ) - Instance method in class Page
 
addSpacer( [line] ) - Instance method in class Tab
 
addStack( stack_name ) - Instance method in class Actions.Window
 
addTab( name ) - Instance method in class Setup
 
addText( label ) - Instance method in class Page
 
addText( label ) - Instance method in class Tab
 
addTextArea( [text] ) - Instance method in class Page
 
addTextArea( [text] ) - Instance method in class Tab
 
addTextField( text [, obscured] ) - Instance method in class Page
 
addTextField( text [, obscured] ) - Instance method in class Tab
 
alert( text ) - Instance method in class Klip
 
alerting - Instance field in class Item
 
alerting - Instance field in class Klip
 
applyStyle( URL_or_data, stylesheet ) - Instance method in class Engines.Data
 
archive - Instance field in class File
 
attributes - Instance field in class File
 
autoredirect - Instance field in class Engines.HTTP.HTTPRequest
 
autoremove - Instance field in class Item
 
autoremove - Instance field in class Items
 
autosort - Instance field in class Engines.Data
 
autosort - Instance field in class Engines.KlipFood
 

B

Button - class Button
 
Button() - Constructor in class Button
 
back - Instance field in class Page
 
banner - Instance field in class Items
 
base64decode( source ) - Instance method in class Klip
 
base64encode( source ) - Instance method in class Klip
 
bevel - Instance field in class Spacer
 
binary - Instance field in class Engines.HTTP.HTTPRequest
 
binarypost - Instance field in class Engines.HTTP.HTTPRequest
 
build - Instance field in class KlipFolio
 

C

Checkbox - class Checkbox
 
Checkbox() - Constructor in class Checkbox
 
ComboBox - class ComboBox
 
ComboBox() - Constructor in class ComboBox
 
cached - Instance field in class Engines.HTTP.HTTPRequest
 
call( command, soap_request ) - Instance method in class Engines.SOAP.SOAPClient
 
canalert - Instance field in class Items
 
candelete - Instance field in class Item
 
canpurge - Instance field in class Item
 
canvisit - Instance field in class Item
 
charsetToCodepage( charset ) - Instance method in class Engines.MIME
 
checked - Instance field in class Checkbox
 
clear( [permanently] ) - Instance method in class Items
 
clear() - Instance method in class ComboBox
 
clear() - Instance method in class Items.Deleted
 
clear() - Instance method in class ListControl
 
clear304cache() - Instance method in class Engines.HTTP
 
clearSelection() - Instance method in class ListControl
 
close() - Instance method in class Setup
 
close() - Instance method in class TCPConnection
 
codepage - Instance field in class KlipFolio
 
codepage - Instance field in class Prefs
 
collapseWhitespace( text, [omit_newlines] ) - Instance method in class Klip
 
compressed - Instance field in class File
 
connect() - Instance method in class Engines.ODBC
 
contentsource - Instance field in class Prefs
 
convertText( encoded_text, encoding_codepage, desired_codepage ) - Instance method in class Engines.MIME
 
convertToText( text, [keep_newlines] ) - Instance method in class Klip
 
cookie - Instance field in class Engines.HTTP.HTTPRequest
 
cookie - Instance field in class Engines.HTTP.HTTPResponse
 
createService( url ) - Instance method in class Engines.ReportingServices
 
createTimer( [interval] ) - Instance method in class Klip
 
creation - Instance field in class File
 
creation - Instance field in class Item
 

D

data - Instance field in class Engines.HTTP.HTTPResponse
 
data - Instance field in class Engines.SOAP.SOAPResponse
 
decodeDate( RFC882_date ) - Instance method in class Engines.MIME
 
decodeHeader( text ) - Instance method in class Engines.MIME
 
defaultlink - Instance field in class Prefs
 
delItem( name | index ) - Instance method in class ComboBox
 
delPref( name ) - Instance method in class Prefs
 
delay( milliseconds ) - Instance method in class Klip
 
destroyTimer( timerObject ) - Instance method in class Klip
 
device - Instance field in class File
 
disabled - Instance field in class Actions.Window.Back
 
disabled - Instance field in class Actions.Window.Done
 
disabled - Instance field in class Actions.Window.Next
 
disabled - Instance field in class Button
 
disabled - Instance field in class Checkbox
 
disabled - Instance field in class ComboBox
 
disabled - Instance field in class ListControl
 
disabled - Instance field in class TextArea
 
disabled - Instance field in class TextField
 
disconnect() - Instance method in class Engines.ODBC
 
done - Instance field in class Page
 

E

Engines - class Engines
 
Engines() - Constructor in class Engines
 
Engines.Data - class Engines.Data
 
Engines.Data() - Constructor in class Engines.Data
 
Engines.DataPool - class Engines.DataPool
 
Engines.DataPool() - Constructor in class Engines.DataPool
 
Engines.File - class Engines.File
 
Engines.File() - Constructor in class Engines.File
 
Engines.HTTP - class Engines.HTTP
 
Engines.HTTP() - Constructor in class Engines.HTTP
 
Engines.HTTP.HTTPRequest - class Engines.HTTP.HTTPRequest
 
Engines.HTTP.HTTPRequest() - Constructor in class Engines.HTTP.HTTPRequest
 
Engines.HTTP.HTTPResponse - class Engines.HTTP.HTTPResponse
 
Engines.HTTP.HTTPResponse() - Constructor in class Engines.HTTP.HTTPResponse
 
Engines.KlipFood - class Engines.KlipFood
 
Engines.KlipFood() - Constructor in class Engines.KlipFood
 
Engines.MIME - class Engines.MIME
 
Engines.MIME() - Constructor in class Engines.MIME
 
Engines.ODBC - class Engines.ODBC
 
Engines.ODBC() - Constructor in class Engines.ODBC
 
Engines.ODBC.ODBCResponse - class Engines.ODBC.ODBCResponse
 
Engines.ODBC.ODBCResponse() - Constructor in class Engines.ODBC.ODBCResponse
 
Engines.Platform - class Engines.Platform
 
Engines.Platform() - Constructor in class Engines.Platform
 
Engines.ReportingServices - class Engines.ReportingServices
 
Engines.ReportingServices() - Constructor in class Engines.ReportingServices
 
Engines.SOAP - class Engines.SOAP
 
Engines.SOAP() - Constructor in class Engines.SOAP
 
Engines.SOAP.SOAPClient - class Engines.SOAP.SOAPClient
 
Engines.SOAP.SOAPClient() - Constructor in class Engines.SOAP.SOAPClient
 
Engines.SOAP.SOAPResponse - class Engines.SOAP.SOAPResponse
 
Engines.SOAP.SOAPResponse() - Constructor in class Engines.SOAP.SOAPResponse
 
Engines.TCP - class Engines.TCP
 
Engines.TCP() - Constructor in class Engines.TCP
 
editable - Instance field in class ListControl
 
encryted - Instance field in class File
 
exists - Instance field in class File
 
expiredeleteditems( index | object ) - Instance method in class Items.Deleted
 
expiry - Instance field in class Items.Deleted
 

F

File - class File
 
File() - Constructor in class File
 
findItemByIID( iid ) - Instance method in class Items
 
firstinstall - Instance field in class Prefs
 
format - Instance field in class Engines.Data
 
format - Instance field in class Engines.KlipFood
 

G

garble( text ) - Instance method in class Klip
 
getAvailableKBytes() - Instance method in class Engines.Platform
 
getCPUUsage() - Instance method in class Engines.Platform
 
getClipboardURL() - Instance method in class Engines.Platform
 
getContent( content_tag_name ) - Instance method in class Prefs
 
getData( name [, n] | index ) - Instance method in class Item
 
getDataCount - Instance field in class Item
 
getDataPool( pool_name) - Instance method in class Klip
 
getLastError() - Instance method in class Engines.ReportingServices
 
getPool( pool_name) - Instance method in class Engines.DataPool
 
getPref( name ) - Instance method in class Prefs
 
getScratch( xml_element ) - Instance method in class Engines.Data
 
getScratch( xml_element ) - Instance method in class Engines.KlipFood
 
getSelected( index ) - Instance method in class ListControl
 
getState( index ) - Instance method in class ListControl
 
getXML() - Instance method in class Engines.ReportingServices
 
globalactions( text1, function1[, text2, function2, ...]) - Instance method in class Items
 

H

hasData( property ) - Instance method in class Item
 
headers - Instance field in class Engines.HTTP.HTTPRequest
 
headers - Instance field in class Engines.HTTP.HTTPResponse
 
hidden - Instance field in class File
 
hidden - Instance field in class Item
 
hide() - Instance method in class Actions.Button
 
hide() - Instance method in class Actions.Window
 
hide() - Instance method in class Stack
 

I

Item - class Item
 
Item() - Constructor in class Item
 
Items - class Items
 
Items() - Constructor in class Items
 
Items.Deleted - class Items.Deleted
 
Items.Deleted() - Constructor in class Items.Deleted
 
icon - Instance field in class Items
 
iconAlt - Instance field in class Items
 
iconvisible - Instance field in class Items
 
ignoreencoding - Instance field in class Engines.Data
 
ignoreencoding - Instance field in class Engines.KlipFood
 
insertTab( index, name ) - Instance method in class Setup
 
isConnected() - Instance method in class TCPConnection
 
itemdepth - Instance field in class Engines.Data
 

K

Klip - class Klip
 
Klip() - Constructor in class Klip
 
KlipFolio - class KlipFolio
 
KlipFolio() - Constructor in class KlipFolio
 

L

ListControl - class ListControl
 
ListControl() - Constructor in class ListControl
 
language - Instance field in class KlipFolio
 
langversion - Instance field in class KlipFolio
 
lastaccess - Instance field in class File
 
lastmodified - Instance field in class File
 
lastmodified - Instance field in class Item
 
lastrefresh - Instance field in class Prefs
 
launchDefaultBrowser( url ) - Instance method in class Engines.Platform
 
launchDefaultMailClient() - Instance method in class Engines.Platform
 
length - Instance field in class ComboBox
 
length - Instance field in class Engines.HTTP.HTTPResponse
 
length - Instance field in class Items
 
length - Instance field in class Items.Deleted
 
length - Instance field in class ListControl
 
length - Instance field in class Prefs
 
length - Instance field in class Setup
 
length - Instance field in class Tab
 
loadReport( path ) - Instance method in class Engines.ReportingServices
 
loading - Instance field in class Prefs
 

M

maxsize - Instance field in class Engines.HTTP.HTTPRequest
 
md5digest( text ) - Instance method in class Klip
 
method - Instance field in class Engines.HTTP.HTTPRequest
 

N

name - Instance field in class File
 
name - Instance field in class Tab
 
namespace - Instance field in class Engines.SOAP.SOAPClient
 
namespaceUri - Instance field in class Engines.SOAP.SOAPClient
 
newClient( url ) - Instance method in class Engines.SOAP
 
newConnection( host, port ) - Instance method in class Engines.TCP
 
newConnectionnewDataSource( connectionstring ) - Instance method in class Engines.ODBC
 
newRequest( url ) - Instance method in class Engines.HTTP
 
next - Instance field in class Page
 
nodata - Instance field in class Prefs
 
normal - Instance field in class File
 
notcontentindexed - Instance field in class File
 
notifyPool( pool_name, fn_myPoolCallback ) - Instance method in class Engines.DataPool
 

O

obscured - Instance field in class TextField
 
offline - Instance field in class File
 
onBack( current_page ) - Instance method in class Page
 
onBack( current_page) - Instance method in class Actions.Window
 
onBeginProcess( text ) - Instance method in class Engines.Data
 
onBeginProcess( text ) - Instance method in class Engines.KlipFood
 
onBlur() - Instance method in class TextArea
 
onBlur() - Instance method in class TextField
 
onChange( [index] ) - Instance method in class ComboBox
 
onChange( [text] ) - Instance method in class TextArea
 
onChange( [text] ) - Instance method in class TextField
 
onClick( [index] ) - Instance method in class Item
 
onClick( [index] ) - Instance method in class ListControl
 
onClick( [index], [style] ) - Instance method in class Items
 
onClick( [state] ) - Instance method in class Checkbox
 
onClick() - Instance method in class Actions.Button
 
onClick() - Instance method in class Button
 
onClose() - Instance method in class Setup
 
onCreate( new_item ) - Instance method in class Engines.Data
 
onCreate( new_item ) - Instance method in class Engines.KlipFood
 
onDblClick( [index] ) - Instance method in class ListControl
 
onDelete( [index] ) - Instance method in class Item
 
onDelete( [index] ) - Instance method in class Items
 
onDone( current_page ) - Instance method in class Page
 
onDone( current_page) - Instance method in class Actions.Window
 
onDrop( url ) - Instance method in class Klip
 
onEndEdit( [index [, text]] ) - Instance method in class ListControl
 
onEndProcess( boolean | string ) - Instance method in class Engines.Data
 
onEndProcess( boolean | string ) - Instance method in class Engines.KlipFood
 
onFocus() - Instance method in class TextArea
 
onFocus() - Instance method in class TextField
 
onLoad() - Class method in class
 
onLoad() - Instance method in class Klip
 
onNext( current_page ) - Instance method in class Page
 
onNext( current_page) - Instance method in class Actions.Window
 
onOpen() - Instance method in class Setup
 
onRefresh( user_requested ) - Instance method in class Klip
 
<klip>
   <identity>
      <title>
         API: 304 Not Modified
      </title>
   </identity>
   <locations>
      <contentsource>
         http://support.klipfolio.com/files/demo/demo.xml
      </contentsource>
      <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>
   <style>
      alert {
         type: item;
      }

      sender {
         itemcol: 2;
         noterow: 1;

         label: 'Sender';

         emphasis: strong;
      }


      summary {
         itemcol: 3;
         noterow: 4;

         wrap: false;

         notelabel: false;
      }

      date {
         itemcol: 4;
         noterow: 2;

         label: 'Date';
      }

      category {
         noterow: 3;

         label: 'Category';
      }


      level {
         itemcol: 1;
         noterow: 5;
         notelabel: false;
         
         type: image;
      }

      url {
         type: link;
      }
            
      id {
         key: override;
      }
   </style>
   <klipscript>
   <![CDATA[

function onRefresh() 
{   
    var request = Engines.HTTP.newRequest( Prefs.contentsource );
   
    _t( "Access #1: " );
    doHTTPRequest( request );
    
    // - - This access will return a 304 Not Modified message
    _t( "Access #2: " );
    doHTTPRequest( request );
    
    return true;
} 

function doHTTPRequest( request )
{    
    if( request.send() ) 
    {       
       if( request.response.data ) 
       {
         _t( "Got some data!" );
         _t( request.response.headers );
         
         // Add the data to the Klip
         Engines.Data.process( request.response.data );
       }
    } 
    else 
    {
       _t( "Could not reach: " + request.url );
    }
}

function _t( s ) 
{
   trace( s + "\r\n" );
}

   ]]>
   </klipscript>
</klip>

     	

   
Class method in class
 
onSearch() - Instance method in class Klip
 
onStateChange( [index] ) - Instance method in class ListControl
 
onTick - Instance field in class Timer
 
onUpdate( existing_item, properties ) - Instance method in class Engines.Data
 
onUpdate( existing_item, properties ) - Instance method in class Engines.KlipFood
 
onUpgrade( [version] ) - Instance method in class Klip
 
open( UNC_path ) - Instance method in class Engines.File
 
open( [ index | name ] ) - Instance method in class Setup
 
open( host, port ) - Instance method in class TCPConnection
 

P

Page - class Page
 
Page() - Constructor in class Page
 
Prefs - class Prefs
 
Prefs() - Constructor in class Prefs
 
password - Instance field in class Engines.HTTP.HTTPRequest
 
path - Instance field in class File
 
post( postdata) - Instance method in class Engines.HTTP.HTTPRequest
 
postdata - Instance field in class Engines.HTTP.HTTPRequest
 
process( URL_or_data | httpRequestObject | httpResponseObject [, index] ) - Instance method in class Engines.Data
 
process( URL_or_data | httpRequestObject | httpResponseObject [, index] ) - Instance method in class Engines.KlipFood
 
processAutoRemove() - Instance method in class Items
 
processEntities( text ) - Instance method in class Klip
 
progressmessage - Instance field in class Klip
 
purge( [permanently] ) - Instance method in class Items
 

Q

queryWMI( query, row ) - Instance method in class Engines.Platform
 

R

radio - Instance field in class Checkbox
 
read() - Instance method in class File
 
readonly - Instance field in class File
 
receive( [length] ) - Instance method in class TCPConnection
 
recent - Instance field in class Item
 
referer - Instance field in class Engines.HTTP.HTTPRequest
 
referer - Instance field in class Prefs
 
refreshgranularity - Instance field in class Prefs
 
refreshrate - Instance field in class Prefs
 
remove( index ) - Instance method in class Items.Deleted
 
remove( index | object ) - Instance method in class Tab
 
remove( item | index [, permanently] ) - Instance method in class Items
 
remove( name | index ) - Instance method in class ListControl
 
removePage( pageName ) - Instance method in class Stack
 
removeStack( stack_name ) - Instance method in class Actions.Window
 
removeTab( name | tab | index ) - Instance method in class Setup
 
removeduplicates - Instance field in class Items
 
renameTab( name | tab | index, new_name ) - Instance method in class Setup
 
requestRefresh() - Instance method in class Klip
 
response - Instance field in class Engines.HTTP.HTTPRequest
 
response - Instance field in class Engines.ODBC
 
restore( index | object ) - Instance method in class Items.Deleted
 
run() - Instance method in class Engines.ReportingServices
 

S

Setup - class Setup
 
Setup() - Constructor in class Setup
 
Spacer - class Spacer
 
Spacer() - Constructor in class Spacer
 
Stack - class Stack
 
Stack() - Constructor in class Stack
 
savehistory - Instance field in class Items
 
searchtext - Instance field in class Klip
 
searchvisible - Instance field in class Klip
 
searchwatermark - Instance field in class Klip
 
secure - Instance field in class Engines.ReportingServices
 
selected - Instance field in class ComboBox
 
send( data, length ) - Instance method in class TCPConnection
 
send() - Instance method in class Engines.HTTP.HTTPRequest
 
sendQuery() - Instance method in class Engines.ODBC
 
sendtimestamp - Instance field in class Engines.HTTP.HTTPRequest
 
setData( name, value [, n] | index, value1 ) - Instance method in class Item
 
setDataPool( pool_name, value ) - Instance method in class Klip
 
setError( error_msg ) - Instance method in class Page
 
setPool( pool_name, value ) - Instance method in class Engines.DataPool
 
setPref( name, value ) - Instance method in class Prefs
 
setQuery( query ) - Instance method in class Engines.ODBC
 
setSelected( index, state ) - Instance method in class ListControl
 
setState( index, state ) - Instance method in class ListControl
 
setVirtualDirectory( reportServer ) - Instance method in class Engines.ReportingServices
 
show( pageName ) - Instance method in class Stack
 
show( stack_name[, page_name] ) - Instance method in class Actions.Window
 
show( text ) - Instance method in class Actions.Button
 
size - Instance field in class File
 
sort( sortBy | reversed ) - Instance method in class Items
 
status - Instance field in class Engines.HTTP.HTTPResponse
 
status - Instance field in class Engines.SOAP.SOAPResponse
 
status - Instance field in class Items
 
statusAlt - Instance field in class Items
 
statusvisible - Instance field in class Items
 
stripTags( text ) - Instance method in class Klip
 
stylesheet - Instance field in class Engines.Data
 
stylesheet - Instance field in class Engines.KlipFood
 

T

TCPConnection - class TCPConnection
 
TCPConnection() - Constructor in class TCPConnection
 
Tab - class Tab
 
Tab() - Constructor in class Tab
 
Text - class Text
 
Text() - Constructor in class Text
 
TextArea - class TextArea
 
TextArea() - Constructor in class TextArea
 
TextField - class TextField
 
TextField() - Constructor in class TextField
 
Timer - class Timer
 
Timer() - Constructor in class Timer
 
temporary - Instance field in class File
 
text - Instance field in class Actions.Button
 
title - Instance field in class Page
 
title - Instance field in class Prefs
 
title - Instance field in class Stack
 
trace( text ) - Instance method in class Klip
 
traceln( text ) - Instance method in class Klip
 

U

ungarble( garbledtext ) - Instance method in class Klip
 
uniqueid - Instance field in class Prefs
 
unquoteText( text ) - Instance method in class Engines.MIME
 
url - Instance field in class Button
 
url - Instance field in class Engines.HTTP.HTTPRequest
 
url - Instance field in class Engines.HTTP.HTTPResponse
 
url - Instance field in class Text
 
usedefaultprogressmessages - Instance field in class Klip
 
username - Instance field in class Engines.HTTP.HTTPRequest
 

V

value - Instance field in class Button
 
value - Instance field in class Checkbox
 
value - Instance field in class ComboBox
 
value - Instance field in class ListControl
 
value - Instance field in class Text
 
value - Instance field in class TextArea
 
value - Instance field in class TextField
 
version - Instance field in class KlipFolio
 
visible - Instance field in class Actions.Window.Back
 
visible - Instance field in class Actions.Window.Done
 
visible - Instance field in class Actions.Window.Next
 
visited - Instance field in class Item
 

X

xml - Instance field in class Engines.ODBC.ODBCResponse
 

   A B C D E F G H I K L M N O P Q R S T U V X
Klipfolio Dashboard 5 API

© 2009 Klipfolio Inc. All Rights Reserved.