Class UsersClient

java.lang.Object

ink.icoding.github4j.GithubClient

ink.icoding.github4j.client.UsersClient

public class UsersClient
extends GithubClient

GitHub 用户操作客户端。

提供获取用户信息、管理关注者、邮箱、SSH 公钥等功能。

Constructor Summary

Constructors

Constructor	Description
UsersClient(GithubClient parent)

Method Summary

Modifier and Type	Method	Description
boolean	checkFollowing(String targetUser)	检查当前用户是否关注了指定用户。
boolean	checkFollowing(String username, String targetUser)	检查用户 A 是否关注了用户 B。
void	follow(String targetUser)	关注指定用户。
GithubResponse<User>	getAuthenticatedUser()	获取当前已认证用户的信息。
GithubResponse<User>	getByUsername(String username)	通过用户名获取用户信息。
Page<User>	listAuthenticatedFollowers(PageOptions options)	列出当前已认证用户的关注者。
Page<User>	listAuthenticatedFollowing(PageOptions options)	列出当前已认证用户关注的人。
Page<PublicKey>	listAuthenticatedKeys(PageOptions options)	列出当前已认证用户的 SSH 公钥。
Page<Email>	listEmails(PageOptions options)	列出当前已认证用户的邮箱地址。
Page<User>	listFollowers(String username, PageOptions options)	列出指定用户的关注者。
Page<User>	listFollowing(String username, PageOptions options)	列出指定用户关注的人。
Page<Email>	listPublicEmails(String username)	列出指定用户的公开邮箱地址。
Page<PublicKey>	listPublicKeys(String username)	列出指定用户的公开 SSH 公钥。
void	unfollow(String targetUser)	取消关注指定用户。
GithubResponse<User>	updateAuthenticatedUser(Map<String,Object> updates)	更新当前已认证用户的个人信息。

Methods inherited from class GithubClient

actions, builder, configureObjectMapper, delete, get, get, getPaged, getRaw, gists, git, issues, meta, notifications, orgs, patch, post, projects, pulls, put, putNoBody, releases, repos, search, teams, users, webhooks

Modifier and Type	Method	Description
ActionsClient	actions()
static GithubClientBuilder	builder()
protected com.fasterxml.jackson.databind.ObjectMapper	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
protected GithubResponse<Void>	delete(String path)
protected <T> GithubResponse<T>	get(String path, com.fasterxml.jackson.core.type.TypeReference<T> typeRef, Map<String,String> queryParams)
protected <T> GithubResponse<T>	get(String path, Class<T> responseType, Map<String,String> queryParams)
protected <T> Page<T>	getPaged(String path, Class<T> itemType, Map<String,String> queryParams)
protected GithubResponse<byte[]>	getRaw(String path, Map<String,String> queryParams)
GistsClient	gists()
GitClient	git()
IssuesClient	issues()
MetaClient	meta()
NotificationsClient	notifications()
OrgsClient	orgs()
protected <T> GithubResponse<T>	patch(String path, Object body, Class<T> responseType)
protected <T> GithubResponse<T>	post(String path, Object body, Class<T> responseType)
ProjectsClient	projects()
PullRequestsClient	pulls()
protected <T> GithubResponse<T>	put(String path, Object body, Class<T> responseType)
protected GithubResponse<Void>	putNoBody(String path)
ReleasesClient	releases()
ReposClient	repos()
SearchClient	search()
TeamsClient	teams()
UsersClient	users()
WebhooksClient	webhooks()

Methods inherited from class Object

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

Constructor Details

UsersClient

public UsersClient(GithubClient parent)

Method Details

getAuthenticatedUser

public GithubResponse<User> getAuthenticatedUser()

获取当前已认证用户的信息。

对应端点: GET /user

Returns:

当前已认证用户的详细信息

updateAuthenticatedUser

public GithubResponse<User> updateAuthenticatedUser(Map<String,Object> updates)

更新当前已认证用户的个人信息。

对应端点: PATCH /user

Parameters:

updates - 要更新的字段（如 name, email, bio, company, location, blog 等）

Returns:

更新后的用户信息

getByUsername

public GithubResponse<User> getByUsername(String username)

通过用户名获取用户信息。

对应端点: GET /users/{username}

Parameters:

username - 目标用户名

Returns:

用户的公开信息

listFollowers

public Page<User> listFollowers(String username,
 PageOptions options)

列出指定用户的关注者。

对应端点: GET /users/{username}/followers

Parameters:

username - 目标用户名

options - 分页参数

Returns:

关注者列表（分页）

listAuthenticatedFollowers

public Page<User> listAuthenticatedFollowers(PageOptions options)

列出当前已认证用户的关注者。

对应端点: GET /user/followers

Parameters:

options - 分页参数

Returns:

关注者列表（分页）

listFollowing

public Page<User> listFollowing(String username,
 PageOptions options)

列出指定用户关注的人。

对应端点: GET /users/{username}/following

Parameters:

username - 目标用户名

options - 分页参数

Returns:

关注列表（分页）

listAuthenticatedFollowing

public Page<User> listAuthenticatedFollowing(PageOptions options)

列出当前已认证用户关注的人。

对应端点: GET /user/following

Parameters:

options - 分页参数

Returns:

关注列表（分页）

checkFollowing

public boolean checkFollowing(String targetUser)

检查当前用户是否关注了指定用户。

对应端点: GET /user/following/{username}

Parameters:

targetUser - 目标用户名

Returns:

true 表示已关注，false 表示未关注

checkFollowing

public boolean checkFollowing(String username,
 String targetUser)

检查用户 A 是否关注了用户 B。

对应端点: GET /users/{username}/following/{target_user}

Parameters:

username - 用户 A

targetUser - 用户 B

Returns:

true 表示已关注

follow

public void follow(String targetUser)

关注指定用户。

对应端点: PUT /user/following/{username}

Parameters:

targetUser - 要关注的用户名

unfollow

public void unfollow(String targetUser)

取消关注指定用户。

对应端点: DELETE /user/following/{username}

Parameters:

targetUser - 要取消关注的用户名

listEmails

public Page<Email> listEmails(PageOptions options)

列出当前已认证用户的邮箱地址。

对应端点: GET /user/emails

Parameters:

options - 分页参数

Returns:

邮箱列表（分页）

listPublicEmails

public Page<Email> listPublicEmails(String username)

列出指定用户的公开邮箱地址。

对应端点: GET /users/{username}/emails

Parameters:

username - 目标用户名

Returns:

公开邮箱列表（分页）

listPublicKeys

public Page<PublicKey> listPublicKeys(String username)

列出指定用户的公开 SSH 公钥。

对应端点: GET /users/{username}/keys

Parameters:

username - 目标用户名

Returns:

SSH 公钥列表（分页）

listAuthenticatedKeys

public Page<PublicKey> listAuthenticatedKeys(PageOptions options)

列出当前已认证用户的 SSH 公钥。

对应端点: GET /user/keys

Parameters:

options - 分页参数

Returns:

SSH 公钥列表（分页）