Package com.jcabi.github

Interface Collaborators

@Immutable
public interface Collaborators

GitHub repository collaborators.

Since:

0.8

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Collaborators.Permission	Permission levels a user can be granted in an organization repository.

Method Summary

Modifier and Type	Method	Description
void	add(String user)	Add user as a collaborator.
void	addWithPermission(String user, Collaborators.Permission permission)	Add user with permissions.
boolean	isCollaborator(String user)	Check if a user is collaborator.
Iterable<User>	iterate()	Iterates over repo collaborators.
String	permission(String user)	Get user permission in this repo.
void	remove(String user)	Remove user as a collaborator.
Repo	repo()	Owner of them.

Method Details

repo

Repo repo()

Owner of them.

Returns:

Repo

isCollaborator

boolean isCollaborator(String user)
                throws IOException

Check if a user is collaborator.

Parameters:

user - User

Returns:

True is a user is a collaborator, otherwise returns false

Throws:

IOException - If there is any I/O problem

See Also:

• Check if a user is collaborator

add

void add(String user)
  throws IOException

Add user as a collaborator.

Parameters:

user - User

Throws:

IOException - If there is any I/O problem

See Also:

• Add user as a collaborator

addWithPermission

void addWithPermission(String user,
 Collaborators.Permission permission)
                throws IOException

Add user with permissions. Only works on an organization repository

Parameters:

user - User to add

permission - Permission level to grant

Throws:

IOException - if there is an I/O problem

See Also:

• invalid input: '<a href=https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator">Add user as a collaborator</a>'

permission

String permission(String user)
           throws IOException

Get user permission in this repo.

Parameters:

user - User to check

Returns:

Permission level granted, incl. "admin", "write", "read", or "none"

Throws:

IOException - if there is an I/O problem

See Also:

• invalid input: '<a href=https://docs.github.com/en/rest/collaborators/collaborators#get-repository-permissions-for-a-user">Get repository permissions for a user</a>'

remove

void remove(String user)
     throws IOException

Remove user as a collaborator.

Parameters:

user - User

Throws:

IOException - If there is any I/O problem

See Also:

• Remove user as a collaborator

iterate

Iterable<User> iterate()

Iterates over repo collaborators.

Returns:

Iterator on repo collaborators.