Hybrid Web Container and Hybrid App JavaScript APIs

The container and framework JavaScript APIs provide functionality that the Hybrid Apps can access. 

Hybrid Web Container JavaScript APIs

The files where the Hybrid Web Container JavaScript APIs are defined are located in <SUP_HOME>\MobileSDK<version>\HybridApp\API\Container. The generated JavaScript API reference documents are located in <SUP_HOME>\MobileSDK<version>\HybridApp\API\API.

Note: The detail of the individual APIs is not available if you are viewing this document from DocCommentXchange ( http://dcx.sybase.com) or in PDF format. You can access this information by going to Sybase Product Documentation at http://infocenter.sybase.com/help/topic/com.sybase.infocenter.dc01853.0222/doc/html/vhu1349901991724.html
Class Description Defined in
hwc.CallbackSet () Use for event handlers that are asynchronous. Callbacks.js
hwc.CertificateStore Create a user interface in HTML and JavaScript that uses X.509 certificates as the Hybrid App credentials. Certificate.js
hwc.ConnectionSettings The JavaScript class for the Hybrid Web Container connection settings manages the connection between applications and the server. hwc-api.js
hwc.CustomIcon The JavaScript class for the Hybrid Web Container custom icon, lists custom icons. hwc-api.js
hwc.e2eTrace Allows for an end to end trace of data communication from the client to the back-end. hwc-api.js
hwc.getExternalResource Access resources on external HTTP servers. ExternalResource.js
hwc.getCurrentLocale The date/time functions allow you to extract and format the date and time for the Hybrid App. Timezone.js
hwc.getPicture Provides access to the device's default camera application or device's photo library for retrieving a picture asynchronously. Camera.js
hwc.HybridApp Javascript class for the Hybrid App object. Lists installed Hybrid Apps. hwc-api.js
hwc.LogEntry Javascript class for LogEntry object. hwc-api.js
hwc.MediaCache Used within the JavaScript to wrap the source of an image element. Fetches media content from a cache or the server using a URI. hwc-api.js
hwc.MenuItemCollection Represents a collection of menu items. hwc-comms.js
hwc.Message This is the class to encapsulate an incoming message object. When a new message arrives, a notification is sent to users through custom code. hwc-api.js
hwc.MessageFilter This is the class to encapsulate a filter for messages. hwc-api.js
hwc.perf

The performance library allows you to instrument your application code and collect performance counters when executing the application on the device.  Results are reported in a log file on the SD-card (BlackBerry and Android), or in the sandbox (iOS). The results can also be read in the domain log by calling Get Trace for the application connection in Sybase Control Center.

hwc-api.js
hwc.SUPStorage Constructs a new storage area identified by a storage key. SUPStorage.js
Resources Access localized string resources. Resources.js

Hybrid App Framework JavaScript APIs

The files where the Hybrid App framework JavaScript APIs are defined are located in <SUP_HOME>\MobileSDK<version>\HybridApp\API\AppFramework.

Class Description Defined in
doOnlineRequest Allows an operation or object query to be invoked. API.js
MessageValue Message value object that stores a key-value pair from a message sent to or from the server and the Hybrid App. WorkflowMessage.js
MessageValueCollection Message value collection object that stores a container node from a message sent to or from the server and theHybrid App. WorkflowMessage.js
WorkflowMessage Access the Hybrid App message data functions. WorkflowMessage.js
Related concepts
SUP Storage
Shared Storage
Related tasks
Customizing the Push Notification Handler in the iOS Hybrid Web Container
Related reference
End to End Trace and Performance
Implementing Push