Package com.spotify.github.v3.clients

Class UserClient

java.lang.Object

com.spotify.github.v3.clients.UserClient

public class UserClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_CONTENT

Method Summary

Modifier and Type	Method	Description
GithubAppClient	createGithubAppClient()
CompletableFuture<Boolean>	suspendUser(String username, SuspensionReason reason)	Suspend a user.
CompletableFuture<Boolean>	unSuspendUser(String username, SuspensionReason reason)	Unsuspend a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_CONTENT

public static final int NO_CONTENT

See Also:

Constant Field Values

Method Detail

createGithubAppClient

public GithubAppClient createGithubAppClient()

suspendUser

public CompletableFuture<Boolean> suspendUser(String username,
                                              SuspensionReason reason)

Suspend a user.

Parameters:

username - username of the user to suspend

Returns:

a CompletableFuture that indicates success or failure

unSuspendUser

public CompletableFuture<Boolean> unSuspendUser(String username,
                                                SuspensionReason reason)

Unsuspend a user.

Parameters:

username - username of the user to unsuspend

Returns:

a CompletableFuture that indicates success or failure