Enum APISession.Status

  • All Implemented Interfaces:
    Serializable, Comparable<APISession.Status>
    Enclosing class:
    APISession

    public static enum APISession.Status
    extends Enum<APISession.Status>
    Represents the different states of a session.


    By default, sessions are not authorized for general API communication. Only login/refresh requests may be allowed. During the execution of these kind of requests, the session authorization is in progress. In case the login/refresh was successful the session is authorized and ready for general API communication.

    • Enum Constant Detail

      • NOT_AUTHORIZED

        public static final APISession.Status NOT_AUTHORIZED
        Session authorization is pending
      • AUTHORIZATION_IN_PROGRESS

        public static final APISession.Status AUTHORIZATION_IN_PROGRESS
        Session authorization is currently in progress
      • AUTHORIZED

        public static final APISession.Status AUTHORIZED
        Session authorization completed successfully
    • Method Detail

      • values

        public static APISession.Status[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (APISession.Status c : APISession.Status.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static APISession.Status valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null