Kinetic JS Objects

The Kinetic Runtime API provides a number of methods and properties for the various Kinetic objects.

Important! Do not modify any Kinetic methods or properties. Changing them may have adverse affects on behavior and is not supported!

Kinetic Object

The Kinetic object K provides high-level API access.

Note: The K.ready() function is not the same as the ready function provided in the bundle customization object. This method is reserved and should only be called by Core Edition generated code.

Field Object

The Field object has a number of useful methods defined on it for Form and Kapp developers.

Notes

• Some of the functions that correspond to conditions specified within the builder may cause conflicts. For example, if you define a "Visible" condition in the builder of "Hidden" and then call the show method, the form will eventually self-correct and hide the field again.
• The following functions can cause conflicts: hide, show, disable, enable. In many cases, leaving these conditions in their default state should allow you use the functions in JavaScript event code, but this is not guaranteed.

Form Object

The Form object provides methods for manipulating form behavior and properties.

Bridged Resource Object

The Bridged Resource object provides the ability to dynamically load data from bridges.

Here's an example of a bridged resource load script:

// Load a bridged resource named 'People' that has no parameters:
K('bridgedResource[People]').load({
    attributes: ['First Name', 'Last Name', 'Login Id'],
    metadata: {
      "limit": "5",
      "pageToken": "i0j70ogl9638s4ccs0bvdkrqftxa6kvzt52",
      "order": "Login Id:asc"
    },
    success: function(bridgedData) {
        // Do something with the bridged data response.
        // For example:
        console.log(bridgedData.records);
    }
});

// Load a bridged resource named 'Person' that has a parameter. The
// parameter is configured to reference the value of the Login ID field,
// which is defined in the Form Builder:
K('bridgedResource[Person]').load({
    attributes: ['First Name', 'Last Name'],
    values: {'Login ID' : 'Allen'},
    success: function(bridgedData) {
        console.log(bridgedData.record);
    }
});

You can also call these other methods:

Page Object

The page object provides information about the current form page. It has the following functions:

Section Object

The section object provides information about a section on the current page. It has the following functions:

Like other object types, the hide and show behavior is conditional and may be superseded by the form's behavior.

Button Object

The button object provides information about a button on the current page. It has the following functions:

Like other object types, the hide, show, enable, and disable behavior is conditional and may be superseded by the form's behavior.

Content Object

The content object provides information about a content field on the current page. It has the following functions:

Like other object types, the hide and show behavior is conditional and may be superseded by the form's behavior.

Kapp Object

Space Object

Submission Object

• K('submission').id() - returns the submission ID or null if a new submission.
• K('submission').value(fieldName) - returns the value from a field that was on a previous page.

Using Kinetic Selectors

Using the runtime API you can use patterns to retrieve information and objects pertaining to the form. For detailed documentation see the class reference.

// Selecting the current form.
K('form')
// Selecting a form by slug. If multiple forms of the same slug are loaded you will
// receive an array of forms.
K('form[ipad-request]')
// Selecting a field by name.
K('field[FirstName]')
// Selecting a bridged resource by name
K('bridgedResource[People]')

Other supporting form data can also be selected.

// Selecting the current page
K('page')
// Selecting the current submission data.
K('submission')
// Selecting the current kapp.
K('kapp')
// Selecting the current identity.
K('identity')

Nesting Selectors

Many selectors can be nested, for example:

// Selecting a field by name which is on the current page.
K('form page field[FirstName]')

Selectors imply the active form so the 'form' selector can nearly always be omitted:

// Get the FirstName field for the current page.
K('page field[FirstName]')

Selecting Elements by Name

A number of form elements can also be selected by their names:

// Select a button by name
K('button[Refresh List]')
// Select a section by name
K('section[Personal Information]')
// Select a text element by name.
K('text[Introduction]')

The Bundle Object

Bundle is a helper object designed to be used in javascript applications. The bundle object provides a number of static methods that are automatically included with each request.