Search
Link Search Menu Expand Document
Kony Quantum is now HCL Volt MX. See Revised Terminology. Current Quantum users, see the important note about API naming.
Release:

Volt MX Iris

API Developers’ Guide

Volt MX Iris is a powerful yet easy-to-use integrated development environment (IDE) for developing, building, testing, debugging, and deploying mobile applications (apps) for multiple platforms—all from a single code base. Volt MX Iris empowers you to rapidly develop mobile apps while giving you the flexibility to integrate with back-end services as you need them. What’s more, you can integrate into your app the very best of the native, web and hybrid environments.

For information on revision history, click Revision History.

Volt MX Iris APIs comprises a collection of APIs that you can use in apps written with Volt MX Iris. The APIs enable you to do such tasks as performing various operations on tables, manipulating strings, or invoking a service. The Volt MX Iris API library consists of the following:

  • Accelerometer API: The Accelerometer APIs allows you to capture the device motion acceleration in X, Y, Z directions and also provide out of the box mechanisms to register for shake gestures event. The chapter comprises of all the APIs with the name voltmx.accelerometer.
  • Action Sheet API for iOS: The Action Sheet API provides support for Apple’s Action Sheets on iOS apps.
  • Alert API: The voltmx.ui namespace includes a function that enables your app to pop up an alert dialog box to display important message to the app’s user.
  • Animation API: The Animation API functions help your app to add animations to the rows of SegmentedUI widgets.

  • App Extension API for iOS: The Volt MX Iris API provides support for App Extensions in iOS apps.

  • App Group API: The App Group API contains functions that your app can use to share data on iOS.
  • Application API: During the lifecycle of an application, the mobile device usually triggers several events. The APIs in this chapter allow you to listen to these events and override them with application specific functionality. The chapter comprises all the APIs with the namespace voltmx.application.
  • Application Settings API: The Application Settings API enables your apps to control application level settings so that the end users of an application can modify configurations and change the application behavior on iOS.

  • Background Agent API: The Background Agent API enables your Windows app to execute code in the background.

  • Badge API: Your apps use the Badge API to display icon badges for iOS apps.
  • Battery API: The Battery API provides a standard interface that can be used across multiple hardware platforms for checking the current state of a device’s battery.
  • Beacon API: The Beacon API enables your app to use iOS beacons.
  • Bookmark and Refresh API: The Bookmark and Refresh API enables developers to add context to the URL so that when the end user bookmarks it or shares it, the URL carries necessary parameters so that the application is rendered accordingly.
  • Camera API: The Camera API helps your app manage the data captured by the camera widget.
  • Charm Setting API: The Charm Setting API provides your app with the ability to access and use Windows charms.

  • Client Authentication API: The Client Authentication API provides your apps with the ability to authenticate clients that want to access an HTTPS servers.

  • Cryptography API: Cryptography is the process of securing the information. It can be defined as the conversion of data into scrambled text (concealing its readability and meaning) and deciphering it using a key. This data can be sent across safely over public and private networks. The chapter comprises all the APIs with the namespace voltmx.crypto.
  • ForceTouch API: The ForceTouch API provides functions to support 3D Touch features.
  • Functional Modules API: The Functional Modules API enables your app to load functional modules into your app.
  • Geolocation API: The GeoLocation API defines a high-level interface to location information, such as latitude and longitude associated with the mobile device.
  • Gesture API: The Gesture API gives your app access to the underlying gesture reading capabilities of mobile devices.
  • Image API: The Image API provides your app with image processing tools.
  • Input and Output API: Use the Input and Output API to access the device’s underlying file system.
  • Internationalization API: The i18n APIs enable you to design or develop an application in such a way that it supports various languages and regions. The namespace for internationalization is voltmx.i18n.
  • Local Authentication API: The voltmx.localAuthentication namespace contains functions that enable your apps to do Touch ID biometric fingerprint identification.
  • Language API: The Language API is implemented for exceptions that are not handled using try/catch blocks.
  • Live Tiles API: Live Tiles enable you to represent an application as a tile on the Start Screen of your device. You can launch the application using a Live Tile. This chapter comprises of all the APIs that enable you to add Live tiles. The namespace of all the APIs in this chapter is voltmx.application.
  • Map API: The voltmx.map namespace provides constants and functions that are used in conjunction with the Map widget.
  • Math API: The Math API has functions that you can use to perform mathematical operations.
  • Media API: The Media API enables your app to play and record audio files.
  • Native Function API : Volt MX Iris provides Native Function APIs that allow you to use native functions of iOS and Android platforms in Volt MX Iris. Access to the native functions is provided through a JavaScript API.
  • Network: The Network APIs enable you to invoke service calls or cancel network calls. The chapter comprises all the APIs with the namespace voltmx.net.
  • Notifications API: The notification system allows users to keep informed about relevant and timely events in your app.
  • Offline Data Access API: This API allows you to store data onto the device data store persistently.
  • Operating System API: This chapter comprises all the APIs with the namespace voltmx.os.
  • Passbook API: The Passbook API is used to keep things like airline boarding passes, movie tickets, and gift cards all in one place.
  • Phone API: The functions in this API provide you the ability to access the default applications of the underlying platform on the mobile device and perform operations. The namespace for Phone API is voltmx.phone.
  • Runtime Permission API: With the function in this API, your app can obtain permissions at runtime.
  • Standard Volt MX API: The generic functions with the namespace voltmx.
  • String API: The string Library has APIs that you can use to manipulate strings. The namespace is voltmx.string.
  • Sync API: The Sync API enables your app to perform various operations on Volt MX Sync.
  • Theme API: The Theme API lets you specify common skins for widgets in different states
  • Threading API: The Threading API helps JavaScript bindings work on main thread.
  • Timer API: The Timer API functions provide you the ability to schedule the execution of a function block at regular intervals. The namespace for Timer API is voltmx.timer.
  • Toast API: The Toast API implements toast messages in your Volt MX Iris apps..
  • Worker Thread API: The functions in the Worker Thread API provide your apps with a means to execute different tasks in multiple parallel contexts of execution in a concurrent manner.
  • File Sharing in Android with other Apps: Android, file sharing from one app with another app happens in the form of content URI. So, you must make your app generate content URIs of files that you want to share with other apps.