App Maker Server API

App

This class allows a server script to access data and check permissions, and it provides other functionality specific to App Maker.

var userRoles = app.getActiveUserRoles();
if (userRoles.indexOf(app.roles.Admins) >= 0) {
  // Create admin-only application settings record.
  var settings = app.models.Settings.newRecord();
  app.saveRecords([settings]);
}

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

if (userRoles.indexOf(app.roles.Admins) < 0) {
  throw 'Access denied';
}

var record = app.models.Person.newRecord();
app.saveRecords([record]);

var displayField = app.metadata.models.model1.displayField;
    

throw new app.ManagedError("Custom message shown to app users");
  

app.transaction.cloudSql.start(app.transaction.cloudSql.isolation.REPEATABLE_READ);
  

Methods

var roles = app.getActiveUserRoles();
if (roles.indexOf(app.roles.Admins) < 0) {
  throw 'Access denied';
}

var record = app.models.Person.newRecord();
app.saveRecords([record]);

var record = app.models.Person.getRecord(key);
app.deleteRecords([record]);

var role = app.roles.Admins;
var members = app.getRoleMembers(role);

Association

This class represents an association between two records, one in the model on one end of a specific relation, and the other in the model on the other end. (This might be the same model.)

Each association consists of two keys, which identify the records that are associated.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

To identify which end of a relation is the source and which is the target, look at the Security tab for a model in the relation. Relation permissions have titles such as Employee + Department. Employee and Department are names of the ends of the relation. The model corresponding to the first relation end is the source model, and the model corresponding to the second relation end is the target model.

Model

This class represents a data model in App Maker. It allows a script to access data records of this model.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Methods

var query = app.models.Person.newQuery();
query.filters.Name._startsWith = 'John';
query.filters.Age._greaterThan = 20;
query.sorting.Name._ascending();
query.sorting.Age._descending();
var records = query.run();

var record = app.models.Person.newRecord();
app.saveRecords([record]);

Query

This class represents a data query in App Maker. It allows a script to control the filtering, sorting, and paging of data records. When a user initiates a query, App Maker applies ownership filters to the query and checks the permissions of results before returning them to the user.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

var query = app.models.Person.newQuery();
query.filters.Name._startsWith = 'John';
query.filters.Age._greaterThan = 20;
var records = query.run();

var query = app.models.Person.newQuery();
query.sorting.Name._ascending();
query.sorting.Age._descending();
var records = query.run();

var query = app.models.Employee.newQuery();
query.prefetch.Manager._add();
query.prefetch.Manager.Reports._add();

var records = query.run();
for (var i in records) {
  var manager = records[i].Manager; // No extra call to DB
  var reports = manager.Reports; // No extra call to DB
  ...
}
           

Methods

var query = app.models.Person.newQuery();
query.filters.Name._startsWith = 'John';
query.filters.Name._ascending();
var persons = query.run();

Record

This class represents a data record in App Maker. It allows a script to access record fields and related records.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

var person = app.models.Person.newRecord();
person.name = 'John Doe';
person.age = 35;
app.saveRecords([person]);

var manager = app.models.Person.newRecord();
manager.name = 'Jeff Williams';
manager.age = 45;
app.saveRecords([manager]); // You must save new record before using it in relations.

person.manager = manager;
app.saveRecords([person]);

Metadata

This class represents all metadata in the application. It allows a script to access the metadata of this application.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

ModelMetadata

This class represents a metadata model in App Maker. It allows a script to access the metadata of this model.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

Field

This class represents a field in App Maker. It allows a script to access a field of this model.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

Relation

This class represents one side of a relation from the specified model to another in App Maker. It allows a script to access a relation of this model.

This class is only available in App Maker applications. See Apps Script reference for all other general classes available in App Maker applications.

Properties

Transaction

Provides access to the Transaction API in App Maker. Available only in applications that have at least one Cloud SQL model.

Properties

CloudSqlTransaction

This type allows a script to start, commit, rollback, and check the status of database transactions in Cloud SQL models.

Properties

Methods

app.transaction.cloudSql.isStarted();
                

app.transaction.cloudSql.start(
app.transaction.cloudSql.isolation.REPEATABLE_READ);
        

app.transaction.cloudSql.commit();
        

app.transaction.cloudSql.rollback();
        

app.transaction.cloudSql.setLockOnRead(
app.transaction.cloudSql.lockOnRead.UPDATE);

IsolationLevel

Enumeration of possible isolation levels.

Properties

LockMode

Enumeration of possible locking read modes to set with setLockOnRead().

Properties