Repository navigation
Expand file tree
/
Copy pathGHInvitation.java
More file actions
114 lines (101 loc) · 3.12 KB
/
Copy pathGHInvitation.java
File metadata and controls
114 lines (101 loc) · 3.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
package org.kohsuke.github;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.net.URL;
// TODO: Auto-generated Javadoc
/**
* The type GHInvitation.
*
* @see GitHub#getMyInvitations() GitHub#getMyInvitations()
* @see GHRepository#listInvitations() GHRepository#listInvitations()
* @see <a href="https://docs.github.com/en/rest/collaborators/invitations">Repository invitations API</a>
*/
@SuppressFBWarnings(
value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD",
"UUF_UNUSED_FIELD" },
justification = "JSON API")
public class GHInvitation extends GHObject {
private boolean expired;
private String htmlUrl;
private GHUser invitee, inviter;
private String permissions;
private GHRepository repository;
/**
* Create default GHInvitation instance
*/
public GHInvitation() {
}
/**
* Accept a repository invitation.
*
* @throws IOException
* the io exception
* @see <a href= "https://docs.github.com/en/rest/collaborators/invitations#accept-a-repository-invitation">Accept a
* repository invitation</a>
*/
public void accept() throws IOException {
root().createRequest().method("PATCH").withUrlPath("/user/repository_invitations/" + getId()).send();
}
/**
* Decline a repository invitation.
*
* @throws IOException
* the io exception
* @see <a href= "https://docs.github.com/en/rest/collaborators/invitations#decline-a-repository-invitation">Decline
* a repository invitation</a>
*/
public void decline() throws IOException {
root().createRequest().method("DELETE").withUrlPath("/user/repository_invitations/" + getId()).send();
}
/**
* Gets the html url.
*
* @return the html url
*/
public URL getHtmlUrl() {
return GitHubClient.parseURL(htmlUrl);
}
/**
* Gets the invitee (the user being invited).
*
* @return the invitee
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public GHUser getInvitee() {
return invitee;
}
/**
* Gets the inviter (the user who created the invitation).
*
* @return the inviter
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public GHUser getInviter() {
return inviter;
}
/**
* Gets the permission associated with the invitation.
*
* @return the permission (e.g. "read", "write", "admin", "triage", "maintain")
*/
public String getPermission() {
return permissions;
}
/**
* Gets the repository for this invitation.
*
* @return the repository
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public GHRepository getRepository() {
return repository;
}
/**
* Whether this invitation has expired.
*
* @return true if expired
*/
public boolean isExpired() {
return expired;
}
}