Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
src/webworks/notification
README.md
library.xml

README.md

Notification Profile API Information

NOTE: THIS IS A WORK IN PROGRESS

The Notification API will allow you to register your application with the BlackBerry Custom notification and sound profiles. Users can select their own preference for alert notification from applications as content is updated.

Authors: John Mutter

Known Issues

  • None

Tested On

  • BlackBerry Bold 9900 v7.0.0.261
  • BlackBerry Torch 9800 v6.0.0.227
  • BlackBerry Storm 9550 v5.0.0.469
  • BlackBerry Bold 9700 v5.0.0.469

Requires BlackBerry WebWorks SDK for Smartphones v2.0 or higher

Have a problem with this extension? Log an Issue or contact the Authors

How To Configure The Extension For Use

  1. Locate your BlackBerry WebWorks SDK for Smartphone extensions directory using your File Explorer. Default path is C:\Program Files\Research In Motion\BlackBerry WebWorks Packager\ext

  2. Create a new webworks.notification directory in the ext directory

  3. Download the source from this repository and unzip it to a location on your computer

  4. Using File Explorer browse to this extension's downloaded source code Smartphone\Notification

  5. Copy the library.xml file from the downloaded Smartphone\Notification directory to your new ext\webworks.notification directory

  6. Copy the downloaded Smartphone\Notification\src\webworks directory to your new ext\webworks.notification\webworks directory

NOTE: Be sure to back-up this ext\webworks.notification directory in your WebWorks SDK extensions directory before performing a WebWorks SDK upgrade. Simply copy it back into the ext directory after you have completed your SDK upgrade.

Required Feature ID

Whenever you use the below feature id in any of your WebWorks applications this extension will be loaded for use.

<feature id="webworks.notification" />

Summary

webworks.notification.register ( [String:App Guid Name] , [String:App Name] )

webworks.notification.fire ( [String:App Guid Name] )

webworks.notification.cancel ( [String:App Guid Name] )

webworks.notification.unregister ( [String:App Guid Name] )

Options Summary

Item Summary

[String:App Guid Name] // This should be a unique package like name to identify your application example... "com.demo.myapp"

[String:App Name] // This is the friendly name you would see in the sounds for a selected profile list. "My Application Name"

Initialization Example

function startTasks() {

        webworks.notification.register ( "com.demo.myappname" , "My Application Name" )

    }

function fireEvent() {

  webworks.notification.fire ( "com.demo.myappname" )

}

function cancelEvent() {

  webworks.notification.cancel ( "com.demo.myappname" )

}