Coverage Report - com.jcabi.github.GitHubThread
 
Classes in this File Line Coverage Branch Coverage Complexity
GitHubThread
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright (c) 2013-2015, jcabi.com
 3  
  * All rights reserved.
 4  
  *
 5  
  * Redistribution and use in source and binary forms, with or without
 6  
  * modification, are permitted provided that the following conditions
 7  
  * are met: 1) Redistributions of source code must retain the above
 8  
  * copyright notice, this list of conditions and the following
 9  
  * disclaimer. 2) Redistributions in binary form must reproduce the above
 10  
  * copyright notice, this list of conditions and the following
 11  
  * disclaimer in the documentation and/or other materials provided
 12  
  * with the distribution. 3) Neither the name of the jcabi.com nor
 13  
  * the names of its contributors may be used to endorse or promote
 14  
  * products derived from this software without specific prior written
 15  
  * permission.
 16  
  *
 17  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 18  
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 19  
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 20  
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 21  
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 22  
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 23  
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 24  
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 25  
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 26  
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 27  
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 28  
  * OF THE POSSIBILITY OF SUCH DAMAGE.
 29  
  */
 30  
 package com.jcabi.github;
 31  
 
 32  
 /**
 33  
  * Represents a GitHub notifications thread.
 34  
  * @author Dmitri Pisarenko (dp@altruix.co)
 35  
  * @version $Id$
 36  
  * @since 1.0
 37  
  */
 38  
 public interface GitHubThread {
 39  
     /**
 40  
      * Marks this thread as read.
 41  
      * @see <a href="https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read">Mark a thread as read</a>
 42  
      */
 43  
     void markAsRead();
 44  
 
 45  
     /**
 46  
      * Checks, if the current user is subscribed to this thread.
 47  
      * @see <a href="https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription">Get a Thread Subscription</a>
 48  
      * @return Subscription data, if the user is subscribe, null otherwise.
 49  
      */
 50  
     ThreadSubscription getSubscription();
 51  
 
 52  
     /**
 53  
      * Subscribes the user to the thread and/or makes the user ignore the
 54  
      *  thread.
 55  
      * @see <a href="https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription">Set a Thread Subscription</a>
 56  
      * @param subscribe True, if notifications should be received from this
 57  
      *  thread.
 58  
      * @param ignore True, if all notifications should be blocked from this
 59  
      *  thread.
 60  
      * @return Data of the subscription.
 61  
      */
 62  
     ThreadSubscription setSubscription(final boolean subscribe,
 63  
         final boolean ignore);
 64  
 
 65  
     /**
 66  
      * Unsubscribes the user from this thread.
 67  
      * @see <a href="https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription">Delete a Thread Subscription</a>
 68  
      */
 69  
     void deleteSubscription();
 70  
 }