org.pigler.api

Class PiglerAPI

java.lang.Object

org.pigler.api.PiglerAPI

public final class PiglerAPI
extends java.lang.Object

Pigler Notifications Java API

Version:

1.4, API level 4

Author:

Shinovon

Field Summary

Fields

Modifier and Type	Field and Description
static int	DiscreetPopupConfirmationTone Popup plays the confirmation tone
static int	DiscreetPopupDurationLong Popup's duration is long (default is short)
static int	DiscreetPopupErrorTone Popup plays the error tone
static int	DiscreetPopupLightsOn Popup switches the device light on
static int	DiscreetPopupWarningTone Popup plays the warning tone

Constructor Summary

Constructors

Constructor and Description
PiglerAPI() Creates API instance

Method Summary

Modifier and Type	Method and Description
void	close() Closes API connection
int	createNotification(java.lang.String title, java.lang.String text, javax.microedition.lcdui.Image icon, boolean removeOnTap) Creates notification
int	getAPIVersion() Gets API version of installed plugin
java.lang.String	getAppName()
int	getGlobalNotificationsCount()
int	getIconSize()
int	getLastTappedNotification()
int	getMaxNotificationsCount()
int	getNotificationsCount()
int	init() Initializes API connection
int	init(java.lang.String appName) Initializes API connection with specified app name
boolean	isSingleLine() Check if platform supports only one row of text
int	removeAllNotifications() Removes all notifications created by this app or session
void	removeNotification(int uid) Removes notification
void	setLaunchAppOnTap(int uid, boolean launch) Marks that app needs to be launched on notification tap. By default it's true
void	setListener(IPiglerTapHandler listener) Sets notification tap handler for this app
void	setRemoveNotificationOnTap(int uid, boolean remove) Marks that notification needs to be removed on tap. By default it's true
void	showGlobalPopup(java.lang.String title, java.lang.String text, int flags) Shows global popup
void	updateNotification(int uid, javax.microedition.lcdui.Image icon) Updates notification icon
void	updateNotification(int uid, java.lang.String title, java.lang.String text) Updates notification text
void	updateNotification(int uid, java.lang.String title, java.lang.String text, javax.microedition.lcdui.Image icon) Updates notification

Methods inherited from class java.lang.Object

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

Field Detail

DiscreetPopupDurationLong

public static final int DiscreetPopupDurationLong

Popup's duration is long (default is short)

See Also:

Constant Field Values

DiscreetPopupLightsOn

public static final int DiscreetPopupLightsOn

Popup switches the device light on

See Also:

Constant Field Values

DiscreetPopupConfirmationTone

public static final int DiscreetPopupConfirmationTone

Popup plays the confirmation tone

See Also:

Constant Field Values

DiscreetPopupWarningTone

public static final int DiscreetPopupWarningTone

Popup plays the warning tone

See Also:

Constant Field Values

DiscreetPopupErrorTone

public static final int DiscreetPopupErrorTone

Popup plays the error tone

See Also:

Constant Field Values

Constructor Detail

PiglerAPI

public PiglerAPI()

Creates API instance

Method Detail

init

public int init()
         throws java.lang.Exception

Initializes API connection

Returns:

Missed notification id or 0

Throws:

java.lang.IllegalStateException - If already initialized

PiglerException - If initialization failed

java.lang.Exception

See Also:

init(String), close()

init

public int init(java.lang.String appName)
         throws java.lang.Exception

Initializes API connection with specified app name

Parameters:

appName - App name

Returns:

Missed notification id or 0

Throws:

java.lang.IllegalStateException - If already initialized

PiglerException - If initialization failed

java.lang.Exception

See Also:

close()

getAPIVersion

public int getAPIVersion()
                  throws java.lang.Exception

Gets API version of installed plugin

Returns:

Supported API level

Throws:

java.lang.IllegalStateException - If connection not initialized or closed

PiglerException - -18 If connection is not ready

java.lang.Exception

Since:

API level 2

createNotification

public int createNotification(java.lang.String title,
                              java.lang.String text,
                              javax.microedition.lcdui.Image icon,
                              boolean removeOnTap)
                       throws java.lang.Exception

Creates notification

Parameters:

title - Title text

text - Bottom text

icon - Icon, see getIconSize()

removeOnTap - Remove on tapped

Returns:

Notification id

Throws:

java.lang.IllegalStateException - If connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - If creation is failed

java.lang.Exception

See Also:

updateNotification(int, String, String, Image), setRemoveNotificationOnTap(int, boolean), updateNotification(int, Image), getIconSize()

updateNotification

public void updateNotification(int uid,
                               java.lang.String title,
                               java.lang.String text,
                               javax.microedition.lcdui.Image icon)
                        throws java.lang.Exception

Updates notification

Parameters:

uid - Notification id

title - Title text

text - Bottom text

icon - Icon, see getIconSize()

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

java.lang.IllegalArgumentException - If notification id is wrong

PiglerException - If connection is not ready

PiglerException - If update is failed

java.lang.Exception

See Also:

updateNotification(int, String, String), updateNotification(int, Image), getIconSize()

updateNotification

public void updateNotification(int uid,
                               java.lang.String title,
                               java.lang.String text)
                        throws java.lang.Exception

Updates notification text

Parameters:

uid - Notification id

title - Title text

text - Bottom text

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

java.lang.IllegalArgumentException - If notification id is wrong

PiglerException - -18 If connection is not ready

PiglerException - If update is failed

java.lang.Exception

updateNotification

public void updateNotification(int uid,
                               javax.microedition.lcdui.Image icon)
                        throws java.lang.Exception

Updates notification icon

Parameters:

uid - Notification id

icon - Icon, see getIconSize()

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

java.lang.IllegalArgumentException - If notification id is wrong

PiglerException - -18 If connection is not ready

PiglerException - If update is failed

java.lang.Exception

See Also:

getIconSize()

removeNotification

public void removeNotification(int uid)
                        throws java.lang.Exception

Removes notification

Parameters:

uid - Notification id

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - If remove is failed

java.lang.Exception

removeAllNotifications

public int removeAllNotifications()

Removes all notifications created by this app or session

Returns:

Removed notifications count

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

getLastTappedNotification

public int getLastTappedNotification()

Returns:

Last tapped notification id

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

setRemoveNotificationOnTap

public void setRemoveNotificationOnTap(int uid,
                                       boolean remove)
                                throws java.lang.Exception

Marks that notification needs to be removed on tap.
By default it's true

Parameters:

uid - Notification id

remove -

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - If update is failed

java.lang.Exception

setLaunchAppOnTap

public void setLaunchAppOnTap(int uid,
                              boolean launch)
                       throws java.lang.Exception

Marks that app needs to be launched on notification tap.
By default it's true

Parameters:

uid - Notification id

launch -

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - If update is failed

java.lang.Exception

Since:

API level 2

setListener

public void setListener(IPiglerTapHandler listener)

Sets notification tap handler for this app

Parameters:

listener - Tap handler

close

public void close()

Closes API connection

getAppName

public java.lang.String getAppName()

Returns:

Current app name

getMaxNotificationsCount

public int getMaxNotificationsCount()

Returns:

Maximum number of notifications that can be created at one time, negative value if unknown

Depends on platform

Since:

Java API 1.2 / API level 4

getNotificationsCount

public int getNotificationsCount()
                          throws java.lang.Exception

Returns:

Number of created notifications by this app

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - -5 If function is not supported

java.lang.Exception

Since:

Java API 1.2, API level 3

getGlobalNotificationsCount

public int getGlobalNotificationsCount()
                                throws java.lang.Exception

Returns:

Number of created notifications by all apps

Throws:

java.lang.IllegalStateException - if connection not initialized or closed

PiglerException - -18 If connection is not ready

PiglerException - -5 If function is not supported

java.lang.Exception

Since:

Java API 1.4, API level 4

isSingleLine

public boolean isSingleLine()

Check if platform supports only one row of text

Since:

Java API 1.4

getIconSize

public int getIconSize()

Returns:

Preferred icon size dimension

Since:

Java API 1.4

showGlobalPopup

public void showGlobalPopup(java.lang.String title,
                            java.lang.String text,
                            int flags)

Shows global popup

Parameters:

title - Title

text - Text, may be null

flags - Popup flags

Since:

Java API 1.4

See Also:

DiscreetPopupDurationLong, DiscreetPopupLightsOn, DiscreetPopupConfirmationTone, DiscreetPopupWarningTone, DiscreetPopupErrorTone