Interface User

All Superinterfaces:
JsonPatchable, JsonReadable
All Known Implementing Classes:
User.Smart

@Immutable public interface User extends JsonReadable, JsonPatchable
GitHub user.
Since:
0.1
See Also:
Suppressed Checkstyle violations:
MultipleStringLiterals (500 lines)
  • Method Details

    • github

      GitHub github()
      GitHub we're in.
      Returns:
      GitHub
    • 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
    • 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:
    • 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: