com.symbol.emdk.notification

Class NotificationDevice

java.lang.Object

com.symbol.emdk.notification.NotificationDevice

public class NotificationDevice
extends java.lang.Object

NotificationDevice class will represent and provides access to the physical notification device instance. This can be used with a connected notification device. Once notification device is disconnected, current instance cannot be used any longer, therefore it must be released using NotificationDevice.release() method. When connected again, you must use NotificationManager.getDevice() method to get a new notification device object.

Method Summary

Modifier and Type	Method and Description
void	cancelNotification() This cancels the active notification from the device.
void	disable() Disables the notification device.
void	enable() Enables the notification device.
DeviceInfo	getDeviceInfo() Returns information about the notification device.
boolean	isConnected() Returns whether the notification device is connected to the Mobile device or not.
boolean	isEnabled() Returns whether the notification device is enabled or not.
void	notify(Notification notification) This sends the notification information to the device.
void	release() Releases the notification device.

Methods inherited from class java.lang.Object

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

Method Detail

getDeviceInfo

public DeviceInfo getDeviceInfo()

Returns information about the notification device.

Returns:

Returns the DeviceInfo object.

isConnected

public boolean isConnected()

Returns whether the notification device is connected to the Mobile device or not.

Returns:

true if it is connected else false.

isEnabled

public boolean isEnabled()

Returns whether the notification device is enabled or not.

Returns:

true if it is enabled else false.

enable

public void enable()
            throws NotificationException

Enables the notification device. This opens the communication port to send the notifications to the devices. You must call disable() when you are done.

 
 Example Usage:
 device.enable();
 
 

Throws:

NotificationException - The exception will be thrown if the notification device enable fails.

disable

public void disable()
             throws NotificationException

Disables the notification device. This closes the communication port.

 
 Example Usage:
 device.disable();
 
 

Throws:

NotificationException - The exception will be thrown if the notification device disable fails.

notify

public void notify(Notification notification)
            throws NotificationException

This sends the notification information to the device.

 
 Example Usage:
 		Notification notification = new Notification();
 		notification.led.color = 0xFF0000;
 		notification.led.onTime =  1000;
 		notification.led.offTime = 500;
 		notification.led.repeatCount = 2;	
 		notification.vibrate.pattern = new long[] {100,200,100,200,100,200};		
 		notificationDevice.notify(notification);
 
 

Throws:

NotificationException - The exception will be thrown if the notification fails.

cancelNotification

public void cancelNotification()
                        throws NotificationException

This cancels the active notification from the device.

 
 Example Usage:	 		
 		notificationDevice.cancelNotification();
 
 

Throws:

NotificationException - The exception will be thrown if the notification cancel fails.

release

public void release()
             throws NotificationException

Releases the notification device. You must release the notification device when you are done using it, so that internal resources can be freed up. Once you release, the notification device object will be unusable and you must use NotificationManager.getDevice() method to get a new notification device object.

 
 Example Usage:
 device.release();
 
 

Throws:

NotificationException - The exception will be thrown if the notification device release fails.