1 /**
2 * Copyright (c) 2013-2023, 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 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34
35 /**
36 * Public members of a GitHub organization.
37 *
38 * @author Chris Rebert (github@chrisrebert.com)
39 * @version $Id: c4462e2aee5d1433175ca6e6c9e338116cd2f5fc $
40 * @see <a href="https://developer.github.com/v3/orgs/members/">Organization Members API</a>
41 * @since 0.24
42 */
43 @Immutable
44 public interface PublicMembers {
45 /**
46 * Organization of which these are public members.
47 * @return Organization
48 */
49 Organization org();
50
51 /**
52 * Conceal a user's membership from public view.
53 * @param user User whose membership to conceal
54 * @throws IOException If an I/O problem occurs
55 * @see <a href="https://developer.github.com/v3/orgs/members/#conceal-a-users-membership">Conceal a user's membership</a>
56 */
57 void conceal(
58 User user
59 ) throws IOException;
60
61 /**
62 * Make a user's membership publicly visible.
63 * @param user User whose membership to publicize
64 * @throws IOException If an I/O problem occurs
65 * @see <a href="https://developer.github.com/v3/orgs/members/#publicize-a-users-membership">Publicize a user's membership</a>
66 */
67 void publicize(
68 User user
69 ) throws IOException;
70
71 /**
72 * Get all users who are public members of this organization.
73 * @return Members
74 * @see <a href="https://developer.github.com/v3/orgs/members/#public-members-list">Public members list</a>
75 */
76 Iterable<User> iterate();
77
78 /**
79 * Check whether the user is a public member of this organization.
80 * @param user User to check public organization membership of
81 * @return Is the user a public member of this organization?
82 * @throws IOException If an I/O problem occurs
83 * @see <a href="https://developer.github.com/v3/orgs/members/#check-public-membership">Check public membership</a>
84 */
85 boolean contains(
86 User user
87 ) throws IOException;
88 }