ds.desktop.notify.service

Class NotifyClient

java.lang.Object

ds.desktop.notify.service.NotifyService

ds.desktop.notify.service.NotifyClient

public class NotifyClient
extends NotifyService

A NotifyClient allows to use a notification service running on another process of the host in order to display notifications, just like if the service were running on this process.

Since:

0.9 (2019-06-18)

Field Summary

Fields inherited from class ds.desktop.notify.service.NotifyService

DARK_THEME, LIGHT_THEME, LISTENING_PORT

Constructor Summary

Constructors

Constructor and Description
NotifyClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	postNotification(java.lang.String title, java.lang.String message, java.lang.Integer type, java.lang.Integer align, java.lang.Long timeout, java.lang.String themeName) Posts a new notification to the service, setting the parameters needed for it.
void	start() Starts the service, in case it hasn't been started yet.
void	stop() Stops the service, in case it's running.
protected static NotifyClient	tryAndGet() Attempts to create a NotifyClient object and polls for any NotifyServer running on this host.

Methods inherited from class ds.desktop.notify.service.NotifyService

get, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

NotifyClient

public NotifyClient()

Method Detail

start

public void start()

Description copied from class: NotifyService

Starts the service, in case it hasn't been started yet.

Specified by:

start in class NotifyService

postNotification

public void postNotification(java.lang.String title,
                    java.lang.String message,
                    java.lang.Integer type,
                    java.lang.Integer align,
                    java.lang.Long timeout,
                    java.lang.String themeName)

Description copied from class: NotifyService

Posts a new notification to the service, setting the parameters needed for it.

Specified by:

postNotification in class NotifyService

Parameters:

title - The title to display.

message - The message to display.

type - The notification type (0~7).

align - The text/layout alignment (0,1).

timeout - The maximum time in milliseconds the notification will stay on screen.

themeName - Either "light" or "dark", refering to the two stock themes available.

See Also:

NotifyService.DARK_THEME, NotifyService.LIGHT_THEME

stop

public void stop()

Description copied from class: NotifyService

Stops the service, in case it's running.

Specified by:

stop in class NotifyService

tryAndGet

protected static NotifyClient tryAndGet()

Attempts to create a NotifyClient object and polls for any NotifyServer running on this host. If the service is located, the client is kept and returned to the caller.

Returns:

A newly created NotifyClient, able to connect to a local NotifyServer running on this host, or null if no service could be located.