1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.notifications

File NotificationConfiguration.java

 

Code metrics

0
0
0
1
52
9
0
-
-
0
-

Classes

Class Line # Actions
NotificationConfiguration 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.notifications;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Get the configuration options concerning the Notification module.
26    *
27    * @version $Id: 233f560ca2a470af4bacfaa1224baa4fdb1b7cc7 $
28    * @since 9.4RC1
29    */
30    @Role
 
31    public interface NotificationConfiguration
32    {
33    /**
34    * @return true if the notification module should be enabled
35    */
36    boolean isEnabled();
37   
38    /**
39    * @return true if the notification module can send emails
40    * @since 9.5RC1
41    */
42    boolean areEmailsEnabled();
43   
44    /**
45    * Get the number of minutes for the notification emails grace time. If the value is 0, then the email will be
46    * instantly sent.
47    *
48    * @return the number of minutes that should last before sending a live notification mail
49    * @since 9.6RC1
50    */
51    int liveNotificationsGraceTime();
52    }