Enum DeliveryStatus

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


    public enum DeliveryStatus
    extends java.lang.Enum<DeliveryStatus>
    An enumeration that specifies the status of the operation.

    Used to define whether a message, file or any other request sent to the server: - is being delivered - has been delivered - has failed and why

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static boolean hasFailed(DeliveryStatus deliveryStatus)
      Returns true if the request has failed, false otherwise.
      static DeliveryStatus valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DeliveryStatus[] 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

      • PENDING

        public static final DeliveryStatus PENDING
        Request is either enqueued for delivery or already in-flight but has not yet been received by the server.
      • DELIVERED

        public static final DeliveryStatus DELIVERED
        Request has been successfully received, accepted and processed by the server.
      • FAILED_FILE_SENDING_DISABLED

        public static final DeliveryStatus FAILED_FILE_SENDING_DISABLED
        Request to upload a file has failed due to disabled file sending in the dashboard.
      • FAILED_FILE_SIZE_TOO_LARGE

        public static final DeliveryStatus FAILED_FILE_SIZE_TOO_LARGE
        Request to upload a file has failed due to exceeded file size limit.
      • FAILED_UNSUPPORTED_FILE_TYPE

        public static final DeliveryStatus FAILED_UNSUPPORTED_FILE_TYPE
        Request to upload a file has failed due to unsupported file time.
      • FAILED_INTERNAL_SERVER_ERROR

        public static final DeliveryStatus FAILED_INTERNAL_SERVER_ERROR
        Server failed to process the request for an unknown reason.
      • FAILED_RESPONSE_TIMEOUT

        public static final DeliveryStatus FAILED_RESPONSE_TIMEOUT
        Response for a request has not arrived in the expected time frame.
      • FAILED_UNKNOWN_REASON

        public static final DeliveryStatus FAILED_UNKNOWN_REASON
        Request has failed for an unknown reason.
      • CANCELLED

        public static final DeliveryStatus CANCELLED
        Request has been cancelled.
    • Method Detail

      • values

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

        public static DeliveryStatus 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
      • hasFailed

        public static boolean hasFailed(DeliveryStatus deliveryStatus)
        Returns true if the request has failed, false otherwise.