Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

15068 lines (15067 sloc) 541.662 kb
{
"API": {
"critical": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"critical\"",
"method": true,
"name": "critical",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"debug": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"debug\"",
"method": true,
"name": "debug",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"error": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"error\"",
"method": true,
"name": "error",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"fatal": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"fatal\"",
"method": true,
"name": "fatal",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"info": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"info\"",
"method": true,
"name": "info",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"log": {
"arguments": [
{
"description": "the severity of the message",
"name": "severity",
"optional": false,
"type": "string"
},
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "writes information to the console log/STDERR",
"method": true,
"name": "log",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"notice": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"notice\"",
"method": true,
"name": "notice",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"trace": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"trace\"",
"method": true,
"name": "trace",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"warn": {
"arguments": [
{
"description": "the value to log",
"name": "note",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "logs an object with severity \"warn\"",
"method": true,
"name": "warn",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
}
},
"Accelerometer": {
"addEventListener": {
"arguments": [
{
"description": "the type of Accelerometer event to listen for. May only be 'update'",
"name": "type",
"optional": false,
"type": "string"
},
{
"description": "listener method",
"name": "listener",
"optional": false,
"type": "method"
}
],
"deprecated": false,
"description": "add an event listener to be called for a accelerometer event and returns the function to use when removing",
"method": true,
"name": "addEventListener",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "return the listener to be used as an id",
"type": "function"
},
"since": "0.4"
},
"removeEventListener": {
"arguments": [
{
"description": "the type of event to be removed from addEventListener",
"name": "type",
"optional": false,
"type": "string"
},
{
"description": "the function to be removed from addEventListener",
"name": "id",
"optional": false,
"type": "function"
}
],
"deprecated": false,
"description": "removes an event listener from Accelerometer events",
"method": true,
"name": "removeEventListener",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "return true if removed",
"type": "boolean"
},
"since": "0.4"
}
},
"Analytics": {
"addEvent": {
"arguments": [
{
"description": "event type",
"name": "evttype",
"optional": false,
"type": "string"
},
{
"description": "event name",
"name": "evtname",
"optional": false,
"type": "string"
},
{
"description": "event data",
"name": "data",
"optional": true,
"type": "string"
}
],
"deprecated": false,
"description": "send an analytics event associated with the application",
"method": true,
"name": "addEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"featureEvent": {
"arguments": [
{
"description": "name of the event",
"name": "event",
"optional": false,
"type": "string"
},
{
"description": "data to send with the event",
"name": "data",
"optional": true,
"type": "Object"
}
],
"deprecated": false,
"description": "send an application feature event.",
"method": true,
"name": "featureEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"navEvent": {
"arguments": [
{
"description": "The from string",
"name": "from",
"optional": false,
"type": "string"
},
{
"description": "The to string",
"name": "to",
"optional": false,
"type": "string"
},
{
"description": "name of the event",
"name": "event",
"optional": true,
"type": "string"
},
{
"description": "data to send with the event",
"name": "data",
"optional": true,
"type": "Object"
}
],
"deprecated": false,
"description": "send an application nav event",
"method": true,
"name": "navEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"settingsEvent": {
"arguments": [
{
"description": "name of the event",
"name": "event",
"optional": false,
"type": "string"
},
{
"description": "data to send with the event",
"name": "data",
"optional": true,
"type": "Object"
}
],
"deprecated": false,
"description": "send an application settings event.",
"method": true,
"name": "settingsEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"timedEvent": {
"arguments": [
{
"description": "name of the event",
"name": "event",
"optional": false,
"type": "string"
},
{
"description": "Start date, a Javascript Date",
"name": "start",
"optional": true,
"type": "Date"
},
{
"description": "End date, a Javascript Date",
"name": "stop",
"optional": true,
"type": "Date"
},
{
"description": "duration in seconds",
"name": "duration",
"optional": true,
"type": "string"
},
{
"description": "data to send with the event",
"name": "data",
"optional": true,
"type": "Object"
}
],
"deprecated": false,
"description": "send an application timed event.",
"method": true,
"name": "timedEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"userEvent": {
"arguments": [
{
"description": "name of the event",
"name": "event",
"optional": false,
"type": "string"
},
{
"description": "data to send with the event",
"name": "data",
"optional": true,
"type": "Object"
}
],
"deprecated": false,
"description": "send an application user event.",
"method": true,
"name": "userEvent",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
}
},
"App": {
"Properties": {
"arguments": [
{
"description": "the property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "a default value to return if the property doesn't exist",
"name": "name",
"optional": false,
"type": "list"
}
],
"deprecated": false,
"description": "",
"getBool": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "bool"
}
],
"deprecated": false,
"description": "Retrieve a boolean property",
"method": true,
"name": "getBool",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "bool"
},
"since": "0.4"
},
"getDouble": {
"arguments": [],
"deprecated": false,
"description": "get value as double",
"method": true,
"name": "getDouble",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"getInt": {
"arguments": [],
"deprecated": false,
"description": "get value as integer",
"method": true,
"name": "getInt",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"getList": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "list"
}
],
"deprecated": false,
"description": "Retrieve a list",
"method": true,
"name": "getList",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "list"
},
"since": "0.7"
},
"getString": {
"arguments": [],
"deprecated": false,
"description": "get value as string",
"method": true,
"name": "getString",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"hasProperty": {
"arguments": [],
"deprecated": false,
"description": "check to see if a property exists",
"method": true,
"name": "hasProperty",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"listProperties": {
"arguments": [],
"deprecated": false,
"description": "get a list of property values",
"method": true,
"name": "listProperties",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"method": true,
"name": "Properties",
"object": true,
"returns": {
"description": "returns a list of property values",
"type": "list"
},
"setBool": {
"arguments": [],
"deprecated": false,
"description": "set value",
"method": true,
"name": "setBool",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"setDouble": {
"arguments": [],
"deprecated": false,
"description": "set value",
"method": true,
"name": "setDouble",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"setInt": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "property value",
"name": "value",
"optional": false,
"type": "int"
}
],
"deprecated": false,
"description": "Store an integer property",
"method": true,
"name": "setInt",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"setList": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "value to store",
"name": "value",
"optional": false,
"type": "list"
}
],
"deprecated": false,
"description": "Store a list of JSON'able objects",
"method": true,
"name": "setList",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"setString": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "property value",
"name": "value",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Store a string property",
"method": true,
"name": "setString",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"since": "0.8"
},
"SystemProperties": {
"getBool": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "bool"
}
],
"deprecated": false,
"description": "Retrieve a boolean property",
"method": true,
"name": "getBool",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "bool"
},
"since": "0.4"
},
"getDouble": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "double"
}
],
"deprecated": false,
"description": "Retrieve a string property",
"method": true,
"name": "getDouble",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "double"
},
"since": "0.4"
},
"getInt": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "int"
}
],
"deprecated": false,
"description": "Retrieve an integer property",
"method": true,
"name": "getInt",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "int"
},
"since": "0.4"
},
"getList": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Remove a property",
"method": true,
"name": "getList",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"getString": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "default value if no value set for key in name",
"name": "def",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Retrieve a string property",
"method": true,
"name": "getString",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "property value or default",
"type": "string"
},
"since": "0.4"
},
"hasProperty": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Detect existence of a property",
"method": true,
"name": "hasProperty",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "true if property with 'name' exists.",
"type": "boolean"
},
"since": "0.7"
},
"listProperties": {
"arguments": [],
"deprecated": false,
"description": "Retrieve a list of property names",
"method": true,
"name": "listProperties",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "list of property names",
"type": "list"
},
"since": "0.7"
},
"setBool": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "property value",
"name": "value",
"optional": false,
"type": "bool"
}
],
"deprecated": false,
"description": "Store a boolean property",
"method": true,
"name": "setBool",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"setInt": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "property value",
"name": "value",
"optional": false,
"type": "int"
}
],
"deprecated": false,
"description": "Store an integer property",
"method": true,
"name": "setInt",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"setList": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "value to store",
"name": "def",
"optional": false,
"type": "list"
}
],
"deprecated": false,
"description": "Store a list of JSON'able objects",
"method": true,
"name": "setList",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.7"
},
"setString": {
"arguments": [
{
"description": "property name",
"name": "name",
"optional": false,
"type": "string"
},
{
"description": "property value",
"name": "value",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Store a string property",
"method": true,
"name": "setString",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
}
},
"appURLToPath": {
"arguments": [
{
"description": "the url, relative or absolute, to translate.",
"name": "url",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "get a full path from an application using app: URL",
"method": true,
"name": "appURLToPath",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the path",
"type": "string"
},
"since": "0.4"
},
"getArguments": {
"arguments": [],
"deprecated": false,
"description": "get a dictionary of application launch arguments or null if none",
"method": true,
"name": "getArguments",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns an object or null if none passed",
"type": "object"
},
"since": "0.8"
},
"getCopyright": {
"arguments": [],
"deprecated": false,
"description": "get the application copyright",
"method": true,
"name": "getCopyright",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the copyright for the app",
"type": "string"
},
"since": "0.4"
},
"getDescription": {
"arguments": [],
"deprecated": false,
"description": "get the application description",
"method": true,
"name": "getDescription",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the description for the app",
"type": "string"
},
"since": "0.4"
},
"getGUID": {
"arguments": [],
"deprecated": false,
"description": "get the application globally unique id",
"method": true,
"name": "getGUID",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the unique id",
"type": "string"
},
"since": "0.4"
},
"getID": {
"arguments": [],
"deprecated": false,
"description": "get the application id",
"method": true,
"name": "getID",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the id",
"type": "string"
},
"since": "0.4"
},
"getName": {
"arguments": [],
"deprecated": false,
"description": "get the application name",
"method": true,
"name": "getName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the name",
"type": "string"
},
"since": "0.4"
},
"getPublisher": {
"arguments": [],
"deprecated": false,
"description": "get the application publisher",
"method": true,
"name": "getPublisher",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the publisher",
"type": "string"
},
"since": "0.4"
},
"getStreamURL": {
"arguments": [
{
"description": "deploytype (TBD)",
"name": "stream",
"optional": false,
"type": "string"
}
],
"deprecated": false,
"description": "Not implemented yet",
"method": true,
"name": "getStreamURL",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "url for analytics",
"type": "string"
},
"since": "0.4"
},
"getURL": {
"arguments": [],
"deprecated": false,
"description": "get the application url",
"method": true,
"name": "getURL",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the url for the app",
"type": "string"
},
"since": "0.4"
},
"getVersion": {
"arguments": [],
"deprecated": false,
"description": "get the application version",
"method": true,
"name": "getVersion",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "returns the version",
"type": "string"
},
"since": "0.4"
},
"setLoadOnPageEnd": {
"arguments": [
{
"description": "if true, automatically call triggerLoad.",
"name": "load",
"optional": false,
"type": "bool"
}
],
"deprecated": false,
"description": "Used to control automatic execution of triggerLoad.",
"method": true,
"name": "setLoadOnPageEnd",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"triggerLoad": {
"arguments": [],
"deprecated": false,
"description": "(Internal, Android only) Method to signal switching to the webView in the activity. Normally called automatically when the page end event fires.",
"method": true,
"name": "triggerLoad",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
}
},
"Contacts": {
"ADDRESS_CITY": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the city name in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_CITY].",
"name": "ADDRESS_CITY",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_COUNTRY": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the country name in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_COUNTRY].",
"name": "ADDRESS_COUNTRY",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_COUNTRY_CODE": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the country code in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_COUNTRY_CODE].",
"name": "ADDRESS_COUNTRY_CODE",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_POSTAL_CODE": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the postal code in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_POSTAL_CODE]. Identical to ADDRESS_ZIP.",
"name": "ADDRESS_POSTAL_CODE",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_PROVINCE": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the province name in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_PROVINCE]. Identical to ADDRESS_STATE.",
"name": "ADDRESS_PROVINCE",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_SECONDARY_REGION": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . This field is used by only a few countries. To get the region name in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_SECONDARY_REGION].",
"name": "ADDRESS_SECONDARY_REGION",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_STATE": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the state name in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_STATE]. Identical to ADDRESS_PROVINCE.",
"name": "ADDRESS_STATE",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_STREET_1": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the first street line in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_STREET_1].",
"name": "ADDRESS_STREET_1",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_STREET_2": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the second street line in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_STREET_2].",
"name": "ADDRESS_STREET_2",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"ADDRESS_ZIP": {
"deprecated": false,
"description": "Convenience key to use with an address entry in Contacts.Contact . To get the zip code in the first address of a Contact.Contact called 'myContact', use myContact.address[0].value[ADDRESS_ZIP]. Identical to ADDRESS_POSTAL_CODE.",
"name": "ADDRESS_ZIP",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"Contact": {
"FirstName": {
"deprecated": false,
"description": "(string)",
"name": "FirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"LastName": {
"deprecated": false,
"description": "(string)",
"name": "LastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"address": {
"deprecated": false,
"description": "(multivalue of objects) See the constants in the Contacts module for the possible properties of an address object. Note that address may have a different format in some versions of Android.",
"name": "address",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"birthday": {
"deprecated": false,
"description": "(date)",
"name": "birthday",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"creationDate": {
"deprecated": false,
"description": "(date)",
"name": "creationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"date": {
"deprecated": false,
"description": "(multivalue of dates)",
"name": "date",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"displayLabel": {
"deprecated": false,
"description": "(read-only string) Accessor returns displayName if it is defined. Else, returns organization[0].value.company if is defined. Else, returns phone[0].value if it is defined. Else, returns 'No Name'.",
"name": "displayLabel",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"displayName": {
"deprecated": false,
"description": "(read-only string) Accessor returns prefix + firstName + middleName + lastName + suffix.",
"name": "displayName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"displayPhoneticName": {
"deprecated": false,
"description": "(read-only string) Accessor returns prefix + phoneticFirstName + phoneticMiddleName + phoneticLastName + suffix.",
"name": "displayPhoneticName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"email": {
"deprecated": false,
"description": "(multivalue of strings)",
"name": "email",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"getAddress": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.address property",
"method": true,
"name": "getAddress",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of objects.",
"type": "Array<Label/Value pair<Object>>"
},
"since": "0.8"
},
"getBirthday": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.birthday property",
"method": true,
"name": "getBirthday",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current date.",
"type": "Date"
},
"since": "0.8"
},
"getCreationDate": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.creationDate property",
"method": true,
"name": "getCreationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current date.",
"type": "Date"
},
"since": "0.8"
},
"getDate": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.date property",
"method": true,
"name": "getDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of dates.",
"type": "Array<Label/Value pair<Date>>"
},
"since": "0.8"
},
"getDisplayLabel": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.displayLabel property",
"method": true,
"name": "getDisplayLabel",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current read-only string.",
"type": "String|Object"
},
"since": "0.8"
},
"getDisplayName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.displayName property",
"method": true,
"name": "getDisplayName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current read-only string.",
"type": "String|Object"
},
"since": "0.8"
},
"getDisplayPhoneticName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.displayPhoneticName property",
"method": true,
"name": "getDisplayPhoneticName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current read-only string.",
"type": "String|Object"
},
"since": "0.8"
},
"getEmail": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.email property",
"method": true,
"name": "getEmail",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"getFirstName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.FirstName property",
"method": true,
"name": "getFirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getImageData": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.imageData property",
"method": true,
"name": "getImageData",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current dataBlob.",
"type": "Object"
},
"since": "0.8"
},
"getInstantMessenger": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.instantMessenger property",
"method": true,
"name": "getInstantMessenger",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"getLastName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.LastName property",
"method": true,
"name": "getLastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getMiddleName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.middleName property",
"method": true,
"name": "getMiddleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getModificationDate": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.modificationDate property",
"method": true,
"name": "getModificationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current date.",
"type": "Date"
},
"since": "0.8"
},
"getNickname": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.nickname property",
"method": true,
"name": "getNickname",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getNote": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.note property",
"method": true,
"name": "getNote",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"getOrganization": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.organization property",
"method": true,
"name": "getOrganization",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of objects.",
"type": "Array<Label/Value pair<Object>>"
},
"since": "0.8"
},
"getPhone": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.phone property",
"method": true,
"name": "getPhone",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"getPhoneticFirstName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.phoneticFirstName property",
"method": true,
"name": "getPhoneticFirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getPhoneticLastName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.phoneticLastName property",
"method": true,
"name": "getPhoneticLastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getPhoneticMiddleName": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.phoneticMiddleName property",
"method": true,
"name": "getPhoneticMiddleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getPrefix": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.prefix property",
"method": true,
"name": "getPrefix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getRelatives": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.relatives property",
"method": true,
"name": "getRelatives",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"getSuffix": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.suffix property",
"method": true,
"name": "getSuffix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current string.",
"type": "String"
},
"since": "0.8"
},
"getUrl": {
"arguments": [],
"deprecated": false,
"description": "retrieves the Contacts.Contact.url property",
"method": true,
"name": "getUrl",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The current multivalue of strings.",
"type": "Array<Label/Value pair<String>>"
},
"since": "0.8"
},
"imageData": {
"deprecated": false,
"description": "(dataBlob) represents the image that is displayed to the left of the name in the contacts picker.",
"name": "imageData",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"instantMessenger": {
"deprecated": false,
"description": "(multivalue of strings)",
"name": "instantMessenger",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"middleName": {
"deprecated": false,
"description": "(string)",
"name": "middleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"modificationDate": {
"deprecated": false,
"description": "(date)",
"name": "modificationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"nickname": {
"deprecated": false,
"description": "(string)",
"name": "nickname",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"note": {
"deprecated": false,
"description": "(multivalue of strings) For consistency, note is a multivalue. However, for the iPhone, only the note[0].value property is saved.",
"name": "note",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"organization": {
"deprecated": false,
"description": "(multivalue of objects) For consistency, organization is a multivalue. However, for the iPhone, only the organization[0].value properties are saved.",
"name": "organization",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"phone": {
"deprecated": false,
"description": "(multivalue of strings)",
"name": "phone",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"phoneticFirstName": {
"deprecated": false,
"description": "(string)",
"name": "phoneticFirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"phoneticLastName": {
"deprecated": false,
"description": "(string)",
"name": "phoneticLastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"phoneticMiddleName": {
"deprecated": false,
"description": "(string)",
"name": "phoneticMiddleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"prefix": {
"deprecated": false,
"description": "(string) The text that preceeds the contact's name, such as Dr for doctor.",
"name": "prefix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"relatives": {
"deprecated": false,
"description": "(multivalue of strings)",
"name": "relatives",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"setAddress": {
"arguments": [
{
"description": "The new multivalue of objects.",
"name": "newAddress",
"optional": false,
"type": "Array<Label/Value pair<Object>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.address property",
"method": true,
"name": "setAddress",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setBirthday": {
"arguments": [
{
"description": "The new date.",
"name": "newBirthday",
"optional": false,
"type": "Date"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.birthday property",
"method": true,
"name": "setBirthday",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setCreationDate": {
"arguments": [
{
"description": "The new date.",
"name": "newCreationDate",
"optional": false,
"type": "Date"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.creationDate property",
"method": true,
"name": "setCreationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setDate": {
"arguments": [
{
"description": "The new multivalue of dates.",
"name": "newDate",
"optional": false,
"type": "Array<Label/Value pair<Date>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.date property",
"method": true,
"name": "setDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setEmail": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newEmail",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.email property",
"method": true,
"name": "setEmail",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setFirstName": {
"arguments": [
{
"description": "The new string.",
"name": "newFirstName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.FirstName property",
"method": true,
"name": "setFirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setImageData": {
"arguments": [
{
"description": "The new dataBlob.",
"name": "newImageData",
"optional": false,
"type": "Object"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.imageData property",
"method": true,
"name": "setImageData",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setInstantMessenger": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newInstantMessenger",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.instantMessenger property",
"method": true,
"name": "setInstantMessenger",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setLastName": {
"arguments": [
{
"description": "The new string.",
"name": "newLastName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.LastName property",
"method": true,
"name": "setLastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setMiddleName": {
"arguments": [
{
"description": "The new string.",
"name": "newMiddleName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.middleName property",
"method": true,
"name": "setMiddleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setModificationDate": {
"arguments": [
{
"description": "The new date.",
"name": "newModificationDate",
"optional": false,
"type": "Date"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.modificationDate property",
"method": true,
"name": "setModificationDate",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setNickname": {
"arguments": [
{
"description": "The new string.",
"name": "newNickname",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.nickname property",
"method": true,
"name": "setNickname",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setNote": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newNote",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.note property",
"method": true,
"name": "setNote",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setOrganization": {
"arguments": [
{
"description": "The new multivalue of objects.",
"name": "newOrganization",
"optional": false,
"type": "Array<Label/Value pair<Object>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.organization property",
"method": true,
"name": "setOrganization",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setPhone": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newPhone",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.phone property",
"method": true,
"name": "setPhone",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setPhoneticFirstName": {
"arguments": [
{
"description": "The new string.",
"name": "newPhoneticFirstName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.phoneticFirstName property",
"method": true,
"name": "setPhoneticFirstName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setPhoneticLastName": {
"arguments": [
{
"description": "The new string.",
"name": "newPhoneticLastName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.phoneticLastName property",
"method": true,
"name": "setPhoneticLastName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setPhoneticMiddleName": {
"arguments": [
{
"description": "The new string.",
"name": "newPhoneticMiddleName",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.phoneticMiddleName property",
"method": true,
"name": "setPhoneticMiddleName",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setPrefix": {
"arguments": [
{
"description": "The new string.",
"name": "newPrefix",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.prefix property",
"method": true,
"name": "setPrefix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setRelatives": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newRelatives",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.relatives property",
"method": true,
"name": "setRelatives",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setSuffix": {
"arguments": [
{
"description": "The new string.",
"name": "newSuffix",
"optional": false,
"type": "String"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.suffix property",
"method": true,
"name": "setSuffix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"setUrl": {
"arguments": [
{
"description": "The new multivalue of strings.",
"name": "newUrl",
"optional": false,
"type": "Array<Label/Value pair<String>>"
}
],
"deprecated": false,
"description": "saves the Contacts.Contact.url property",
"method": true,
"name": "setUrl",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"suffix": {
"deprecated": false,
"description": "(string) The text that follows the contact's name, such as Jr, Sr.",
"name": "suffix",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
},
"url": {
"deprecated": false,
"description": "(multivalue of strings)",
"name": "url",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"since": "0.8"
}
},
"addContact": {
"arguments": [
{
"description": "(Contacts.Contact) The contact to add.",
"name": "Object",
"optional": false,
"type": "contact"
}
],
"deprecated": false,
"description": "",
"method": true,
"name": "addContact",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"createContact": {
"arguments": [
{
"description": "(optional object) can contain various properties that will be copied into the new object on initialization.",
"name": "Object",
"optional": true,
"type": "args"
}
],
"deprecated": false,
"description": "Creates a new Contacts.Contact object",
"method": true,
"name": "createContact",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The created Contacts.Contact.",
"type": "Object"
},
"since": "0.8"
},
"getAllContacts": {
"arguments": [],
"deprecated": false,
"description": "",
"method": true,
"name": "getAllContacts",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "(array of Contacts.Contacts)",
"type": "Array<Object>"
},
"since": "0.8"
},
"removeContact": {
"arguments": [
{
"description": "(Contacts.Contact) The contact to remove.",
"name": "Object",
"optional": false,
"type": "contact"
}
],
"deprecated": false,
"description": "",
"method": true,
"name": "removeContact",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"saveContact": {
"arguments": [
{
"description": "(Contacts.Contact) The contact to save.",
"name": "Object",
"optional": false,
"type": "contact"
}
],
"deprecated": false,
"description": "",
"method": true,
"name": "saveContact",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
},
"showContactPicker": {
"arguments": [
{
"description": "(object) Contains the callbacks and options",
"name": "Object",
"optional": false,
"type": "options"
}
],
"deprecated": false,
"description": "",
"method": true,
"name": "showContactPicker",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.8"
}
},
"Database": {
"DB": {
"arguments": [
{
"description": "sql expression",
"name": "sql",
"optional": false,
"type": "string"
},
{
"description": "one or more arguments to be inserted in the expression. May be integer, float, string, or data blob",
"name": "args",
"optional": false,
"type": "object"
}
],
"close": {
"arguments": [],
"deprecated": false,
"description": "close the database. This should be called to prevent resource leaks.",
"method": true,
"name": "close",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"deprecated": false,
"description": "",
"execute": {
"arguments": [
{
"description": "the SQL text. Multiple statements, separated by semi-colons, are not supported on Android.",
"name": "sql",
"optional": false,
"type": "string"
},
{
"description": "one or more arguments appearing after the sql parameter. Must be integer, float, string, or any data converted to string",
"name": "args",
"optional": true,
"type": "integer|float|string"
}
],
"deprecated": false,
"description": "Perform an operation on the database.",
"method": true,
"name": "execute",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "",
"type": "Database.ResultSet"
},
"since": "0.4"
},
"getLastInsertRowId": {
"arguments": [],
"deprecated": false,
"description": "the row id of the last insert operation.",
"method": true,
"name": "getLastInsertRowId",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "The id.",
"type": "int"
},
"since": "0.4"
},
"getRowsAffected": {
"arguments": [],
"deprecated": false,
"description": "The number of rows affected by the last operation",
"method": true,
"name": "getRowsAffected",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": {
"description": "the affected row count.",
"type": "int"
},
"since": "0.4"
},
"lastInsertRowId": {
"deprecated": false,
"description": "Same as getLastInsertRowId method.",
"name": "lastInsertRowId",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"returns": {
"description": "the row id.",
"type": "int"
},
"since": "0.4"
},
"method": true,
"name": "DB",
"object": true,
"remove": {
"arguments": [],
"deprecated": false,
"description": "Remove this database from the device. This is a destructive operation.",
"method": true,
"name": "remove",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"returns": {
"description": "returns a Database.ResultSet",
"type": "object"
},
"rowsAffected": {
"deprecated": false,
"description": "Same as getRowsAffected method.",
"name": "rowsAffected",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"property": true,
"returns": {
"description": "affected row count.",
"type": "int"
},
"since": "0.4"
},
"since": "0.8"
},
"ResultSet": {
"arguments": [
{
"description": "the zero-based index of the desired field",
"name": "fieldIndex",
"optional": false,
"type": "integer"
}
],
"close": {
"arguments": [],
"deprecated": false,
"description": "Releases the state associated with the result set",
"method": true,
"name": "close",
"platforms": [
"android-1.5",
"iphone-2.2.1",
"iphone-3.0",
"iphone-3.0",
"iphone-3.1"
],
"returns": null,
"since": "0.4"
},
"deprecated": false,
"description": "",
"field": {
"arguments": [],