Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Update README.md

latest commit fba312e95a
Chad Tetreault authored

README.md

Toast Sample

This sample demonstrates how to integrate Toast messages into a BlackBerry WebWorks application for BlackBerry 10. The API documentation is available here.

The sample code for this application is Open Source under the Apache 2.0 License.

Applies To

Author(s)

Dependencies

  1. bbUI.js is licensed under the Apache 2.0 license.

Icons
Icons used here are from http://subway.pixle.pl/rim are licensed under the CC-BY-3.0 license. This is a subset of the Subway icons available at http://subway.pixle.pl/

To contribute code to this repository you must be signed up as an official contributor.

Screenshots

Screenshot

Initial Setup

The following must be added to your CONFIG.XML in order to use the toast API.

<feature id="blackberry.ui.toast" />

How to Use

Displaying a Toast message is really easy. This sample app shows you two methods. Simple, and Custom.

Simple Toast

Displays a custom message to the user for a few seconds, then disappears.

var message = 'This is a simple Toast';
blackberry.ui.toast.show(message);

Custom Toast

Displays a custom message, with an optional button (with callbacks).

var message = 'This is my toast!',
    buttonText = 'Click Me',
    toastId,

onButtonSelected = function () {
    alert('Button was clicked for toast: ' + toastId);
},

onToastDismissed = function () {
    alert('Toast disappeared: ' + toastId);
};

options = {
    buttonText : buttonText,
    buttonCallback : onButtonSelected,
    dismissCallback : onToastDismissed
};

toastId = blackberry.ui.toast.show(message, options);

How to Build

  1. Clone this repo to your local machine.

  2. Ensure the BlackBerry 10 WebWorks SDK 2.0 is correctly installed.

  3. Open a command prompt (windows) or terminal (mac) and run the following command:

    webworks create <your source folder>\Toast
    
  4. Replace the default Toast\www folder with the \www folder from this project

  5. Replace the default Toast\config.xml with the config.xml from this project

  6. From the command prompt (Windows) or terminal (mac), navigate to the Toast folder

    cd <your source folder>\Toast
    
  7. Run the following commands to configure plugins used by this app

    webworks plugin add com.blackberry.ui.toast
    
  8. Run the following command to build and deploy the app to a device connected via USB

    webworks run
    

More Info

Contributing Changes

Please see the README of the BB10-WebWorks-Samples repository for instructions on how to add new Samples or make modifications to existing Samples.

Bug Reporting and Feature Requests

If you find a bug in a Sample, or have an enhancement request, simply file an Issue for the Sample.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.