Tracker

Instance Constructors

new Tracker(emitters: NonEmptyList[Emitter[F]], namespace: String, appId: String, subject: Subject = Subject(), encodeBase64: Boolean = true, metadata: Option[SelfDescribingJson] = None)(implicit arg0: Monad[F], arg1: ClockProvider[F], arg2: UUIDProvider[F])

emitters
Sequence of emitters to which events are passed
namespace
Tracker namespace
appId
ID of the application
encodeBase64
Whether to encode JSONs
metadata
optionally a json containing the metadata context for the running instance

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val appId: String

ID of the application
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val emitters: NonEmptyList[Emitter[F]]

Sequence of emitters to which events are passed
val encodeBase64: Boolean

Whether to encode JSONs
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metadata: Option[SelfDescribingJson]

optionally a json containing the metadata context for the running instance
val namespace: String

Tracker namespace
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def setSubject(newSubject: Subject): Tracker[F]

Set the Subject for the tracker The subject's configuration will be attached to every event
Set the Subject for the tracker The subject's configuration will be attached to every event
newSubject
user which the Tracker will track
returns
The tracker instance
val subject: Subject
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def trackAddToCart(sku: String, name: Option[String] = None, category: Option[String] = None, unitPrice: Option[Double] = None, quantity: Int, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Track an add-to-cart event
Track an add-to-cart event
sku
Required. Item's SKU code.
name
Optional. Product name.
category
Optional. Product category.
unitPrice
Optional. Product price.
quantity
Required. Quantity added.
currency
Optional. Product price currency.
contexts
Optional. Context relating to the event.
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackError(error: Throwable, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Track application error NOTE: don't try to tracker Emitter failures with it
Track application error NOTE: don't try to tracker Emitter failures with it
error
exception thrown by application code
contexts
Optional. Context relating to the event.
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackPageView(pageUrl: String, pageTitle: Option[String] = None, referrer: Option[String] = None, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Record view of web page
Record view of web page
pageUrl
viewed URL
pageTitle
page's title
referrer
referrer URL
contexts
list of additional contexts
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackRemoveFromCart(sku: String, name: Option[String] = None, category: Option[String] = None, unitPrice: Option[Double] = None, quantity: Double, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Track a remove-from-cart event
Track a remove-from-cart event
sku
Required. Item's SKU code.
name
Optional. Product name.
category
Optional. Product category.
unitPrice
Optional. Product price.
quantity
Required. Quantity removed.
currency
Optional. Product price currency.
contexts
Optional. Context relating to the event.
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackSelfDescribingEvent(unstructEvent: SelfDescribingJson, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Track a Snowplow self-describing event
Track a Snowplow self-describing event
unstructEvent
self-describing JSON for the event
contexts
list of additional contexts
timestamp
optional user-provided timestamp (ms) for the event
returns
The tracker instance
def trackStructEvent(category: String, action: String, label: Option[String] = None, property: Option[String] = None, value: Option[Double] = None, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Track a Snowplow structured event
Track a Snowplow structured event
category
event category mapped to se_ca
action
event itself mapped to se_ac
label
optional object label mapped to se_la
property
optional event/object property mapped to se_pr
value
optional object value mapped to se_va
contexts
list of additional contexts
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackTransaction(orderId: String, affiliation: Option[String] = None, total: Double, tax: Option[Double] = None, shipping: Option[Double] = None, city: Option[String] = None, state: Option[String] = None, country: Option[String] = None, currency: Option[String] = None, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

Record view of transaction
Record view of transaction
orderId
Order ID
affiliation
Transaction affiliation
total
Total transaction value
tax
Total tax included in transaction value
shipping
Delivery cost charged
city
Delivery address, city
state
Delivery address, state
country
Delivery address, country
currency
Currency
contexts
list of additional contexts
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
def trackTransactionItem(orderId: String, sku: String, name: Option[String] = None, category: Option[String] = None, price: Double, quantity: Int, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

orderId
Order ID
sku
Product SKU
name
Product name
category
Product category
price
Product unit price
quantity
Number of product in transaction
currency
The currency the price is expressed in
contexts
Custom context relating to the event
timestamp
optional user-provided timestamp (ms) for the event
returns
the tracker instance
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Tracker | package scalatracker

Instance Constructors

new Tracker(emitters: NonEmptyList[Emitter[F]], namespace: String, appId: String, subject: Subject = Subject(), encodeBase64: Boolean = true, metadata: Option[SelfDescribingJson] = None)(implicit arg0: Monad[F], arg1: ClockProvider[F], arg2: UUIDProvider[F])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val appId: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val emitters: NonEmptyList[Emitter[F]]

val encodeBase64: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val metadata: Option[SelfDescribingJson]

val namespace: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def setSubject(newSubject: Subject): Tracker[F]

val subject: Subject

final def synchronized[T0](arg0: ⇒ T0): T0

def trackAddToCart(sku: String, name: Option[String] = None, category: Option[String] = None, unitPrice: Option[Double] = None, quantity: Int, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackError(error: Throwable, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackPageView(pageUrl: String, pageTitle: Option[String] = None, referrer: Option[String] = None, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackRemoveFromCart(sku: String, name: Option[String] = None, category: Option[String] = None, unitPrice: Option[Double] = None, quantity: Double, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackSelfDescribingEvent(unstructEvent: SelfDescribingJson, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackStructEvent(category: String, action: String, label: Option[String] = None, property: Option[String] = None, value: Option[Double] = None, contexts: Seq[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

def trackTransactionItem(orderId: String, sku: String, name: Option[String] = None, category: Option[String] = None, price: Double, quantity: Int, currency: Option[String] = None, contexts: List[SelfDescribingJson] = Nil, timestamp: Option[Timestamp] = None): F[Unit]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped