Skip to content

Latest commit

 

History

History
225 lines (121 loc) · 9.83 KB

MIGRATION.md

File metadata and controls

225 lines (121 loc) · 9.83 KB
Raw

PWMapKit Migration Guide

Upgrade from 3.14.x to 3.15.x

General

This release adds capability to get remaining distance to a route destination.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.15.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.13.x to 3.14.x

General

This release adds capability to get distances from a starting location to all POIs.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.14.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.12.x to 3.13.x

General

This release adds capability to display connected buildings during campus routing.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.13.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.11.x to 3.12.x

General

The iOS deployment target of PWMapKit is now 13.0 instead of 10.0. To be compatible with PWMapKit, an application must have a minimum iOS deployment target of 13.0 as well.

Upgrade Steps

  1. Update your applicable Xcode project settings to a minimum iOS deployment target of 13.0 or greater.

  2. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.12.x', update your iOS platform to 13.0 or greater, then run pod update in the Terminal to update the framework.

Upgrade from 3.10.x to 3.11.x

General

This release adds campus routing features.

Change Detail

PWMapKit

ADDED

*- (void)setCampus:(PWCampus *)campus animated:(BOOL)animated onCompletion:(void (^)(NSError *error))completion;

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.11.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.9.x to 3.10.x

General

This release updates the distribution packaging format to use the new XCFramework binary format.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.10.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.8.x to 3.9.x

General

This release includes Landmark Routing features.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '~> 3.9.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.7.x to 3.8.x

General

This release includes PWLocation 3.8.x which contains GPS blending with indoor location providers and Managed Compass.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.8.x', then run pod update in the Terminal to update the framework.

  2. If your site suffers from inaccurate heading with blue dot, try setting managedCompassEnabled to true on your PWMapView instance. See documentation on managedCompassEnabled for more details.

Upgrade from 3.6.x to 3.7.x

General

This release includes PWLocation 3.7.x which contains beacon maintenance features.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.7.x', then run pod update in the Terminal to update the framework.

Upgrade from 3.5.x to 3.6.x

General

This release includes PWCore 3.8.x which contains new automatic screen view analytic events and simplified analytic event creation.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.6.x', then run pod update in the Terminal to update the framework.

  2. Check out the migration guide for PWCore 3.8.x on updating to the new analytics API.

Upgrade from 3.4.x to 3.5.x

General

The iOS deployment target of PWMapKit is now 10.0 instead of 9.0. To be compatible with PWMapKit, an application must have a minimum iOS deployment target of 10.0 as well.

Upgrade Steps

  1. Update your applicable Xcode project settings to a minimum iOS deployment target of 10.0 or greater.

  2. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.5.x', update your iOS platform to 10.0 or greater, then run pod update in the Terminal to update the framework.

Upgrade from 3.3.x to 3.4.x

General

This release bumps the version of PWLocation which no longer prompts for location permission, leaving control to the app developer.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.3.x', then run pod update in the Terminal to update the framework. This will take in the latest version of PWLocation 3.3.x with latest version of PWCore 3.6.x.

  2. Please follow Apple's Best Practices for requesting location permissions.

  3. According to the above best practices, react to different levels of authorization the user might pick: Always, When In Use, or None. A PWLocationManager should not be used if no location permission was given; this can lead to unexpected and unsupported behavior.

Upgrade from 3.2.x to 3.3.x

General

This release has some changes to support our new Location BLE provider.

Upgrade Steps
  1. Open the Podfile from your project and change PWMapKit to include pod 'PWMapKit', '3.3.x', then run pod update in the Terminal to update the framework. This will take in the latest version of PWLocation 3.3.x with latest version of PWCore 3.3.x.

Upgrade from 3.1.x to 3.2.0:

General

Before v3.2.0 the PWMapView is a subclass of UIView and provides almost all the functions and properties like MKMapView does, from v3.2.0 PWMapView is changed to be subclass of MKMapView and you can use all the functions and properties that MKMapView has, as well as some convenient ones for indoor features.

Upgrade Steps

  1. Open the Podfile from your project and change PWMapKit include as pod 'PWMapKit', '3.2.0', then run pod update in the Terminal to update the framework.

  2. Search for .userLocation in whole project and replace the PWMapView.userLocation with PWMapView.indoorUserLocation, and don't forget change its type from PWCustomLocation to PWUserLocation.

  3. Search for .floor in whole project and replace the PWMapView.floor with PWMapView.currentFloor.

  4. Search for didChangeUserTrackingMode in whole project and replace PWMapViewDelegate.mapView:didChangeUserTrackingMode: with PWMapViewDelegate.mapView: didChangeIndoorUserTrackingMode:.

  5. The PWMapView.currentRoute is changed to readonly, remove the code of setting currentRoute if possible.

  6. Optional - replace the deprecated stuff according the change detail as below.

New

  • Set initial(or default) floor for the map via its delegate callback [PWMapViewDelegate mapViewWillSetInitialFloor:].
  • Set initial display region for the map via its delegate callback [PWMapViewDelegate mapViewWillSetCameraAfterLoadingBuilding:].

Change Detail

PWMapView

IMPORTANT

  • PWMapView.userLocation will not be user's indoor location, you can use PWMapView.indoorUserLocation instead.
  • [PWMapViewDelegate mapView: didChangeUserTrackingMode:] will not deliver tracking mode changes, you can use [PWMapViewDelegate mapView: didChangeIndoorUserTrackingMode:] instead.
  • PWMapView.currentRoute is changed to readonly.

ADDED

  • [PWMapViewDelegate mapView: didChangeIndoorUserTrackingMode:], it's a replacement of [PWMapViewDelegate mapView: didChangeTrackingMode:]
  • [PWMapViewDelegate mapViewWillSetCameraAfterLoadingBuilding:], it's using for setting an initial map region to display.
  • [PWMapViewDelegate mapViewWillSetInitialFloor:], it's using for setting an initial floor to display.

DEPRECATED

  • PWMapView.zoomLevel, you can use PWMapView.region or PWMapView.visibleMapRect instead.
  • [PWMapView getFloorByFloorId:], you can use [PWMapView floorById:] replace.
  • [PWMapView setCenterCoordinate: zoomLevel: animated:], you can use any of[PWMapView setCamera: animated:], [PWMapView setRegion: animated:], [PWMapView setVisibleMapRect: animated:] or [PWMapView setVisibleMapRect: edgePadding: animated:] instead.
  • [PWMapView navigateToCustomLocation:] and [PWMapView navigateToPointOfInterest:], you can use [PWMapView setCamera:animated:] or [PWMapView setCenter:animated:] instead.
  • [PWMapView viewForPointOfInterest:], you can use [PWMapView viewForAnnotation:] instead.
  • [PWMapView showPointsOfInterest:], you can use [PWMapView showAnnotations: animated:] instead.
  • [PWMapView selectPointOfInterest:] animated:, you can use [PWMapView selectAnnotations: animated:] instead.
  • [PWMapView deselectPointOfInterest:] animated:, you can use [PWMapView deselectAnnotations: animated:] instead.
  • [PWMapView startUpdatingHeading] and [PWMapView stopUpdatingHeading], you can create your own CLLocationManager to get heading update.
  • [PWMapView setFloor:], you can use PWMapView.currentFloor instead.

REMOVED

  • Long press on the map to drop a pin will no longer work and the PWMapView.customLocation is removed, but you can simply add it with UILongPressGestureRecognizer by yourself.
PWBuilding

DEPRECATED

  • [PWBuilding buildingWithIdentifier:usingCache:completion:], you can use [PWBuilding buildingWithIdentifier:completion:] instead.
  • [PWBuilding getFloorByFloorId:], you can use [PWBuilding floorById:] instead.
PWPointOfInterest

Added

  • The PWPointOfInterest.imageURL, it's an optional replacement of image.
PWCustomLocation (deprecated)
  • This class is deprecated, you can use PWUserLocation instead.