Enum Class Client.Scope

java.lang.Object
java.lang.Enum<Client.Scope>
chariot.Client.Scope
All Implemented Interfaces:
Serializable, Comparable<Client.Scope>, Constable
Enclosing class:
Client
public static enum Client.Scope extends Enum<Client.Scope>
OAuth scopes representing different permissions

  • Enum Constant Details

    • preference_read

      public static final Client.Scope preference_read
      Read your preferences

    • preference_write

      public static final Client.Scope preference_write
      Write your preferences

    • email_read

      public static final Client.Scope email_read
      Read your email address

    • challenge_read

      public static final Client.Scope challenge_read
      Read incoming challenges

    • challenge_write

      public static final Client.Scope challenge_write
      Create, accept, decline challenges

    • challenge_bulk

      public static final Client.Scope challenge_bulk
      Create, delete, query bulk pairings

    • study_read

      public static final Client.Scope study_read
      Read private studies and broadcasts

    • study_write

      public static final Client.Scope study_write
      Create, update, delete studies and broadcasts

    • tournament_write

      public static final Client.Scope tournament_write
      Create tournaments

    • racer_write

      public static final Client.Scope racer_write
      Create and join puzzle races

    • puzzle_read

      public static final Client.Scope puzzle_read
      Read puzzle activity

    • team_read

      public static final Client.Scope team_read
      Read private team information

    • team_write

      public static final Client.Scope team_write
      Join, leave

    • team_lead

      public static final Client.Scope team_lead
      Manage teams (kick members, send team messages, accept/decline join requests)

    • msg_write

      public static final Client.Scope msg_write
      Send private messages to other players

    • board_play

      public static final Client.Scope board_play
      Play with the Board API

    • bot_play

      public static final Client.Scope bot_play
      Play with the Bot API. Only for Bot accounts

    • follow_read

      public static final Client.Scope follow_read
      Read followed players

    • follow_write

      public static final Client.Scope follow_write
      Follow and Unfollow players

    • engine_read

      public static final Client.Scope engine_read
      View and use your external engines

    • engine_write

      public static final Client.Scope engine_write
      Create and update external engines

    • web_login

      public static final Client.Scope web_login
      Create authenticated website sessions (grants full access!)

    • web_mod

      public static final Client.Scope web_mod

    • any

      public static final Client.Scope any

  • Method Details

    • values

      public static Client.Scope[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Client.Scope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • asString

      public String asString()

    • fromString

      public static Optional<Client.Scope> fromString(String scope)