Migrating to AEPPlaces reference

This document is a reference comparison of AEPPlaces (3.x) APIs against against their equivalent ACPPlaces (2.x) APIs.

The AEPPlaces extension is implemented purely in Swift and is compatible with the AEPCore swift SDK. To ensure a smooth transition from the ACPPlaces SDK, there are no major changes on the API names or definition. For more details, follow the migration guide below for your Swift or Objective-C mobile application. If explanation beyond showing API differences is necessary, it will be captured as an info hint within that API's section.

Public classes

Type	AEP 3.x (Swift)	AEP 3.x (Objective-C)	ACP 2.x (Objective-C)
Primary Class	Places	AEPMobilePlaces	ACPPlaces
Enum	PlacesQueryResponseCode	AEPPlacesQueryResponseCode	ACPPlacesRequestError
Class	PointOfInterest	AEPPlacesPoi	ACPPlacesPoi
Enum	PlacesRegionEvent	AEPPlacesRegionEvent	ACPRegionEventType

Public APIs (alphabetical)

clear

AEP 3.x (Swift)

static func clear()
Copied to your clipboard
static func clear()

AEP 3.x (Objective-C)

+ (void) clear;
Copied to your clipboard
+ (void) clear;

ACP 2.x (Objective-C)

+ (void) clear;
Copied to your clipboard
+ (void) clear;

static func clear()
Copied to your clipboard
static func clear()

+ (void) clear;
Copied to your clipboard
+ (void) clear;

+ (void) clear;
Copied to your clipboard
+ (void) clear;

extensionVersion

AEP 3.x (Swift)

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

AEP 3.x (Objective-C)

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

ACP 2.x (Objective-C)

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

getCurrentPointsOfInterest

AEP 3.x (Swift)

static func getCurrentPointsOfInterest(_ closure: @escaping ([PointOfInterest]) -> Void)
Copied to your clipboard
static func getCurrentPointsOfInterest(_ closure: @escaping ([PointOfInterest]) -> Void)

AEP 3.x (Objective-C)

+ (void) getCurrentPointsOfInterest: ^(NSArray<AEPPlacesPoi*>* _Nonnull pois) closure;
Copied to your clipboard
+ (void) getCurrentPointsOfInterest: ^(NSArray<AEPPlacesPoi*>* _Nonnull pois) closure;

ACP 2.x (Objective-C)

+ (void) getCurrentPointsOfInterest: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable userWithinPoi)) callback;
Copied to your clipboard
+ (void) getCurrentPointsOfInterest: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable userWithinPoi)) callback;

static func getCurrentPointsOfInterest(_ closure: @escaping ([PointOfInterest]) -> Void)
Copied to your clipboard
static func getCurrentPointsOfInterest(_ closure: @escaping ([PointOfInterest]) -> Void)

+ (void) getCurrentPointsOfInterest: ^(NSArray<AEPPlacesPoi*>* _Nonnull pois) closure;
Copied to your clipboard
+ (void) getCurrentPointsOfInterest: ^(NSArray<AEPPlacesPoi*>* _Nonnull pois) closure;

+ (void) getCurrentPointsOfInterest: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable userWithinPoi)) callback;
Copied to your clipboard
+ (void) getCurrentPointsOfInterest: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable userWithinPoi)) callback;

getLastKnownLocation

AEP 3.x (Swift)

static func getLastKnownLocation(_ closure: @escaping (CLLocation?) -> Void)
Copied to your clipboard
static func getLastKnownLocation(_ closure: @escaping (CLLocation?) -> Void)

AEP 3.x (Objective-C)

+ (void) getLastKnownLocation: ^(CLLocation* _Nullable lastLocation) closure;
Copied to your clipboard
+ (void) getLastKnownLocation: ^(CLLocation* _Nullable lastLocation) closure;

ACP 2.x (Objective-C)

If the SDK has no last known location, it will pass a CLLocation object with a value of 999.999 for latitude and longitude to the callback.

+ (void) getLastKnownLocation: (nullable void (^) (CLLocation* _Nullable lastLocation)) callback;
Copied to your clipboard
+ (void) getLastKnownLocation: (nullable void (^) (CLLocation* _Nullable lastLocation)) callback;

static func getLastKnownLocation(_ closure: @escaping (CLLocation?) -> Void)
Copied to your clipboard
static func getLastKnownLocation(_ closure: @escaping (CLLocation?) -> Void)

+ (void) getLastKnownLocation: ^(CLLocation* _Nullable lastLocation) closure;
Copied to your clipboard
+ (void) getLastKnownLocation: ^(CLLocation* _Nullable lastLocation) closure;

If the SDK has no last known location, it will pass a CLLocation object with a value of 999.999 for latitude and longitude to the callback.

+ (void) getLastKnownLocation: (nullable void (^) (CLLocation* _Nullable lastLocation)) callback;
Copied to your clipboard
+ (void) getLastKnownLocation: (nullable void (^) (CLLocation* _Nullable lastLocation)) callback;

getNearbyPointsOfInterest

AEP 3.x (Swift)

Rather than providing an overloaded method, a single method supports retrieval of nearby Points of Interest. The provided closure accepts two parameters, representing the resulting nearby points of interest (if any) and the response code.

static func getNearbyPointsOfInterest(forLocation location: CLLocation,
                                      withLimit limit: UInt,
                                      closure: @escaping ([PointOfInterest], PlacesQueryResponseCode) -> Void)
Copied to your clipboard
static func getNearbyPointsOfInterest(forLocation location: CLLocation,
                                      withLimit limit: UInt,
                                      closure: @escaping ([PointOfInterest], PlacesQueryResponseCode) -> Void)

AEP 3.x (Objective-C)

+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: ^ (NSArray<AEPPlacesPoi*>* _Nonnull, AEPPlacesQueryResponseCode) closure;
Copied to your clipboard
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: ^ (NSArray<AEPPlacesPoi*>* _Nonnull, AEPPlacesQueryResponseCode) closure;

ACP 2.x (Objective-C)

Two getNearbyPointsOfInterest methods exist. The overloaded version allows the caller to provide an errorCallback parameter in the case of failure.

// without error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback;

// with error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback
                     errorCallback: (nullable void (^) (ACPPlacesRequestError result)) errorCallback;
Copied to your clipboard
// without error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback;

// with error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback
                     errorCallback: (nullable void (^) (ACPPlacesRequestError result)) errorCallback;

static func getNearbyPointsOfInterest(forLocation location: CLLocation,
                                      withLimit limit: UInt,
                                      closure: @escaping ([PointOfInterest], PlacesQueryResponseCode) -> Void)
Copied to your clipboard
static func getNearbyPointsOfInterest(forLocation location: CLLocation,
                                      withLimit limit: UInt,
                                      closure: @escaping ([PointOfInterest], PlacesQueryResponseCode) -> Void)

+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: ^ (NSArray<AEPPlacesPoi*>* _Nonnull, AEPPlacesQueryResponseCode) closure;
Copied to your clipboard
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: ^ (NSArray<AEPPlacesPoi*>* _Nonnull, AEPPlacesQueryResponseCode) closure;

Two getNearbyPointsOfInterest methods exist. The overloaded version allows the caller to provide an errorCallback parameter in the case of failure.

// without error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback;

// with error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback
                     errorCallback: (nullable void (^) (ACPPlacesRequestError result)) errorCallback;
Copied to your clipboard
// without error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback;

// with error handling
+ (void) getNearbyPointsOfInterest: (nonnull CLLocation*) currentLocation
                             limit: (NSUInteger) limit
                          callback: (nullable void (^) (NSArray<ACPPlacesPoi*>* _Nullable nearbyPoi)) callback
                     errorCallback: (nullable void (^) (ACPPlacesRequestError result)) errorCallback;

processRegionEvent

AEP 3.x (Swift)

The order of parameters has the PlacesRegionEvent first, and the CLRegion that triggered the event second. This aligns better with Swift API naming conventions.

static func processRegionEvent(_ regionEvent: PlacesRegionEvent,
                               forRegion region: CLRegion)
Copied to your clipboard
static func processRegionEvent(_ regionEvent: PlacesRegionEvent,
                               forRegion region: CLRegion)

AEP 3.x (Objective-C)

+ (void) processRegionEvent: (AEPRegionEventType) eventType
                  forRegion: (nonnull CLRegion*) region;
Copied to your clipboard
+ (void) processRegionEvent: (AEPRegionEventType) eventType
                  forRegion: (nonnull CLRegion*) region;

ACP 2.x (Objective-C)

The order of parameters has the CLRegion that triggered the event first, and the ACPRegionEventType second.

+ (void) processRegionEvent: (nonnull CLRegion*) region
         forRegionEventType: (ACPRegionEventType) eventType;
Copied to your clipboard
+ (void) processRegionEvent: (nonnull CLRegion*) region
         forRegionEventType: (ACPRegionEventType) eventType;

The order of parameters has the PlacesRegionEvent first, and the CLRegion that triggered the event second. This aligns better with Swift API naming conventions.

static func processRegionEvent(_ regionEvent: PlacesRegionEvent,
                               forRegion region: CLRegion)
Copied to your clipboard
static func processRegionEvent(_ regionEvent: PlacesRegionEvent,
                               forRegion region: CLRegion)

+ (void) processRegionEvent: (AEPRegionEventType) eventType
                  forRegion: (nonnull CLRegion*) region;
Copied to your clipboard
+ (void) processRegionEvent: (AEPRegionEventType) eventType
                  forRegion: (nonnull CLRegion*) region;

The order of parameters has the CLRegion that triggered the event first, and the ACPRegionEventType second.

+ (void) processRegionEvent: (nonnull CLRegion*) region
         forRegionEventType: (ACPRegionEventType) eventType;
Copied to your clipboard
+ (void) processRegionEvent: (nonnull CLRegion*) region
         forRegionEventType: (ACPRegionEventType) eventType;

registerExtension

AEP 3.x (Swift)

Registration occurs by passing Places to the MobileCore.registerExtensions API.

MobileCore.registerExtensions([Places.self])
Copied to your clipboard
MobileCore.registerExtensions([Places.self])

AEP 3.x (Objective-C)

Registration occurs by passing AEPMobilePlaces to the [AEPMobileCore registerExtensions:completion:] API.

[AEPMobileCore registerExtensions:@[AEPMobilePlaces.class] completion:nil];
Copied to your clipboard
[AEPMobileCore registerExtensions:@[AEPMobilePlaces.class] completion:nil];

ACP 2.x (Objective-C)

+ (void) registerExtension;
Copied to your clipboard
+ (void) registerExtension;

Registration occurs by passing Places to the MobileCore.registerExtensions API.

MobileCore.registerExtensions([Places.self])
Copied to your clipboard
MobileCore.registerExtensions([Places.self])

Registration occurs by passing AEPMobilePlaces to the [AEPMobileCore registerExtensions:completion:] API.

[AEPMobileCore registerExtensions:@[AEPMobilePlaces.class] completion:nil];
Copied to your clipboard
[AEPMobileCore registerExtensions:@[AEPMobilePlaces.class] completion:nil];

+ (void) registerExtension;
Copied to your clipboard
+ (void) registerExtension;

setAuthorizationStatus

AEP 3.x (Swift)

static func setAuthorizationStatus(status: CLAuthorizationStatus)
Copied to your clipboard
static func setAuthorizationStatus(status: CLAuthorizationStatus)

AEP 3.x (Objective-C)

+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;
Copied to your clipboard
+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;

ACP 2.x (Objective-C)

+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;
Copied to your clipboard
+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;

static func setAuthorizationStatus(status: CLAuthorizationStatus)
Copied to your clipboard
static func setAuthorizationStatus(status: CLAuthorizationStatus)

+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;
Copied to your clipboard
+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;

+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;
Copied to your clipboard
+ (void) setAuthorizationStatus: (CLAuthorizationStatus) status;

For additional details, please read the Places API reference.

API reference

Overview

Was this helpful?

Yes

Migrating to AEPPlaces reference

Public classes.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Public APIs (alphabetical)

clear.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

extensionVersion

getCurrentPointsOfInterest

getLastKnownLocation

getNearbyPointsOfInterest

processRegionEvent

registerExtension

setAuthorizationStatus

Public classes

clear