# Titanium.UI.Notification

A toast notification.

Availability

0.8

Extends

# Overview

Android	iOS

A toast notification is an unobtrusive, pop-up notification that does not block the UI. Use the Titanium.UI.createNotification method or <Notification> Alloy element to create a Toast notification.

On Android, by default, a toast notification appears centered on the bottom half of the screen. On Windows Phone, by default, a toast notification appears over the status bar on the top part of the screen.

# Examples

# Simple Toast Notification

The simplest use case is also the most common.

var toast = Ti.UI.createNotification({
    message:"Please Stand By",
    duration: Ti.UI.NOTIFICATION_DURATION_LONG
});
toast.show();

# Alloy XML Markup

Previous example as an Alloy view.

index.xml

<Alloy>
    <Window>
        <Notification id="toast" platform="android" message="Please Stand By" duration="Ti.UI.NOTIFICATION_DURATION_LONG" />
    </Window>
</Alloy>

index.js

$.index.open();
$.toast.show();

# Properties

# apiName READONLY

Availability

3.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

3.0.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# duration

Availability

0.8

duration :Number

Determines how long the notification stays on screen.

This API can be assigned the following constants:

Default: Titanium.UI.NOTIFICATION_DURATION_SHORT

# gravity

Availability

5.4.0

gravity :Number

Determines the location at which the notification should appear on the screen.

This API can be assigned the following constants:

# horizontalMargin

Availability

0.8

horizontalMargin :Number

Horizontal placement of the notification, as a fraction of the screen width.

Useful values range from -0.5 (far left) to 0.5 (far right). A value of zero indicates default placement.

Default: 0

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# message

Availability

0.8

message :String

Notification text to display.

# verticalMargin

Availability

0.8

verticalMargin :Number

Vertical placement of the notifcation, as a fraction of the screen height.

Useful values range from -0.5 (top) to 0.5 (bottom). A value of zero indicates default placement.

Default: 0

# xOffset

Availability

0.8

xOffset :Number

X offset from the default position, in pixels.

Default: 0

# yOffset

Availability

0.8

yOffset :Number

Y offset from the default position, in pixels.

Default: 0

# Methods

# addEventListener

Availability

0.8

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.0.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# fireEvent

Availability

0.8

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type: void

# removeEventListener

Availability

0.8

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# show

Availability

0.8

show() → void

Show the notification.

Returns

Type: void