org.nuxeo.segment.io

Interface SegmentIO

All Known Implementing Classes:

SegmentIOComponent

public interface SegmentIO

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SegmentIO.ACTIONS

Method Summary

Modifier and Type	Method and Description
void	flush()
Map<String,List<SegmentIOMapper>>	getAllMappers()
Map<String,String>	getGlobalParameters()
Map<String,Boolean>	getIntegrations()
Set<String>	getMappedEvents()
Map<String,List<SegmentIOMapper>>	getMappers(List<String> events)
SegmentIOUserFilter	getUserFilters()
String	getWriteKey()
void	identify(NuxeoPrincipal principal)
void	identify(NuxeoPrincipal principal, Map<String,Serializable> metadata)
boolean	isDebugMode()
boolean	mustTrackprincipal(String principalName)
void	page(NuxeoPrincipal principal, String name, Map<String,Serializable> metadata)
void	page(NuxeoPrincipal principal, String name, String category, Map<String,Serializable> metadata)
void	screen(NuxeoPrincipal principal, String screen, Map<String,Serializable> metadata)
void	track(NuxeoPrincipal principal, String eventName, Map<String,Serializable> metadata)

Method Detail

getWriteKey

String getWriteKey()

getGlobalParameters

Map<String,String> getGlobalParameters()

identify

void identify(NuxeoPrincipal principal)

Since:

10.2

identify

void identify(NuxeoPrincipal principal,
              Map<String,Serializable> metadata)

Since:

10.2

track

void track(NuxeoPrincipal principal,
           String eventName,
           Map<String,Serializable> metadata)

Since:

10.2

screen

void screen(NuxeoPrincipal principal,
            String screen,
            Map<String,Serializable> metadata)

Since:

10.2

page

void page(NuxeoPrincipal principal,
          String name,
          Map<String,Serializable> metadata)

Since:

10.2

page

void page(NuxeoPrincipal principal,
          String name,
          String category,
          Map<String,Serializable> metadata)

Since:

10.2

flush

void flush()

mustTrackprincipal

boolean mustTrackprincipal(String principalName)

Since:

10.2

getIntegrations

Map<String,Boolean> getIntegrations()

getUserFilters

SegmentIOUserFilter getUserFilters()

getMappedEvents

Set<String> getMappedEvents()

getMappers

Map<String,List<SegmentIOMapper>> getMappers(List<String> events)

getAllMappers

Map<String,List<SegmentIOMapper>> getAllMappers()

isDebugMode

boolean isDebugMode()

Returns:

true if the service is in debug mode

Since:

9.10