Search
Preparing search index...
The search index is not available
@storefront/core
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
TrackerService
Class TrackerService
Hierarchy
BaseService
<
Options
>
TrackerService
Implements
Service
Index
Interfaces
Options
Constructors
constructor
Properties
app
client
opts
transform
Methods
add
Metadata
apply
Opts
Override
build
Event
get
Metadata
get
Search
Origin
init
send
Add
ToCart
Event
send
Event
send
More
Refinements
Event
send
Order
Event
send
Remove
From
Cart
Event
send
Search
Event
send
View
Cart
Event
send
View
Product
Event
set
Listeners
Constructors
constructor
new
Tracker
Service
(
app
:
StoreFront
, opts
:
Options
)
:
TrackerService
Parameters
app:
StoreFront
opts:
Options
Returns
TrackerService
Properties
Protected
app
app
:
StoreFront
client
client
:
GbTracker
= new GbTracker(this.app.config.customerId, this.app.config.area)
Protected
opts
opts
:
Options
transform
transform
:
function
= ProductTransformer.transformer(this.app.config.structure)
Type declaration
(
product
:
any
)
:
any
Parameters
product:
any
Returns
any
Methods
add
Metadata
add
Metadata
(
event
:
any
)
:
any
Parameters
event:
any
Returns
any
apply
Opts
Override
apply
Opts
Override<S, T>
(
defaultFn
:
function
, override
:
Override
<
S
,
T
>
)
:
(Anonymous function)
Type parameters
S
T
Parameters
defaultFn:
function
(
value
:
any
, override
?:
Override
<
S
,
T
>
)
:
void
Parameters
value:
any
Optional
override:
Override
<
S
,
T
>
Returns
void
override:
Override
<
S
,
T
>
Returns
(Anonymous function)
build
Event
build
Event<S, T>
(
override
:
Override
<
S
,
T
>
, event
:
T
, value
?:
S
|
T
)
:
T
Type parameters
S
T
Parameters
override:
Override
<
S
,
T
>
event:
T
Default value
value:
S
|
T
= event
Returns
T
get
Metadata
get
Metadata
(
origin
?:
Tag
)
:
object
[]
Parameters
Default value
origin:
Tag
= this.getSearchOrigin()
Returns
object
[]
get
Search
Origin
get
Search
Origin
(
)
:
Tag
Returns
Tag
init
init
(
)
:
void
Returns
void
send
Add
ToCart
Event
send
Add
ToCart
Event
(
event
:
GbTracker.CartEvent
, override
?:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
)
:
void
Parameters
event:
GbTracker.CartEvent
Default value
override:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
= (value, val) => val
Returns
void
send
Event
send
Event
(
method
:
string
, event
:
any
)
:
void
Parameters
method:
string
event:
any
Returns
void
send
More
Refinements
Event
send
More
Refinements
Event
(
id
:
string
, override
?:
Override
<
string
,
GbTracker.MoreRefinementsEvent
>
)
:
void
Parameters
id:
string
Default value
override:
Override
<
string
,
GbTracker.MoreRefinementsEvent
>
= (value, val) => val
Returns
void
send
Order
Event
send
Order
Event
(
event
:
GbTracker.OrderEvent
, override
?:
Override
<
GbTracker.OrderEvent
,
GbTracker.OrderEvent
>
)
:
void
Parameters
event:
GbTracker.OrderEvent
Default value
override:
Override
<
GbTracker.OrderEvent
,
GbTracker.OrderEvent
>
= (value, val) => val
Returns
void
send
Remove
From
Cart
Event
send
Remove
From
Cart
Event
(
event
:
GbTracker.CartEvent
, override
?:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
)
:
void
Parameters
event:
GbTracker.CartEvent
Default value
override:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
= (value, val) => val
Returns
void
send
Search
Event
send
Search
Event
(
id
:
string
, override
?:
Override
<
string
,
GbTracker.SearchEvent
>
)
:
void
Parameters
id:
string
Default value
override:
Override
<
string
,
GbTracker.SearchEvent
>
= (value, val) => val
Returns
void
send
View
Cart
Event
send
View
Cart
Event
(
event
:
GbTracker.CartEvent
, override
?:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
)
:
void
Parameters
event:
GbTracker.CartEvent
Default value
override:
Override
<
GbTracker.CartEvent
,
GbTracker.CartEvent
>
= (value, val) => val
Returns
void
send
View
Product
Event
send
View
Product
Event
(
record
:
any
, override
?:
Override
<
GbTracker.ViewProductEvent
,
GbTracker.ViewProductEvent
>
)
:
void
Parameters
record:
any
Default value
override:
Override
<
GbTracker.ViewProductEvent
,
GbTracker.ViewProductEvent
>
= (value, val) => val
Returns
void
set
Listeners
set
Listeners
(
app
:
StoreFront
)
:
void
Parameters
app:
StoreFront
Returns
void
Globals
Tracker
Service
Options
constructor
app
client
opts
transform
add
Metadata
apply
Opts
Override
build
Event
get
Metadata
get
Search
Origin
init
send
Add
ToCart
Event
send
Event
send
More
Refinements
Event
send
Order
Event
send
Remove
From
Cart
Event
send
Search
Event
send
View
Cart
Event
send
View
Product
Event
set
Listeners
Generated using
TypeDoc