class EventSubscriptions extends AnyRef
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions.
- Alphabetic
- By Inheritance
- EventSubscriptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- 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 EventSubscriptions toany2stringadd[EventSubscriptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EventSubscriptions, B)
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toArrowAssoc[EventSubscriptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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 create(metadata: Option[String] = None, description: Option[String] = None, sources: List[EventSourceReplace] = List.empty, destinationIds: List[String] = List.empty): Future[EventSubscription]
Create an Event Subscription.
Create an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-create.
- metadata
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
- description
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
- sources
Sources containing the types for which this event subscription will trigger
- destinationIds
A list of Event Destination IDs which should be used for this Event Subscription.
- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(id: String): Future[Unit]
Delete an Event Subscription.
Delete an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-delete.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (EventSubscriptions) => Boolean, msg: => Any): EventSubscriptions
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toEnsuring[EventSubscriptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EventSubscriptions) => Boolean): EventSubscriptions
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toEnsuring[EventSubscriptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EventSubscriptions
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toEnsuring[EventSubscriptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EventSubscriptions
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toEnsuring[EventSubscriptions] 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])
- def get(id: String): Future[EventSubscription]
Get an Event Subscription by ID.
Get an Event Subscription by ID.
See also https://ngrok.com/docs/api#api-event-subscriptions-get.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- 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
- def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[EventSubscriptionList]]
List this Account's Event Subscriptions.
List this Account's Event Subscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions-list.
- beforeId
the value of the
before_idparameter as a scala.Predef.String- limit
the value of the
limitparameter as a scala.Predef.String- returns
a scala.concurrent.Future encapsulating the API call's result
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(id: String, metadata: Option[String] = None, description: Option[String] = None, sources: List[EventSourceReplace] = List.empty, destinationIds: List[String] = List.empty): Future[EventSubscription]
Update an Event Subscription.
Update an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-update.
- id
Unique identifier for this Event Subscription.
- metadata
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
- description
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
- sources
Sources containing the types for which this event subscription will trigger
- destinationIds
A list of Event Destination IDs which should be used for this Event Subscription.
- returns
a scala.concurrent.Future encapsulating the API call's result
- 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 EventSubscriptions toStringFormat[EventSubscriptions] 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): (EventSubscriptions, B)
- Implicit
- This member is added by an implicit conversion from EventSubscriptions toArrowAssoc[EventSubscriptions] 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.