Bold360 and BoldChat Developer Center

EndedReason

com.boldchat.visitor.api

Enum EndedReason

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


    public enum EndedReason
    extends java.lang.Enum<EndedReason>
    The types of reasons for a chat to end.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      Disconnected
      The chat was disconnected, and unable to re-establish a connection to the chat servers.
      Operator
      The chat was ended by an operator using the BoldChat client.
      Unknown
      The chat ended for an unknown or unexpected reason
      Visitor
      The chat was ended by a person using this api (by calling Chat.finishChat(ChatFinishedListener) on a still active chat).
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static EndedReason getEndedReason(java.lang.String endedReason) 
      static EndedReason valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EndedReason[] 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

      • Unknown

        public static final EndedReason Unknown
        The chat ended for an unknown or unexpected reason
      • Operator

        public static final EndedReason Operator
        The chat was ended by an operator using the BoldChat client.
      • Visitor

        public static final EndedReason Visitor
        The chat was ended by a person using this api (by calling Chat.finishChat(ChatFinishedListener) on a still active chat).
      • Disconnected

        public static final EndedReason Disconnected
        The chat was disconnected, and unable to re-establish a connection to the chat servers.
    • Method Detail

      • values

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

        public static EndedReason 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
      • getEndedReason

        public static EndedReason getEndedReason(java.lang.String endedReason)