hwc namespace

The namespace for the Hybrid Web Container javascript

• CertificateStore class
  Use these functions for X.509 credential handling.
• ClientVariables class
  Represents a ClientVariables object.
• ClientVariablesException class
  
• ConnectionSettings class
  Represents the connection settings for connecting to the SUP Server.
• CustomIcon class
  Represents a CustomIcon.
• e2eTrace class
  Represents an E2E Trace.
• HybridApp class
  This object represents a hybrid app.
• LogEntry class
  This object represents a log entry.
• MediaCache class
  Represents a Media Cache.
• MenuItemCollection class
  This class represents a collection of menu items.
• Message class
  Represents a message received by the HWC.
• MessageFilter class
  Represents a filter used to filter messages. Pass in null for any parameter you do not wish to filter (or do not pass in such parameters at all).
• perf class
  Represents the Performance Manager.
• SharedStorage class
  Constructs a new SUP shared storage.
• SUPStorage class
  Creates a SUPStorage with the specified storeName.
• SUPStorageException class
  Exception thrown when Storage space is exceeded.
• NativeErrorCodes namespace
  This object contains constants representing the different types of public native error codes. Error codes larger than 500 are reserved for server communication errors which may occur as the result of online requests and/or attachment downloads
• APP_ADDED member
  
• APP_REFRESH member
  
• APP_REMOVED member
  
• APP_UPDATED member
  
• CONNECTED member
  Constant indicating that the hwc is connected.
• CONNECTION_CONNECTED member
  A constant indicating that the log message is about the connection being established.
• CONNECTION_DISCONNECTED member
  A constant indicating that the log message is about the connection being disconnected.
• CONNECTION_ERROR member
  A constant indicating that the log message is about a connection error.
• CONNECTION_OTHER member
  A constant indicating that the log message is not about the connection.
• CONNECTION_RETRIEVED_ITEMS member
  a constant indicating that the log message is about retrieved items.
• DEFAULT_CUSTOM_ICON_INDEX member
  A constant indicating the custom icon index.
• DISCONNECTED member
  Constant indicating that the hwc is disconnected.
• INSTALLATION_BEGIN member
  A constant indicating that the application is starting to be installed.
• INSTALLATION_END member
  A constant indicating that the application has finished being installed.
• MSG_ADDED member
  A constant indicating that a message has been added.
• MSG_PRIORITY_HIGH member
  A constant indicating a message has high priority.
• MSG_PRIORITY_NORMAL member
  A constant indicating a message has normal priority.
• MSG_REFRESH member
  A constant indicating that a message needs to be refreshed.
• MSG_REMOVED member
  A constant indicating that a message has been removed.
• MSG_UPDATED member
  A constant indicating that a message has been updated.
• NOTIFICATION_CANCEL member
  
• NOTIFICATION_CONTINUE member
  
• OPEN_APP_NOT_EXIST member
  
• OPEN_APP_OTHER member
  
• OPEN_APP_SUCCESS member
  
• OPEN_MSG_APP_NOT_EXIST member
  
• OPEN_MSG_NOT_EXIST member
  
• OPEN_MSG_OTHER member
  
• OPEN_MSG_SUCCESS member
  A constant indicating that a message was successfully opened.
• PictureError member
  An array that holds all possible error codes
• REG_ERR_AUTO_REG_NOT_ENABLED member
  Constant indicating that auto registration was not enabled in the template.
• REG_ERR_AUTO_REG_TEMPLATE_NOT_FOUND member
  Constant indicating that no MBS template was found for given AppId and/or Security configuration.
• REG_ERR_AUTO_REG_USER_NAME_TOO_LONG member
  Constant indicating that the user name is longer than the legal limit.
• REG_ERR_AUTO_REG_WRONG_USER_FOR_DEVICE member
  Constant indicating that the given device id is already registered for another user.
• REG_ERR_COULD_NOT_REACH_MMS_SERVER member
  Constant indicating that the connection to the MMS service failed.
• REG_ERR_INVALID_USER_NAME member
  Constant indicating that the user name contains invalid characters.
• REG_ERR_MMS_AUTHENTICATION_FAILED member
  Constant indicating that MMS Authentication failed.
• REGISTRATION_METHOD_AFARIA member
  Constant indicating that automatic registration using a certificate from Afaria is the preferred method.
• REGISTRATION_METHOD_AUTOMATIC member
  Constant indicating that automatic registration using password is the preferred method.
• REGISTRATION_METHOD_CERTIFICATE member
  Constant indicating that automcatic registration using a local certificate is the preferred method.
• REGISTRATION_METHOD_MANUAL member
  Constant indicating that manual registration is the preferred method.
• REGISTRATION_METHOD_NO_PREFERENCE member
  Constant indicating no registration method preference.
• SETTING_SUCCESS member
  
• STATUS member
  This object contains constants representing the status of the hybrid app.
• activationRequired method
  This function sets the activation required state of this hybrid app to true.
• addAppInstallationListener( AppInstallationListener ) method
  Register the application installation listener.
• addAppListener( ApplicationListener, [containingObject] ) method
  Register the application listener.
• addConnectionListener( ConnectionStateListener, [containingObject] ) method
  Register the connection state listener.
• addLogListener( LogListener, [containingObject] ) method
  Register the log listener.
• addMenuItemCollection( collection ) method
  This function adds a menu item collection to the menu items for the screen.
• addMessageListener( filters, MessageListener, [containingObject] ) method
  Registers a message listener.
• addPushNotificationListener( PushNotificationListener, [containingObject] ) method
  Register a push notification listener.
• clearCache method
  This function clears the contents of the on-device request result cache for the current hybrid app.
• clearCacheItem( cachekey ) method
  This function clears an item from the contents of the on-device request result cache for the current hybrid app.
• close method
  This function closes the hybrid app.
• connectToServer( [onNotification] ) method
  Resumes the connection to the SUP server.
• convertLocalTimeToUtc( date ) method
  Converts the given Date object to UTC time, and returns the new Date.
• convertUtcToLocalTime( date ) method
  Converts the given Date object to the device's local time, and returns the new Date.
• disconnectFromServer method
  Suspends the connection to the SUP server.
• expireCredentials method
  Allows the user to set the credentials to the expired state for the current hybrid app.
• getAllMessages( [messageFilter], [completeList] ) method
  Gets received messages based on a filter and the existance of a default hybrid app.
• getAppByID( moduleID, version ) method
  
• getAppIconUrl( app, processed ) method
  This function gets the URL of the icon for a hybrid app depending on whether custom icons are defined.
• getApplicationConnectionID method
  Gets the Hybrid Web Container application connection ID.
• getBuiltInIconUrl( iconIndex, processed ) method
  Gets the icon URL for the built-in icon.
• getCallbackFromNativeError( errString ) method
  Extract the error call back method name from a URL string.
• getClientVariables( moduleID, version ) method
  Gets the client variables of the hybrid app with given module id and version.
• getCodeFromNativeError( errString ) method
  Extract an error code from a URL string.
• getCurrentApp method
  Gets the hybrid app that is currently open.
• getCurrentLocale method
  Returns the current locale.
• getCustomIconUrl( moduleId, moduleVersion, iconIndex, processed ) method
  Gets the URL to the custom icon.
• getDstOffsetAtGivenTimeInMinutes( date ) method
  Returns the daylight savings offset in minutes for the current timezone at the given time.
• getExternalResource( url, options ) method
  Makes an external cross domain request.
• getInstalledApps( [completeList] ) method
  
• getLocalizedDate( date ) method
  Returns a localized representation of the given Date object.
• getLocalizedDateTime( date ) method
  Returns a localized representation of the given Date object.
• getLocalizedTime( date ) method
  Returns a localized representation of the given Date object.
• getLogEntries method
  
• getLoggingAlertDialog method
  This function gets the callback used by hwc.log when it is required to notify the user of a log item.
• getLoggingCurrentLevel method
  This function gets the logging level.
• getMessageByID( msgId ) method
  
• getMsgIconUrl( msg ) method
  This function gets the URL of the icon for a message object depending on its processed status and whether there are custom icons defined.
• getNativeMessageFromNativeError( errString ) method
  Extract a native message from a URL string.
• getOffsetFromUTC( date ) method
  Returns the total offset (difference) between the given "local" time and UTC including any daylight savings offsets if applicable.
• getOnErrorMessageFromNativeError( errString ) method
  Extract the error message from a URL string.
• getPicture( onGetPictureError, onGetPictureSuccess, options ) method
  Requests retrieval of a picture asynchronously.
• getQueryVariable( variable ) method
  This function looks in the query string on the URL for the value corresponding to the given name.
• getServerInitiatedApps method
  
• getSharedStorageKey method
  Method to return the shared storage key defined for the hybrid app by designer.
• getTimezoneId method
  Returns a string containing the current Timezone's standard name.
• getTransformData method
  Returns the transform data for the hybridapp.
• getURLParamFromNativeError( paramName, url ) method
  Extract a parameter value from a URL string with a given parameter name.
• getUsesDST method
  Returns whether the device's current timezone practices daylight savings.
• getXMLHTTPRequest method
  Reliably returns an XMLHttpRequest object regardless of what platform this code is being executed on.
• guid method
  This function generates a GUID (globally unique identifier).
• hideProgressDialog method
  This function hides the progress dialog displaying the spinner.
• isAndroid method
  Returns true if the hybrid app application is being run on an Android platform.
• isAndroid3 method
  Returns true if the hybrid app application is being run on an Android 3.0 OS
• isBlackBerry method
  Returns true if the hybrid app application is being run on a BlackBerry platform.
• isBlackBerry5 method
  Returns true if the hybrid app application is being run on a BlackBerry 5.0 OS
• isBlackBerry5WithTouchScreen method
  Returns true if the hybrid app application is being run on a BlackBerry 5.0 OS with a touch screen
• isBlackBerry6NonTouchScreen method
  Returns true if the hybrid app application is being run on a BlackBerry 6.0 OS without a touch screen
• isBlackBerry7 method
  Returns true if the hybrid app application is being run on a BlackBerry 7.x OS
• isClosed method
  This function checks if the hybrid app has been closed.
• isDstActiveAtGivenTime( date ) method
  Returns whether daylight savings rules are in effect for the current timezone at the given time.
• isIOS method
  Returns true if the hybrid app application is being run on an iOS (e.g.
• isIOS4 method
  Returns true if the hybrid app application is being run on iOS4
• isIOS5 method
  Returns true if the hybrid app application is being run on iOS5
• isIOS6 method
  Returns true if the hybrid app application is being run on iOS6
• isIOS7 method
  Returns true if the hybrid app application is being run on iOS7
• isIPad method
  Returns true if the hybrid app application is being run on an iPad.
• isSharedStorageEnabled method
  Indicates whether the shared storage is enabled for the hybrid app.
• isWindows method
  Returns true if the hybrid app application is being run on a Windows platform.
• isWindowsMobile method
  Returns true if the hybrid app application is being run on a Windows Mobile platform.
• loadSettings method
  Loads the current connection settings from the native application storage.
• log( sMsg, eLevel, notifyUser ) method
  Allows the user to log a message to the device trace log which can be remotely retrieved from the server.
• markAsActivated method
  This function sets the activation required state for the current hybrid app to false.
• markAsProcessed method
  Allows the user to set the processed state to true for the current message.
• openApp( moduleId, version ) method
  Launch the hybrid app with the given module ID and version.
• openMessage( msgId ) method
  Launch the server initiated hybrid app associated with a message.
• removeAllMenuItems method
  This function removes all menu items that were added by the hybrid app.
• removeAppInstallationListener( AppInstallationListener ) method
  Remove the application installation listener.
• removeAppListener( ApplicationListener, [containingObject] ) method
  Remove the application listener.
• removeConnectionListener( ConnectionStateListener, [containingObject] ) method
  Remove the connection state listener.
• removeLogListener( LogListener, [containingObject] ) method
  Remove the log listener.
• removeMessage( msgId ) method
  Removes (deletes) a message.
• removeMessageListener( MessageListener, [containingObject] ) method
  Removes the message listener.
• removePushNotificationListener( PushNotificationListener, [containingObject] ) method
  Remove the push notification listener.
• sample_AppListener( event, moduleId, version ) method
  
• sample_ConnectionListener( event, errorCode, errorMessage ) method
  
• sample_InstallationAppListener( event, moduleId, version, moduleName, designerVersion, containerVersion ) method
  Sample application listener callback function
• sample_LogListener( milliseconds, event, optionalString ) method
  
• sample_MessageListener( flag, msgId ) method
  
• sample_PushNotificationListener( notifications ) method
  
• saveLoginCertificate( certificate ) method
  This function saves login credentials from a certificate to the credential cache. The common name is used for the username and the signed certificate is used for the password.
• saveLoginCredentials( userName, password ) method
  This function saves login credentials to the credential cache.
• saveSettings( settings ) method
  Save the connection settings to native application storage.
• setLoggingAlertDialog( newAlertDialogCallback ) method
  This function sets the callback used by hwc.log when it is required to notify the user of a log item.
• setLoggingCurrentLevel( newLoggingLevel ) method
  This function sets the logging level.
• setReportErrorFromNativeCallback method
  This function sets the callback function called when there is a native error reported. Calling this function will replace any callback that had been set previously.
• setScreenTitle_CONT( screenTitle ) method
  Sets the title of the screen.
• showAlertDialog( message, [title] ) method
  Displays an alert dialog to the user.
• showAttachmentContents_CONT( contents, mimeType, fileName, waitDialogCallbackString ) method
  Shows the given file contents in a content-appropriate way.
• showAttachmentFromCache_CONT( uniqueKey, mimeType, fileName, waitDialogCallbackString ) method
  Shows the given file contents in a content-appropriate way.
• showCertificatePicker method
  This function opens a form on the device that allows the user to specify the credentials for the use of certificate-based authentication.
• showConfirmDialog( message, [title] ) method
  Shows a confirm dialog to the user.
• showLocalAttachment( key ) method
  Shows a local attachment.
• showProgressDialog( [message] ) method
  This function shows a progress dialog with spinner.
• showUrlInBrowser( url ) method
  This function opens the supplied URL in a browser.
• shutdown method
  Shutdown the client connection to the SUP server.
• startClient( [onNotification] ) method
  Start the client connection to the SUP server.
• this.getIconUrl( processed ) method
  Gets the URL of this custom icon.
• updateMessageProcessed( msgId, status ) method
  Updates the message processed status.
• updateMessageRead( msgId, status ) method
  Updates the message read status.