---

Classes

• _global_
• appjet
• dispatching
• dlog
• fb
• HttpRequestError
• HttpResponse
• page
• QuickButton
• QuickForm
• request
• response
• StorableCollection
• StorableObject
• StringSet

---

Built-In Namespace _global_

Method Summary

Method Attributes	Method Name and Description
	_404(custom404)
	_addIfNotPresent(obj, key, value)
	_arrayToHTML(a)
	_arrayToStringOrArray(value)
	_checkSetup()
	_clearfloats()
	_coerceObjectToHTML(obj)
	_coerceToHolder(obj)
	_coerceToStorableHolder(obj)
	_coerceToStorableObject(obj)
	_coll_add(id, o)
	_coll_iterator(id)
	_coll_remove(id, obj)
	_Collections()
	_cronId(date, path, period, params, published)
	_default404()
	_deleteHandler(id)
	_doWrite(str)
	_getHandler(id)
	_getIdsHandler(id)
	_getObjectForId(id)
	_getstorage(key)
	_headerCapitalize(str)
	_Iterable(id)
	_iteratingToString(obj)
	_Iterators()
	_longToString(n)
	_newUniqueId(prefix)
	_objectHash(obj)
	_objectToArray(obj)
	_objectToOL(obj)
	_paramObjectToParamArray(params, enc)
	_proxy(id)
	_renderFacebook()
	_renderFooter()
	_renderHtml()
	_renderPlain()
	_sameProperties(obj1, obj2)
	_setAggressiveNoCacheHeaders()
	_setAggressiveYesCacheHeaders()
	_setHandler(id, raw)
	_setstorage(key, val)
	_Storage()
	_stringToHTML(str)
	add(id, obj)
	cmp(a, b) Comparator that returns -1, +1, or 0 depending on whether a < b, or a > b, or neither, respectively.
	comparator(id1, id2)
	create(id)
	dispatch(opts) Converts the path into a function name and calls that function.
	eachProperty(obj, func) Iterator convenience for JavaScript Objects.
	erase(id, key)
	filter(id, newId, match)
	first(id)
	form(url, param1, param2, etc) Helper fuction for printing a form.
	get(id, key)
	getById(id)
	gethostbyaddr(ipaddr) Converts an IP address string (such as "74.86.117.106") to a hostname (such as "appjet.com").
	gethostbyname(hostname) Converts a hostname string (such as "appjet.com") to an IP address, returned as a string (such as "74.86.117.106").
	getIds(id)
	getStorable(id) Gets a StorableObject or StorableCollection by its id.
	hasNext(id)
	html(text) Used for printing un-escaped HTML, such as your own HTML tags.
	image(url) Helper function for printing an image (an IMG tag).
	importTags(scopeObj, tagArray) Imports a specified list of tags.
	iterator(id, newId)
	keys(obj) Creates an array of the properties of obj, not including built-in or inherited properties.
	limit(id, newId, n)
	link(url, optionalText) Helper function for printing a link (A HREF tag).
	listAll() Returns an array of objects describing all scheduled CRON tasks.
	md5(x) Returns a string version of the MD5 signature of x.
	name(id)
	next(id)
	object(parent) Douglas Crockford's "object" function for prototypal inheritance, taken from http://javascript.crockford.com/prototypal.html
	patternDispatch(pattern1, pattern2, patternN, optional404) Similar to dispatch(), but you provide your own mapping of regular expresions to functions.
	print(thing1, thing2, etc) HTML-aware printing.
	printf(formatString, arg1, arg2, arg3) Prints a string with any number of variables substituted in, as popularized by C's function of the same name.
	printp(thing1, thing2, etc) Like print(.
	put(id, key, tv)
	raw(text) The raw() function is deprecated.
	remove(id, obj)
	reverse(id, newId)
	schedule(date, path, params, published, mailOnError) Schedules a CRON request to execute once at an exact date in the future.
	scheduleRepeating(date, period, path, params, published, mailOnError) Schedules a CRON request to execute every period minutes, starting at date.
	sendEmail(toAddress, subject, body, headers) Simple way to send an email to a single recipient.
	size(id)
	skip(id, newId, n)
	sort(id, newId, f)
	sortBy(id, newId, propertyNames)
	sprintf(formatString, arg1, arg2, arg3) Just like printf, but returns the string instead of printing it.
	supplant(data, str) Replaces keys of data found in string with their corresponding values.
	toHTML(x) This function is used by print(.
	trim(str) Removes leading and trailing whitespace from a string.
	unschedule(name) Unschedules the CRON task identified by name.
	unscheduleAll() Unschedules all CRON tasks.
	wget(url, params, options) Fetches the text of a URL and returns it as a string.
	wpost(url, params, options) Simple way to POST data to a URL and get back the response.

Parameters:

custom404

---

Parameters:

obj

key

value

---

Parameters:

a

---

Parameters:

value

---

---

---

Parameters:

obj

---

Parameters:

obj

---

Parameters:

obj

---

Parameters:

obj

---

Parameters:

id

o

---

Parameters:

id

---

Parameters:

id

obj

---

---

Parameters:

date

path

period

params

published

---

---

Parameters:

id

---

Parameters:

str

---

Parameters:

id

---

Parameters:

id

---

Parameters:

id

---

Parameters:

key

---

Parameters:

str

---

Parameters:

id

---

Parameters:

obj

---

---

Parameters:

n

---

Parameters:

prefix

---

Parameters:

obj

---

Parameters:

obj

---

Parameters:

obj

---

Parameters:

params

enc

---

Parameters:

id

---

---

---

---

---

Parameters:

obj1

obj2

---

---

---

Parameters:

id

raw

---

Parameters:

key

val

---

---

Parameters:

str

---

Parameters:

id

obj

---

Parameters:

{object} a

{object} b

Returns:

{number} -1, 0, or +1

---

Parameters:

id1

id2

---

Parameters:

id

---

function get_main() {
  // called with user visits http://appname.appjet.net/
  print("hello");
}
function get_page() {
  // called with user visits http://appname.appjet.net/page
}
function post_foo() {
  // called when user POSTs to http://appname.appjet.net/foo
}
dispatch(); // examines request and calls one of the above functions.

Parameters:

{object} opts Optional

(optional) if opts.custom404 is a function, then this function will be called if there is no function corresponding to the request path. If opts is is not specified, a default 404 handler displays "404 not found".

---

var pastels = {
  red: "#fcc",
  green: "#cfc",
  blue: "#ccf"
};
eachProperty(pastels, function(key, value) {
  print(DIV({style: 'background: '+value+';'}, key));
});

Parameters:

{object} obj

The object over which to iterate.

{function} func

The function to run on each [key,value] pair.

---

Parameters:

id

key

---

Parameters:

id

newId

match

---

Parameters:

id

---

if (request.path == "/bar") {
  printp("Your name is: ", request.param("name"));
  printp(link("/", "back"));
} else {
  printp("Enter your name:");
  print(form("/bar", "name"));
}

Parameters:

{string} url

an absolute or relative URL to post the form data to

{string} param1

the first form parameter name

{string} param2

the second form parameter name

{string} etc

...

---

Parameters:

id

key

---

Parameters:

id

---

Parameters:

{string} ipaddr

The IP address to resolve (example: "74.86.117.106").

Returns:

{string} the hostname corresponding to the given ip address, or undefined.

---

Parameters:

{string} hostname

The DNS name to resolve (example: "www.appjet.com").

Returns:

{string} the IP address corresponding to the given hostname, or undefined.

---

Parameters:

id

---

import("quickforms");
import("storage");

if (! storage.things) {
    storage.things = new StorableCollection();
    storage.things.add({message: "Hello world!"});
}

if (! request.param("idToDisplay")) {
    var firstId = storage.things.first().id;
    // show a button that creates a request with idToDisplay = firstId
    printp(new QuickButton("Show first thing.", {}, {idToDisplay: firstId}));
}
else {
    // display the "foo" property of whatever object has an id of idToDisplay
    printp(getStorable(request.param("idToDisplay")).message);
}

Parameters:

{string} id

The id of the object to be gotten.

Returns:

{StorableObject} The StorableObject whose id is id, or undefined if no such object exists.

---

Parameters:

id

---

print(html("""
<br />
<br />
<div><p>Here is some text inside a P inside a DIV.</p>
</div>
<br />
"""));

Parameters:

{string} text

the raw text

Returns:

{object} an object which, when printed, prints the raw html text

---

print(image("http://i29.tinypic.com/vfwc60.gif"));

Parameters:

{string} url

an absolute or relative URL to an image.

---

importTags(this, ["MEDIA:TITLE"]);
print(MEDIA_TITLE({type:"html"}, "funny pictures"));
// prints <media:title type="html">funny pictures</media:title>

Parameters:

{object} scopeObj

where to define the tags; to define in the global scope, pass this from the top level (not from inside a function)

{array} tagArray

an array of strings, the tags to import

---

Parameters:

id

newId

---

// Prints "abc"
keys({a: 1, b: 2, c: 3}).forEach(function(k) {
  print(k);
}

// Prints all the functions and object members of the global "appjet" object,
// one per line.
print(keys(appjet).join('\n'));

Parameters:

{object} obj

---

Parameters:

id

newId

n

---

print(link("http://appjet.com"));

Parameters:

{string} url

an absolute or relative URL to link to

{string} optionalText Optional

the text of the link, defaults to the url if absent

---

Returns:

{Array} An array of objects describing all scheduled CRON tasks.

---

print(md5("appjet")); // prints "9b458805f67473b49761c13e48c5de35"

Parameters:

{String} x

a string

Returns:

{String} the md5 hash of x

---

Parameters:

id

---

Parameters:

id

---

Parameters:

{object} parent

The parent object.

Returns:

{object} A new object whose prototype is parent.

---

function handleIndex() {
  print("this is the main landing page");
}
function handleFoo() {
  print("this is the foo page");
}
function unknown() {
  response.setStatusCode(404);
  print("path not found: ", request.path);
}
patternDispatch(
  [/^\/$/, handleIndex],
  [/^\/foo$/, handleFoo],
  unknown
);

Parameters:

{array} pattern1

array of [regexp, method]

{array} pattern2

array of [regexp, method]

{array} patternN

...

{function} optional404 Optional

called if none of the previous patterns match

---

Parameters:

{*} thing1

any javascript type

{*} thing2

any javascript type

{*} etc

...

---

var x = 5;
printf("an integer: %d", x);
printf("Two strings: [%s] and [%s].", "string one", "string two");

Parameters:

{string} formatString

{*} arg1

{*} arg2

{*} arg3

...

---

Parameters:

{*} thing1

any javascript type

{*} thing2

any javascript type

{*} etc

...

---

Parameters:

id

key

tv

---

Parameters:

text

---

Parameters:

id

obj

---

Parameters:

id

newId

---

result = schedule(new Date("Jan 12, 2008"), "/dosomething");

function cron_dosomething() {
  sendEmail("you@example.com", "A scheduled message.", "Greetings!");
}

Parameters:

{Date} date

The date the request should trigger.

{string} path

The path to be specified by the HTTP CRON request. Maximum length of 100 characters.

{object} params Optional

Optional parameters to be given with the HTTP CRON request. Maximum of 256 bytes of data; use storage if you need more.

{boolean} published Optional

Whether the request should be sent to the published version of the app, or the most recent preview version. By default only requests scheduled in published mode go to the published version of the app.

{boolean} mailOnError Optional

Whether to email this app's owner if the cron request fails or is canceled; defaults to false.

Returns:

{string} A unique identifier for this cron task.

---

result = schedule(new Date("Jan 12, 2008"), "/dosomething");

Parameters:

{Date} date

The exact date the cron requests should start.

{number} period

The delay between subsequent requests in minutes. Minimum of 1 minute.

{string} path

The path specified by the HTTP CRON requests. Maximum length of 100 characters.

{object} params Optional

Optional parameters to be given with the HTTP CRON requests. Maximum of 256 bytes of data.

{boolean} published Optional

Whether the CRON requests should be sent to the published version of the app, or the most recent preview version. By default only requests scheduled in published mode go to the published version of the app.

{boolean} mailOnError Optional

Whether to email this app's owner if the cron request fails or is canceled; defaults to false.

Returns:

{string} A unique identifier for this cron task.

---

result = sendEmail("noone@example.com", "Test Subject",
                   "Greetings!", {"Reply-To": "sender@example.com"});

Parameters:

{string} toAddress

The one email address to send a message to.

{string} subject

The message subject.

{string} body

The message body.

{object} headers Optional

Optional headers to include in the message, as a dictionary of {name: value} entries.

---

Parameters:

id

---

Parameters:

id

newId

n

---

Parameters:

id

newId

f

---

Parameters:

id

newId

propertyNames

---

var result = sprintf("%f", Math.sqrt(2));
print("The square root of two, as a string, is: ", result);

Parameters:

{string} formatString

{*} arg1

{*} arg2

{*} arg3

...

---

var data = {name: "Aaron", age: 25, today: new Date()};
print(supplant(data, """

{name}'s age is {age} years, as of {today}.

"""));

Parameters:

{object} data

dictionary of values

{string} str

Returns:

{string} str with keys of data replaced by their values

---

Parameters:

{*} x

any javascript variable

Returns:

{string} html-formatted string

---

Parameters:

{string} str

Returns:

{string} The trimmed string.

---

result = schedule(new Date("Jan 12, 2008"), "/dosomething");
unschedule(result);

Parameters:

{string} name

The identifier of the CRON task to cancel.

---

---

g = wget("google.com");
page.setMode("plain");
print(raw(g));

Parameters:

{string} url

The name of the url to retreive. If the transport is not specified, HTTP is assumed.

{object} params Optional

Optional parameters to include with the GET, as a dictionary of {name: value} entries.

{object} options Optional

Optional object with three optional properties:

• headers: HTTP request headers to send with the GET, as a dictionary of {name: value} entries.
• followRedirects: A boolean indicating whether to follow redirect headers returned by the server. Defaults to true.
• complete: If true, wget returns an object containing all information about the response, not just its contents. Otherwise, wget throws a HttpRequestError if it encounters an error GETing.

Returns:

{string} The full text of the url's content.

{HttpResponse} The "complete" response, returned if the "complete" parameter is true.

---

result = wpost("example.com", {id: 25, value: "here is the post value"});

Parameters:

{string} url

The url to POST to.

{object} params Optional

Optional parameters to include with the POST, as a dictionary of {name: value} entries.

{object} options Optional

Optional object with three optional properties:

• headers: HTTP request headers to send with the POST, as a dictionary of {name: value} entries.
• followRedirects: A boolean indicating whether to follow redirect headers returned by the server.
• complete: If true, wpost returns an object containing all information about the response, not just its contents. Otherwise, wpost throws a HttpRequestError if it encounters an error POSTing.

Returns:

{string} The full text returned from the server POSTed to.

{HttpResponse} The complete response, returned if the "complete" parameter is true.

---