class ReservedDomains extends AnyRef

Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

See also https://ngrok.com/docs/api#api-reserved-domains.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReservedDomains
  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 ReservedDomains toany2stringadd[ReservedDomains] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReservedDomains, B)
    Implicit
    This member is added by an implicit conversion from ReservedDomains toArrowAssoc[ReservedDomains] 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 create(name: String, region: Option[String] = None, description: Option[String] = None, metadata: Option[String] = None, certificateId: Option[String] = None, certificateManagementPolicy: Option[ReservedDomainCertPolicy] = None): Future[ReservedDomain]

    Create a new reserved domain.

    Create a new reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-create.

    name

    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.

    region

    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    description

    human-readable description of what this reserved domain will be used for

    metadata

    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

    certificateId

    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

    certificateManagementPolicy

    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

    returns

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

  9. def delete(id: String): Future[Unit]

    Delete a reserved domain.

    Delete a reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-delete.

    id

    a resource identifier

    returns

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

  10. def deleteCertificate(id: String): Future[Unit]

    Detach the certificate attached to a reserved domain.

    Detach the certificate attached to a reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate.

    id

    a resource identifier

    returns

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

  11. def deleteCertificateManagementPolicy(id: String): Future[Unit]

    Detach the certificate management policy attached to a reserved domain.

    Detach the certificate management policy attached to a reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy.

    id

    a resource identifier

    returns

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

  12. def ensuring(cond: (ReservedDomains) => Boolean, msg: => Any): ReservedDomains
    Implicit
    This member is added by an implicit conversion from ReservedDomains toEnsuring[ReservedDomains] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (ReservedDomains) => Boolean): ReservedDomains
    Implicit
    This member is added by an implicit conversion from ReservedDomains toEnsuring[ReservedDomains] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): ReservedDomains
    Implicit
    This member is added by an implicit conversion from ReservedDomains toEnsuring[ReservedDomains] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): ReservedDomains
    Implicit
    This member is added by an implicit conversion from ReservedDomains toEnsuring[ReservedDomains] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. def get(id: String): Future[ReservedDomain]

    Get the details of a reserved domain.

    Get the details of a reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-get.

    id

    a resource identifier

    returns

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

  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[ReservedDomainList]]

    List all reserved domains on this account.

    List all reserved domains on this account.

    See also https://ngrok.com/docs/api#api-reserved-domains-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

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def update(id: String, description: Option[String] = None, metadata: Option[String] = None, certificateId: Option[String] = None, certificateManagementPolicy: Option[ReservedDomainCertPolicy] = None): Future[ReservedDomain]

    Update the attributes of a reserved domain.

    Update the attributes of a reserved domain.

    See also https://ngrok.com/docs/api#api-reserved-domains-update.

    id

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

    description

    human-readable description of what this reserved domain will be used for

    metadata

    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

    certificateId

    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

    certificateManagementPolicy

    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

    returns

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

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

Inherited by implicit conversion StringFormat fromReservedDomains to StringFormat[ReservedDomains]

Inherited by implicit conversion Ensuring fromReservedDomains to Ensuring[ReservedDomains]

Inherited by implicit conversion ArrowAssoc fromReservedDomains to ArrowAssoc[ReservedDomains]

Ungrouped