Collections provides a Javascript API and an in-app code editor.

The Javascript API is limited to Sources, you can use Javascript to search and create documents querying external services (E.g. Google Books). To create a Source, open a collection → tap on button → Edit → Sources.

The API is accessible through the app object.

Result

Networking

let request = app.request("https://www.google.com");
let response = request.send();
let data = response.json();

Storage

app.storage.firstName = "John";
app.storage.lastName = "Doe";
app.storage["full-name"] = "John Doe";

Search results

let result = app.searchResult.new();
result.title = "Harry Potter";
result.subtitle = "J. K. Rowling";
result.params = {id: 12345};

Document builder

You can use the Document builder to create a new document or use an existing one.

Before using the document builder, be sure to set an alias for each field (Edit a field → Alias).

• For URL, Email, Phone, Barcode you can simply use setString.
• For Time interval you can use setDecimal specifying the value in seconds.
• For "Date and time" you can use setDate.
• For Color you can use setString specifying the hex value (e.g. #00FF00).

let document = app.document.builder();
document.setString("Harry Potter", "name");
document.setString("Pottermore Publishing", "publisher");
document.setInteger(223, "page-count");

Suggestions

When you create a document, you usually want to set existing list items or documents to it. To solve this problem, the app uses the concept of suggestion.

A suggestion contains an identifier and all the data needed to create the item. The app will find the item matching the specified identifier, and if that item doesn't exist, it will create a new one.

Suggest a list item

let listItem = app.listItem.suggest("fantasy", "Fantasy");
document.setListItem(listItem, "genre");

Suggest a document

To suggest a document, create a new document builder and call builder.setIdentifier(fieldAlias) to set a field as the identifier. If you are creating a new document, you don't need to call this method.

let author = app.document.builder();
author.setIdentifier("name");
author.setString("J. K. Rowling", "name");

let book = app.document.builder();
book.setString("Harry Potter", "name");
book.setDocument(author, "author");

The example creates an author with the name field as the identifier. The author is then saved in a book, the app will find an author with "J. K. Rowling" as name or it will create a new one if that doesn't exist.

Suggest a location

You can suggest a location with the coordinates or the address.

let location = app.location.suggestWithCoordinates(40.730610, -73.935242);

let document = app.document.builder();
document.setLocation(location, "location");

Group builder

You can use Group builder to add values to a group.

let document = app.document.builder();

let group = app.group.builder();

group.add.string("String 1");
group.add.string("String 2");
group.add.string("String 3");

document.setGroup(group, "my-group");

Document

An object that manages an existing document.

// During a document update
let document = app.currentDocument;
let title = document.getValue("title");

// Find a document by short ID
let document = app.document.findById("ABC123");
let title = document.getValue("title");

Updating a document

A document can be updated from a source. To begin with, enable the feature from → Edit → Sources → Source → Document update enabled.

Then open a document, and from the detail view, tap on → Update from... → Source.

Utility