Engine  14.3.0
Factual's Engine SDK
Instance Methods | Properties | List of all members
UserJourneyEvent Class Reference

#import <EngineApiObjects.h>

Inheritance diagram for UserJourneyEvent:

Instance Methods

(nonnull instancetype) - initWithTimestamp:factualVisitUpdate:appStateUpdate:activityUpdate:placeAttachmentUpdate:
 
(nullable instancetype) - initFromDict:
 
(nonnull NSDictionary *) - toDict
 

Properties

NSDate * timestamp
 
FactualVisitUpdatevisitUpdate
 
AppStateUpdateappStateUpdate
 
FactualActivityUpdateactivityUpdate
 
FactualPlaceAttachmentUpdateplaceAttachmentUpdate
 

Detailed Description

Reports user journey events that specify changes to place-attachment, activity, visits, and app-state.

Method Documentation

◆ initFromDict:()

- (nullable instancetype) initFromDict: (nonnull NSDictionary *)  dictUpdate

Constructs a UserJourneyEvent from a NSDictionary representing the UserJourneyEvent.

Parameters
dictUpdateA NSDictionary representing the UserJourneyEvent.
Returns
A UserJourneyEvent.

◆ initWithTimestamp:factualVisitUpdate:appStateUpdate:activityUpdate:placeAttachmentUpdate:()

- (nonnull instancetype) initWithTimestamp: (nonnull NSDate *)  timestamp
factualVisitUpdate: (nullable FactualVisitUpdate *)  visitUpdate
appStateUpdate: (nullable AppStateUpdate *)  appStateUpdate
activityUpdate: (nullable FactualActivityUpdate *)  activityUpdate
placeAttachmentUpdate: (nullable FactualPlaceAttachmentUpdate *)  placeAttachmentUpdate 

Constructs a UserJourneyEvent.

Parameters
timestampThe time the user journey event occurred.
visitUpdateThe FactualVisitUpdate, nil if no change.
appStateUpdateThe AppStateUpdate, nil if no change.
activityUpdateThe FactualActivityUpdate, nil if no change.
placeAttachmentUpdateThe FactualPlaceAttachmentUpdate, nil if no change.
Returns
A UserJourneyEvent.

◆ toDict()

- (nonnull NSDictionary *) toDict

Returns the UserJourneyEvent as a NSDictionary.

Returns
The UserJourneyEvent as a NSDictionary.

Property Documentation

◆ activityUpdate

- (FactualActivityUpdate*) activityUpdate
readatomicassign

The FactualActivityUpdate, nil if no change.

◆ appStateUpdate

- (AppStateUpdate*) appStateUpdate
readatomicassign

The AppStateUpdate, nil if no change.

◆ placeAttachmentUpdate

- (FactualPlaceAttachmentUpdate*) placeAttachmentUpdate
readatomicassign

◆ timestamp

- (NSDate*) timestamp
readatomicassign

The time the user journey event occurred.

◆ visitUpdate

- (FactualVisitUpdate*) visitUpdate
readatomicassign

The FactualVisitUpdate, nil if no


The documentation for this class was generated from the following file: