Enum FileTransfers

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


    public enum FileTransfers
    extends java.lang.Enum<FileTransfers>
    Definition of a set of files being transferred.

    Files are added here when ChatApiCommands.send(File) is called or on agent attachment request. Used by LivechatChatLogPath to inject File in the relevant chat log containing the file name. This enables observers of ChatLogObserver to receive actual file rather then just file name from chat log event.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      INSTANCE 
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.io.File findFile(java.lang.String uniqueName)
      Finds file based on file name provided.
      static FileTransfers valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FileTransfers[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • values

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

        public static FileTransfers 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
      • findFile

        public java.io.File findFile(java.lang.String uniqueName)
        Finds file based on file name provided.
        Parameters:
        uniqueName - that identifies the file as one returned by FileTransfers.add(File)
        Returns:
        file from the transfer set, or null no matching file was found or an error occurred