class DefaultNgrokApiClient extends NgrokApiClient
Default implementation of NgrokApiClient based on the Armeria HTTP client.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- DefaultNgrokApiClient
- NgrokApiClient
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toany2stringadd[DefaultNgrokApiClient] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DefaultNgrokApiClient, B)
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toArrowAssoc[DefaultNgrokApiClient] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val SCALA_VERSION: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (DefaultNgrokApiClient) => Boolean, msg: => Any): DefaultNgrokApiClient
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toEnsuring[DefaultNgrokApiClient] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DefaultNgrokApiClient) => Boolean): DefaultNgrokApiClient
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toEnsuring[DefaultNgrokApiClient] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DefaultNgrokApiClient
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toEnsuring[DefaultNgrokApiClient] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DefaultNgrokApiClient
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toEnsuring[DefaultNgrokApiClient] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def sendRequest[O](method: HttpMethod, endpoint: String, queryParams: List[(String, Option[Any])], body: Option[Json])(implicit arg0: Decoder[O], arg1: ClassTag[O], ec: ExecutionContext): Future[O]
Sends a request to the ngrok API.
Sends a request to the ngrok API.
- O
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
- method
the HTTP method to use
- endpoint
the endpoint (under the base URI) to send the request to
- queryParams
any query parameters to send along with the request (parameters with an empty value will not be sent)
- body
JSON request body, if any
- ec
an execution context
- returns
a future encapsulating the response type
- Definition Classes
- DefaultNgrokApiClient → NgrokApiClient
- def sendRequest[O](uri: URI)(implicit arg0: Decoder[O], arg1: ClassTag[O], ec: ExecutionContext): Future[O]
Sends a GET request directly to the specified URI.
Sends a GET request directly to the specified URI.
- O
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
- uri
a URI to send the request to
- ec
an execution context
- returns
a future encapsulating the response type
- Definition Classes
- DefaultNgrokApiClient → NgrokApiClient
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toStringFormat[DefaultNgrokApiClient] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (DefaultNgrokApiClient, B)
- Implicit
- This member is added by an implicit conversion from DefaultNgrokApiClient toArrowAssoc[DefaultNgrokApiClient] 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.