net.pushover.client.PushoverClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pushover-client Show documentation

A fork of the standard pushover client for java containing up to date features

There is a newer version: 1.1.1

package net.pushover.client;

import java.util.Set;

/**
 * Pushover.net client interface.
 * 
 * @author Sean Scanlon
 * 
 * @since Dec 18, 2012
 */
public interface PushoverClient {

    /**
     * Push a message to the service
     * 
     * @param msg The desired message
     * @return a {@link Status}
     * @throws PushoverException based on the results of the APIs
     */
    Status pushMessage(PushoverMessage msg) throws PushoverException;

    /**
     * Retrieve a list of available sounds from the service
     * 
     * @return a set of {@link PushOverSound}
     * @throws PushoverException based on the results of the APIs
     */
    Set getSounds() throws PushoverException;
}