CSUserLocationUpdate Class Reference

Inherits from NSObject
Declared in CSUserLocationUpdate.h

Overview

CSUserLocationUpdate is a wrapper around a given trackingIdentifier with the location data. When a new location is received for the tracking identifier a CSUserLocationUpdate is created with the location info and a flag whether the user is approaching the store.

  trackingIdentifier

The tracking identifier for this location update.

@property (nonatomic, readonly) NSString *trackingIdentifier

Discussion

The tracking identifier for this location update.

Declared In

CSUserLocationUpdate.h

  location

Locations are only populated when the user is close to the store ~2mi.

@property (nonatomic, readonly) CLLocation *location

Discussion

The location for the user. The timestamp property of the CLLocation would be the actual timestamp for this user location when it was sent to the server by the consumer client. This is the same value in the lastUpdateTimestamp below.

Declared In

CSUserLocationUpdate.h

  lastUpdateTimestamp

The timestamp when we last got a location update from the user. If a location was given with this UserLocationUpdate that will have the same timestamp.

@property (nonatomic, readonly) NSDate *lastUpdateTimestamp

Discussion

The timestamp when we last got a location update from the user. If a location was given with this UserLocationUpdate that will have the same timestamp.

Declared In

CSUserLocationUpdate.h

  userStatus

Flag indicating whether the user is approaching the store.

@property (nonatomic, readonly) CSUserStatus userStatus

Discussion

Flag indicating whether the user is approaching the store.

Declared In

CSUserLocationUpdate.h

  acknowledgedUser

The AD system sends push notifcation to the logged in ops personnal when there is a user approaching the store or at the store. If the userStatus is either CSUserStatusArrived or CSUserStatusArrived and acknowledgedUser is not set, then no one has acknowledged that there is a user approaching the store or at the store. The AD system will then aggressively send notifications till an ops personel has acknowledged the user. Use [CSUserLocationUpdate opsAcknowledgesUser] to tell AD System that the ops is aware of the user.

@property (nonatomic, readonly) BOOL acknowledgedUser

Discussion

The AD system sends push notifcation to the logged in ops personnal when there is a user approaching the store or at the store. If the userStatus is either CSUserStatusArrived or CSUserStatusArrived and acknowledgedUser is not set, then no one has acknowledged that there is a user approaching the store or at the store. The AD system will then aggressively send notifications till an ops personel has acknowledged the user. Use [CSUserLocationUpdate opsAcknowledgesUser] to tell AD System that the ops is aware of the user.

Declared In

CSUserLocationUpdate.h

  estimatedTimeOfArrival

The current estimated arrival time of the user. Note this may come in as a separate CSUserLocationUpdate event. Unit : seconds Negative value means ETA is unknown.

@property (nonatomic, readonly) int estimatedTimeOfArrival

Discussion

The current estimated arrival time of the user. Note this may come in as a separate CSUserLocationUpdate event. Unit : seconds Negative value means ETA is unknown.

Declared In

CSUserLocationUpdate.h

  distanceFromStore

distanceFromStore indicates the distance from store. When the user is beyond a certain theshold distance, only this value is populated. Unit : meters

@property (nonatomic, readonly) int distanceFromStore

Discussion

distanceFromStore indicates the distance from store. When the user is beyond a certain theshold distance, only this value is populated. Unit : meters

Declared In

CSUserLocationUpdate.h

– opsAcknowledgesUserWithMessage:handler:

If the userStatus is not one of the above status or acknowledgedUser is true, then this method is a no-op.

- (void)opsAcknowledgesUserWithMessage:(NSString *)ackMessage handler:(CSUserAcknowledgeStatus)acknowledgeStatusHandler

Discussion

Calling this method when the userStatus is either CSUserStatusArrived or CSUserStatusArrived, tells the AD system that there is a ops personel who is aware of the user approaching.

Note: If the userStatus is not one of the above status or acknowledgedUser is true, then this method is a no-op.

Declared In

CSUserLocationUpdate.h

  opsAcknowledgedTimestamp

The timestamp when the user status was acked

@property (nonatomic, readonly) NSDate *opsAcknowledgedTimestamp

Discussion

The timestamp when the user status was acked

Declared In

CSUserLocationUpdate.h

  opsTrackingIdentifier

The tracking identifier of the StoreOps personnel who acked user status.

@property (nonatomic, readonly) NSString *opsTrackingIdentifier

Discussion

The tracking identifier of the StoreOps personnel who acked user status.

Declared In

CSUserLocationUpdate.h