class TunnelSessions extends AnyRef

Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.

See also https://ngrok.com/docs/api#api-tunnel-sessions.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TunnelSessions
  2. AnyRef
  3. 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

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 TunnelSessions toany2stringadd[TunnelSessions] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TunnelSessions, B)
    Implicit
    This member is added by an implicit conversion from TunnelSessions toArrowAssoc[TunnelSessions] 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (TunnelSessions) => Boolean, msg: => Any): TunnelSessions
    Implicit
    This member is added by an implicit conversion from TunnelSessions toEnsuring[TunnelSessions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TunnelSessions) => Boolean): TunnelSessions
    Implicit
    This member is added by an implicit conversion from TunnelSessions toEnsuring[TunnelSessions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TunnelSessions
    Implicit
    This member is added by an implicit conversion from TunnelSessions toEnsuring[TunnelSessions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TunnelSessions
    Implicit
    This member is added by an implicit conversion from TunnelSessions toEnsuring[TunnelSessions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def get(id: String): Future[TunnelSession]

    Get the detailed status of a tunnel session by ID

    Get the detailed status of a tunnel session by ID

    See also https://ngrok.com/docs/api#api-tunnel-sessions-get.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[TunnelSessionList]]

    List all online tunnel sessions running on this account.

    List all online tunnel sessions running on this account.

    See also https://ngrok.com/docs/api#api-tunnel-sessions-list.

    beforeId

    the value of the before_id parameter as a scala.Predef.String

    limit

    the value of the limit parameter as a scala.Predef.String

    returns

    a scala.concurrent.Future encapsulating the API call's result

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def restart(id: String): Future[Unit]

    Issues a command instructing the ngrok agent to restart.

    Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.

    See also https://ngrok.com/docs/api#api-tunnel-sessions-restart.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  24. def stop(id: String): Future[Unit]

    Issues a command instructing the ngrok agent that started this tunnel session to exit.

    Issues a command instructing the ngrok agent that started this tunnel session to exit.

    See also https://ngrok.com/docs/api#api-tunnel-sessions-stop.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def update(id: String): Future[Unit]

    Issues a command instructing the ngrok agent to update itself to the latest version.

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

    See also https://ngrok.com/docs/api#api-tunnel-sessions-update.

    id

    the value of the id parameter as a scala.Predef.String

    returns

    a scala.concurrent.Future encapsulating the API call's result

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. 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 TunnelSessions toStringFormat[TunnelSessions] 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): (TunnelSessions, B)
    Implicit
    This member is added by an implicit conversion from TunnelSessions toArrowAssoc[TunnelSessions] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTunnelSessions to any2stringadd[TunnelSessions]

Inherited by implicit conversion StringFormat fromTunnelSessions to StringFormat[TunnelSessions]

Inherited by implicit conversion Ensuring fromTunnelSessions to Ensuring[TunnelSessions]

Inherited by implicit conversion ArrowAssoc fromTunnelSessions to ArrowAssoc[TunnelSessions]

Ungrouped