API Reference - Topics

This page is used to group our APIs into meaningful topics, such as Animations, Location and Notifications, etc.

If you would rather view the Cascades or Qt classes alphabetically or by namespaces, or if you want to view All classes, use the navigation on the left to select the preferred layout.

App integration

Take advantage of APIs that integrate platform applications and functionality into your own app, such as email, calendar, and BBM. You can also use these APIs to invoke actions from other apps.

• Account

  Handle account records that are associated with specific users.

• BBM

  Integrate the BlackBerry Messenger Social Platform into your own applications.

• Calendar

  Use the features of the Calendar application in your own app.

• Contacts

  Add, update, and remove contacts in the Contacts application on a device.

• Invocation framework

  Invoke other applications on the device from within your app by using the invocation framework.

• Message

  Send messages directly from your app, and save, update, and remove messages from different accounts on the device.

• Notebook

  Use these APIs to integrate Notebook application features in your app.

Data management

Use the APIs in this category to access data from data sources, such as XML, JSON, or SQL. You can also store data in data models (to display to users in a list) and create a file picker that lets users select and save individual or multiple files.

• ArrayDataModel -

  Contains a list of QVariant values, typically for a ListView.

• AsyncDataAccess -

  Allows communication with an asynchronous worker in another thread.

• AsyncWorker -

  Represents objects that do asynchronous work.

• DataAccessError -

  Represents an error from a DataAccess load or save operation.

• DataAccessErrorType -

  Represents types of data access errors.

• DataAccessReply -

  The reply from an asynchronous data access operation.

• DataModel -

  An abstract class that can be used to provide a ListView with data.

• DataModelChangeType -

  Represents different types of data model changes.

• DataSource -

  Provides access to data from an external data source.

• DataSourceType -

  Represents data types that you can use with a DataSource.

• FilePicker -

  Allows the user to select a file or select a name and location for saving a file.

• FilePickerMode -

  Defines whether the FilePicker is used for picking single or multiple files or selecting a destination for saving one or more files.

• FilePickerSortFlag -

  Defines the attributes that the files can be sorted on in FilePicker.

• FilePickerSortOrder -

  Defines the possible sort order.

• FilePickerViewMode -

  Defines view modes in FilePicker.

• FileType -

  Defines the type of files that the user can select in FilePicker.

• GroupDataModel -

  A data model to be used with a ListView.

• IndexMapper -

  Indicates whether a ListView can translate cached items to new indexes.

• ItemGrouping -

  Represents different ways of grouping items in a GroupDataModel.

• JsonDataAccess -

  Provides load and save operations for JSON data.

• QListDataModel -

  Contains a list of <Item> values, typically for a ListView.

• SqlConnection -

  Connects to an SQL database and executes commands asynchronously.

• SqlDataAccess -

  Retrieves and updates data in an SQL database.

• SqlWorker -

  A worker that executes SQL commands in another thread.

• XmlDataAccess -

  Converts data from XML format to QT C++ value objects or from QT C++ value objects to XML format.

• XmlDataModel -

  A class that creates a static DataModel for ListView from an XML file.

Device and communication

Manage device features and use communication APIs, ranging from NFC and GPS to Wi-Fi and gyroscope.

• Control

  Use these classes to control the vibration and LED hardware on a device.

• Info

  Request hardware info, such as battery level, and access information about display and hardware capabilities.

• Nfc

  Use the NFC classes to handle near-field communication with other devices.

• Phone

  Provide support for phone communication in your apps.

• Push

  Utilize the Push Service to push content to your application.

• Radio and sim

  Request SIM card and radio connectivity status.

Location

Use maps and location services in your apps, and provide support for mapping features, such as landmarks.

• Maps

  Integrate map functionality in your application.

• Places

  Let your users discover points of interest fetched from local favorites, remote search results, and contacts.

• Positioning and geocoding

Multimedia

Access the camera, audio player, and video player APIs and provide support for multimedia.

• Audio

  Handle audio in your application.

• Barcodes

  Scan barcodes with these classes.

• Camera

  Integrate the camera in your application.

• General

  Handle media states and errors.

• Mediaplayer

  Access and control features that support the media player, such as audio output, repeat mode, and buffer status.

Platform

Support different platform features in your apps, such as Payment Service, notifications, languages, and home screen functions.

• Ad service
• Home screen

  Use features that are related to the home screen on a device, such as lock state, icon badge, application support, and wallpaper.

• Info

  Request information about memory, platform features, file system, and applications.

• Language

  Provide support for the internationalization and translation of text.

• Notifications

  Display notification dialog boxes and handle errors.

• Payment service

  Handle in-app purchases with these Payment Service classes.

• Security

  Determine the security perimeter (personal or work) of applications.

• Utility

  Access platform utilities, such as clipboard, PPS objects, and PPS attributes.

User interface

Use the classes that make up the Cascades UI framework to build visually appealing and easy-to-use UIs.

• Animations

  Take advantage of the different animations that you can use in Cascades, such as translation, rotation, and scaling, as well as supporting features such as easing curves.

• Application structure

  Structure your application by providing support for navigating within different views, navigating to new pages, using tabs, and using context menus and action bars.

• Core

  Learn about the core essentials of a Cascades application and base classes for most controls.

• Core controls

  Access the foundation of Cascades, the core controls (buttons, containers, and so on), which will help you create an awesome application.

• Events

  Handle events that are sent to and from controls when you interact with them.

• Layouts

  Position your UI controls and other elements inside the UI of your application.

• List
• Resources

  Manage assets and images, load documents, and use colors on objects.

• System ui

  Display system notifications, such as dialog boxes, prompts, and toasts, and create custom menus.

• Text

  Support text display and text input in your apps, and manipulate properties such as font styles and sizes.

• Web

  Manage requests for web content in your apps by using the WebView class and supporting classes.