atom.app.NotificationManager Maven / Gradle / Ivy
/*
* Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.app;
/**
* Class to notify the user of events that happen. This is how you tell
* the user that something has happened in the background.
*
* You do not instantiate this class directly; instead, retrieve it through
* {@link atom.content.Context#getSystemService}.
*
* @author Alex Voloshyn
* @version 1.2 2/22/15
*/
public interface NotificationManager {
/**
* Post an intent to be notified.
*
* @param notification the description of the event to notify
*/
void notify(Notification notification);
/**
* Retrieve count of the notifications for corresponded user.
*
* @param userIdentity identity of the user that should be notified
* @return count of the notification that should be send
*/
default long count(String userIdentity) {
throw new UnsupportedOperationException();
}
/**
* Retrieve count of the notifications for corresponded user and app.
*
* @param userIdentity identity of the user that should be notified
* @param appIdentity identity of the app that create notification
* @return count of the notification that should be send
*/
default long countFromApp(String userIdentity, String appIdentity) {
throw new UnsupportedOperationException();
}
/**
* Retrieve count of the notifications for corresponded user and source.
*
* @param userIdentity identity of the user that should be notified
* @param sourceIdentity identity of the source that create notification
* @return count of the notification that should be send
*/
default long countFromSource(String userIdentity, String sourceIdentity) {
throw new UnsupportedOperationException();
}
/**
* Read all notifications for corresponded user by source identity.
*
* @param userIdentity identity of the user that should be notified
* @param sourceIdentity identity of the source that create notification
*/
default void read(String userIdentity, String sourceIdentity) {
throw new UnsupportedOperationException();
}
/**
* Set listener for user notifications.
*
* @param userIdentity identity of the user that should be notified
* @param listener notification event listener
* @return an instance of the notification listener handler
*/
default NotificationListener.Handler watch(
String userIdentity, NotificationListener listener) {
throw new UnsupportedOperationException();
}
/**
* Set listener for user app notifications.
*
* @param userIdentity identity of the user that should be notified
* @param appIdentity identity of the app that create notification
* @param listener notification event listener
* @return an instance of the notification listener handler
*/
default NotificationListener.Handler watch(String userIdentity,
String appIdentity,
NotificationListener listener) {
throw new UnsupportedOperationException();
}
}