Enum UserState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<UserState>

    public enum UserState
    extends java.lang.Enum<UserState>
    Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Active
      User state is active.
      Blocked
      User is blocked.
      Deleted
      User account is closed.
      Pending
      User account is pending.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getValue()  
      java.lang.String toString()  
      static UserState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static UserState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • Active

        public static final UserState Active
        User state is active.
      • Blocked

        public static final UserState Blocked
        User is blocked. Blocked users cannot authenticate at developer portal or call API.
      • Pending

        public static final UserState Pending
        User account is pending. Requires identity confirmation before it can be made active.
      • Deleted

        public static final UserState Deleted
        User account is closed. All identities and related entities are removed.
    • Method Detail

      • values

        public static UserState[] 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 (UserState c : UserState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static UserState valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getValue

        public java.lang.String getValue()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<UserState>