Skip to content

User Events

Info

This document is a work in progress.

Currently, User events contain below events, still working in progress:

  • User Events
    • Set Home Event - Should be sent by HMI when user sets/removes home address
    • Set Work Event - Should be sent by HMI when user sets/removes work address

Set Home Event

Set home event should be sent by HMI when user sets/removes home address.

TNSetHomeEventBuilder Methods Details
entityId(_ entityId: String) The EntityId address/POI, mandatory data field.
lat(_ lat: CLLocationDegrees) Set to raw latitude, mandatory data field.
lon(_ lon: CLLocationDegrees) Set to raw longitude, mandatory data field.
action(_ action: TNUserEventActionType) ActionType as SET/REMOVE when user set/remove home address, mandatory data field.
label(_ label: String) For the name alias for this home, optional data field.
enum TNUserEventActionType Details
set when user sets home address
remove when user removes home address

Use Data Collector method send(event: TNEvent), which will collects and sends the created event asynchronously:

1
2
3
4
5
6
let eventBuilder = TNSetHomeEvent.builder()
eventBuilder.action(.remove).entityId("EntityId")
    .lat(31.201840).lon(121.541237).label("Label")
if let event = eventBuilder.build() {
    dataCollectorClient.send(event: event)
}

1
2
3
4
5
6
7
8
TNSetHomeEventBuilder * eventBuilder = [TNSetHomeEvent builder];
[[eventBuilder entityId: @"EntityId"] label: @"Label"];
[[eventBuilder lat: 31.2414] lon: 121.4324];
[eventBuilder action: TNUserEventActionTypeSet];
TNSetHomeEvent * event = [eventBuilder build];
if (event != NULL) {
    [dataCollectorClient sendWithEvent:event];
}

Set Work Event

Set work event should be sent by HMI when user sets/removes work address

TNSetWorkEventBuilder methods Details
entityId(_ entityId: String) The EntityId address/POI, mandatory data field.
lat(_ lat: CLLocationDegrees) Set to raw latitude, mandatory data field.
lon(_ lon: CLLocationDegrees) Set to raw longitude, mandatory data field.
action(_ action: TNUserEventActionType) ActionType as SET/REMOVE when user set/remove work address, mandatory data field.
label(_ label: String) For the name alias for this work, optional data field.
enum TNUserEventActionType Details
set when user sets work address
remove when user removes work address

Use Data Collector method send(event: TNEvent), which will collects and sends the created event asynchronously:

1
2
3
4
5
6
let eventBuilder = TNSetWorkEvent.builder()
eventBuilder.action(.remove).entityId("EntityId")
    .lat(31.201840).lon(121.541237).label("Label")
if let event = eventBuilder.build() {
    dataCollectorClient.send(event: event)
}

1
2
3
4
5
6
7
8
TNSetWorkEventBuilder * eventBuilder = [TNSetWorkEvent builder];
[[eventBuilder entityId: @"EntityId"] label: @"Label"];
[[eventBuilder lat: 31.2414] lon: 121.4324];
[eventBuilder action: TNUserEventActionTypeSet];
TNSetWorkEvent * event = [eventBuilder build];
if (event != NULL) {
    [dataCollectorClient sendWithEvent:event];
}