com.openfin.desktop
Class Notification

java.lang.Object
  com.openfin.desktop.Notification

public class Notification
extends Object

A Notification represents a window on App Desktop which is shown briefly to the user on the bottom-right corner of the primary monitor. A notification is typically used to alert the user of some important event which requires his or her attention. Multiple notifications can be generated at once but will queue if more than 5 are already displayed. Notifications can be dismissed by dragging them to the right with the mouse and can communicate securely with their invoking applications.

Since:

9/4/14

Author:

wche

Constructor Summary

Notification(NotificationOptions notificationOptions, NotificationListener notificationListener, DesktopConnection desktopConnection, AckListener listener)
Notification constructor

Method Summary

void	close(AckListener listener) Closes the notification
void	sendMessage(org.json.JSONObject message, AckListener listener) Sends a message to the notification
void	sendMessageToApplication(org.json.JSONObject message, AckListener listener) Sends a message from the notification to the application that created the notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notification

public Notification(NotificationOptions notificationOptions,
                    NotificationListener notificationListener,
                    DesktopConnection desktopConnection,
                    AckListener listener)
             throws Exception

Notification constructor

Parameters:

notificationOptions - The options of this notification

desktopConnection - Connection to Desktop

notificationListener - NotificationListener for the notification

listener - AckListener for the request

Throws:

Exception

See Also:

NotificationListener, AckListener

Method Detail

close

public void close(AckListener listener)

Closes the notification

Parameters:

listener - AckListener for the request

See Also:

AckListener

sendMessage

public void sendMessage(org.json.JSONObject message,
                        AckListener listener)

Sends a message to the notification

Parameters:

message - The JSON message to be sent to the notification

listener - AckListener for the request

See Also:

AckListener

sendMessageToApplication

public void sendMessageToApplication(org.json.JSONObject message,
                                     AckListener listener)

Sends a message from the notification to the application that created the notification. The message is handled by the notification's onMessage callback.

Parameters:

message - The JSON message to be sent to the application

listener - AckListener for the request

See Also:

AckListener