Bold360 and BoldChat Developer Center

UnavailableReason

com.boldchat.visitor.api

Enum UnavailableReason

  • java.lang.Object
    • java.lang.Enum<UnavailableReason>
      • com.boldchat.visitor.api.UnavailableReason
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<UnavailableReason>


    public enum UnavailableReason
    extends java.lang.Enum<UnavailableReason>
    The possible reasons for chat to be unavailable.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      NoOperators
      No operators are logged in as available.
      OutsideHours
      It is currently outside the operating hours for the given WebsiteID.
      QueueFull
      The number of chats waiting and in progress exceeds the queue size limit.
      Unknown
      Chat is unavailable for an unknown or unrecognized reason.
      Unsecure
      Chat window settings require encrypted chat parameters, but chat was created without these parameters.
      VisitorBlocked
      The visitor has been blocked by an operator.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static UnavailableReason getUnavailableReason(java.lang.String unavailableReason) 
      static UnavailableReason valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static UnavailableReason[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

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

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

      • QueueFull

        public static final UnavailableReason QueueFull
        The number of chats waiting and in progress exceeds the queue size limit.
      • NoOperators

        public static final UnavailableReason NoOperators
        No operators are logged in as available.
      • VisitorBlocked

        public static final UnavailableReason VisitorBlocked
        The visitor has been blocked by an operator.
      • OutsideHours

        public static final UnavailableReason OutsideHours
        It is currently outside the operating hours for the given WebsiteID.
      • Unknown

        public static final UnavailableReason Unknown
        Chat is unavailable for an unknown or unrecognized reason.
      • Unsecure

        public static final UnavailableReason Unsecure
        Chat window settings require encrypted chat parameters, but chat was created without these parameters.
    • Method Detail

      • values

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

        public static UnavailableReason 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
      • getUnavailableReason

        public static UnavailableReason getUnavailableReason(java.lang.String unavailableReason)