Packages

case class NgrokApiError(message: String, httpStatusCode: Int, errorCode: Option[String], details: Map[String, String], cause: Option[Throwable]) extends Exception with Product with Serializable

Representation of an API error from ngrok.

message

descriptive error message.

httpStatusCode

HTTP status returned from the server

errorCode

ngrok-specific error code, if any

details

key-value map of error details

cause

exception cause, if any

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NgrokApiError
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NgrokApiError(message: String, httpStatusCode: Int, errorCode: Option[String], details: Map[String, String], cause: Option[Throwable])

    creates a new ngrok API error.

    creates a new ngrok API error.

    message

    descriptive error message.

    httpStatusCode

    HTTP status returned from the server

    errorCode

    ngrok-specific error code, if any

    details

    key-value map of error details

    cause

    exception cause, if any

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NgrokApiError toany2stringadd[NgrokApiError] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NgrokApiError, B)
    Implicit
    This member is added by an implicit conversion from NgrokApiError toArrowAssoc[NgrokApiError] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val cause: Option[Throwable]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val details: Map[String, String]
  11. def ensuring(cond: (NgrokApiError) => Boolean, msg: => Any): NgrokApiError
    Implicit
    This member is added by an implicit conversion from NgrokApiError toEnsuring[NgrokApiError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (NgrokApiError) => Boolean): NgrokApiError
    Implicit
    This member is added by an implicit conversion from NgrokApiError toEnsuring[NgrokApiError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): NgrokApiError
    Implicit
    This member is added by an implicit conversion from NgrokApiError toEnsuring[NgrokApiError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): NgrokApiError
    Implicit
    This member is added by an implicit conversion from NgrokApiError toEnsuring[NgrokApiError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val errorCode: Option[String]
  17. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. def getCause(): Throwable
    Definition Classes
    Throwable
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  22. def getMessage(): String
    Definition Classes
    Throwable
  23. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  24. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  25. val httpStatusCode: Int
  26. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  27. def isErrorCode(codes: String*): Boolean

    Checks if this error object contains one of the provided codes.

    Checks if this error object contains one of the provided codes.

    codes

    error codes to check

    returns

    whether or not one of the codes matches what is in this error object

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val message: String
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  34. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  35. def printStackTrace(): Unit
    Definition Classes
    Throwable
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NgrokApiError toStringFormat[NgrokApiError] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (NgrokApiError, B)
    Implicit
    This member is added by an implicit conversion from NgrokApiError toArrowAssoc[NgrokApiError] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNgrokApiError to any2stringadd[NgrokApiError]

Inherited by implicit conversion StringFormat fromNgrokApiError to StringFormat[NgrokApiError]

Inherited by implicit conversion Ensuring fromNgrokApiError to Ensuring[NgrokApiError]

Inherited by implicit conversion ArrowAssoc fromNgrokApiError to ArrowAssoc[NgrokApiError]

Ungrouped