com.jcabi.github

Interface User

All Superinterfaces:

JsonPatchable, JsonReadable

All Known Implementing Classes:

User.Smart

@Immutable
public interface User
extends JsonReadable, JsonPatchable

Github user.

Since:

0.1

Version:

$Id: 73655046e068b217d1443bc61c4a1c1f0ac52c3c $

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

User API

Suppressed Checkstyle violations:

MultipleStringLiterals (500 lines)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	User.Smart Smart user with extra features.

Method Summary

Modifier and Type	Method and Description
UserEmails	emails() Get user's emails.
Github	github() Github we're in.
PublicKeys	keys() Get his keys.
String	login() Get his login.
void	markAsRead(Date lastread) Marks notifications as read.
Notifications	notifications() Notifications for this user.
UserOrganizations	organizations() Get his organizations.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Methods inherited from interface com.jcabi.github.JsonPatchable

patch

Method Detail

github

Github github()

Github we're in.

Returns:

Github

Since:

0.4

login

String login()
      throws IOException

Get his login.

Returns:

Login name

Throws:

IOException - If it fails

organizations

UserOrganizations organizations()

Get his organizations.

Returns:

UserOrganizations organizations

keys

PublicKeys keys()

Get his keys.

Returns:

PublicKeys keys

emails

UserEmails emails()

Get user's emails.

Returns:

User's emails

Since:

0.8

notifications

Notifications notifications()
                     throws IOException

Notifications for this user. Wraps the call "List your notifications". See "List your notifications" at https://developer.github.com/v3/activity/notifications/

Returns:

Notifications for this user.

Throws:

IOException - Thrown, if an error during sending request and/or receiving response occurs.

See Also:

List your notifications

markAsRead

void markAsRead(Date lastread)
         throws IOException

Marks notifications as read.

Parameters:

lastread - Describes the last point that notifications were checked.

Throws:

IOException - Thrown, if an error during sending request and/or receiving response occurs.

See Also:

Mark as read