CSStoreArrivalTracker Class Reference

Inherits from NSObject
Declared in CSStoreArrivalTracker.h

Overview

The CSStoreArrivalTracker object is for integrating to the StoreOps applications to receive location updates and arrival notifications of users approaching the configured store (arrivalStoreRegion). As location update comes in, the CSStoreArrivalTracker instance will process the locations with the configured store and then call back on the CSUserLocationUpdatesAvailableHandler handler with location updates.

Push notifications should be enabled for the application. Make sure that you register for the following push notifications in the AppDelegate : UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeNewsstandContentAvailability

Note: This requires the CSStoreOpsSession to be in CSSessionStateValid state.

  arrivalStoreRegion

The store which the this instance is currently tracking. To change use the storeRegion

@property (nonatomic, readonly) CSStoreRegion *arrivalStoreRegion

Discussion

The store which the this instance is currently tracking. To change use the storeRegion

Declared In

CSStoreArrivalTracker.h

  locationUpdateHandler

The update handler where the user location updates are sent to the consuming application.

@property (nonatomic, copy) CSUserLocationUpdatesAvailableHandler locationUpdateHandler

Discussion

The update handler where the user location updates are sent to the consuming application.

Declared In

CSStoreArrivalTracker.h

+ sharedArrivalTracker

Clients should not be initializing multiple instances of the CSStoreArrivalTracker. There should be only one CSStoreArrivalTracker in the application, and this method should be used to get that instance where-ever required.

+ (instancetype)sharedArrivalTracker

Discussion

Clients should not be initializing multiple instances of the CSStoreArrivalTracker. There should be only one CSStoreArrivalTracker in the application, and this method should be used to get that instance where-ever required.

Declared In

CSStoreArrivalTracker.h

– startTrackingArrivalsForStore:error:

This subscribes to user arrival and location updates to the store defined by arrivalStoreRegion.

- (BOOL)startTrackingArrivalsForStore:(CSStoreRegion *)arrivalStoreRegion error:(NSError **)error

Parameters

error

The NSError indicates the failurer reason

Discussion

This subscribes to user arrival and location updates to the store defined by arrivalStoreRegion.

Declared In

CSStoreArrivalTracker.h

– stopTrackingArrivals

This unsubscribes to user arrival and location updates.

- (BOOL)stopTrackingArrivals

Discussion

This unsubscribes to user arrival and location updates.

Declared In

CSStoreArrivalTracker.h