Package org.kohsuke.github
Class GHMembership
- java.lang.Object
-
- org.kohsuke.github.GHMembership
-
public class GHMembership extends Object
Represents a membership of a user in an organization.- Author:
- Kohsuke Kawaguchi
- See Also:
GHMyself#listOrgMemberships()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGHMembership.RoleRole of a user in an organization.static classGHMembership.StateWhether a role is currently active or waiting for acceptance (pending).
-
Constructor Summary
Constructors Constructor Description GHMembership()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidactivate()Accepts a pending invitation to an organization.GHOrganizationgetOrganization()Gets organization.GHMembership.RolegetRole()Gets role.GitHubgetRoot()Deprecated.For access to theGitHubinstance, use a local copy instead of pulling it out of objects.GHMembership.StategetState()Gets state.URLgetUrl()Gets url.GHUsergetUser()Gets user.
-
-
-
Method Detail
-
getUrl
public URL getUrl()
Gets url.- Returns:
- the url
-
getState
public GHMembership.State getState()
Gets state.- Returns:
- the state
-
getRole
public GHMembership.Role getRole()
Gets role.- Returns:
- the role
-
getUser
public GHUser getUser()
Gets user.- Returns:
- the user
-
getOrganization
public GHOrganization getOrganization()
Gets organization.- Returns:
- the organization
-
activate
public void activate() throws IOExceptionAccepts a pending invitation to an organization.- Throws:
IOException- the io exception- See Also:
GHMyself#getMembership(GHOrganization)
-
getRoot
@Deprecated public GitHub getRoot()
Deprecated.For access to theGitHubinstance, use a local copy instead of pulling it out of objects.Get the rootGitHubinstance for this object.- Returns:
- the root
GitHubinstance
-
-