Release Notes
Recent Releases
v2.4.0 | 01-11-2024
What’s New
This release adds the ability to toggle analytics from the SDK to either enabled or disabled. By default, analytics are enabled.
Changes
Two new methods are available with this release - AnalyticsEnabledStatusProvider().checkAnalyticsEnabledStatus()
and AnalyticsEnabledStatusProvider().setEnabledStatus(context: Context, enabled: Boolean)
.
/**
* Sets a flag that dictates whether or not analytics are enabled. If disabled, no analytics
* events should be triggered.
*
* @param enabled: `true` if analytics events should be triggered. `false` otherwise.
*/
public final fun setEnabledStatus(context: Context, enabled: Boolean)
/**
* `true` if analytics events should be triggered. `false` otherwise.
*
* Defaults to `true` if never set. This means analytics are enabled by default.
*/
public final fun checkAnalyticsEnabledStatus(context: Context): Boolean
v2.3.0 | 09-08-2023
What’s New
- This release adds the ability to directly show the Load Ticket wallet feature, both from an external deep link and via a convenience method within the app.
External Deep Link
// Load Tickets
<APP_SCHEME>://vn/wallet?showExchangeServiceDialog=1
// e.g.
vndemoapp://vn/wallet?showExchangeServiceDialog=1
Convenience Method to Show From Within the App
VNNavigationController.showLoadTicket(context)
v2.2.1 | 08-023-2023
What’s New
- This release adds changes and conformity to analytics callbacks
- Certain money amounts previously returned as Doubles will now be returned as Ints representing the amount in cents
- A
VenueNextWeb.clearAnalytics()
call has been added for integrator convenience, should you want to clear out your current analytics listeners
Breaking Changes
If using the PaymentProcessable
or VNAnalyticsInterface
protocols, you will need to update the following callbacks as several argument types have changed from Double
to Int
:
**VNAnalyticsInterface**
...
override fun trackMenuItemSelection(
itemId: String,
itemName: String,
itemCategory: String,
variant: String,
price: Int
)
override fun trackAddItemToCart(
itemId: String,
itemName: String,
itemCategory: String,
variant: String,
price: Int,
quantity: Long
)
override fun trackCompletedPurchase(
orderId: String,
quantity: Int,
discount: Int,
tips: Int,
tax: Int,
total: Int,
paymentTypes: String,
name: String?,
email: String?
)
...
**PaymentProcessable**
...
override fun completedPayment(
orderId: String,
quantity: Int,
discount: Int,
tips: Int,
tax: Int,
total: Int,
paymentTypes: String
)
...
v2.2.0 | 04-07-2023
What’s New
- This release adds security enhancements to the SDK
v2.1.1 | 08-30-2022
What’s New
- Added functionality to show revenue centers with filtering
- Switched Braintree to utilize SPM for dependency recommendations on iOS
Bug Fixes
- Fixed issue with Shift4 i4Go Apple Pay webview not displaying the Close button correctly
- Fixed crashing issue on iOS for completed purchase analytics tracking
v2.1.0 | 04-01-2022
What’s New
- Added correct user log out functionality. Logging the user out now with the new
VenueNextWeb.logUserOut()
will ensure deletion of user credentials and Ordering Web will not retain any information. - Adjusted analytics event
trackCompletedPurchase(...)
to include name and email of user.Bug Fixes
v2.0.10 | 09-03-2021
What’s New
- Added ability pass in Section/Row/Seat (SectionRowSeat) to prefill a user’s seat location in OrderNext.
- Added ability to pass in TicketMaster PSDK access token to User object for compatibilty with TicketMaster’s Presence SDK.
- User analytics now track email and name alongside ID for extended compatibility with TicketMaster Presence SDK.
Bug Fixes
- Fixed potential crash issue when erroneous strings are provided for the VNTheme backString/closeString.
- Fixed error state when utilizing Apple Pay with Shift4 as payment gateway, users no longer get stuck at Apple Pay screen.
v2.0.9 | 07-23-2021
What’s New
- SDK initialization has changed to accept organization name along with OrderNext instance
Bug Fixes
Breaking Changes
- SDK initialization now requires your Organization Name to be passed in alongside your OrderNext instance name. If unsure of your name pair, please contact VenueNext support.
v2.0.8 | 07-20-2021
What’s New
- External Reference ID API to retrieve Venue Mappings to OrderNext instances (requires VenueNext venue mapping configuration if needed).
- Orders that are placed through SDK will now be tracked as such based off of Package Name.
Bug Fixes
- On first application open from a fresh install, deep linking to specific menus and proceeding to cart was failing, this has been addressed.
Breaking Changes
VenueNextWeb.configureExternalPaymentProcessor(processor: PaymentProcessable)
has been deprecated. Moving foward, please useVenueNextWeb.configureExternalPaymentProcessor(context: Context, processor: PaymentProcessable, completion: (Exception?) -> Unit)
. This lambda callback now checks the OrderNext instance to see if external payment processing is allowed and that it is configured as such.
v2.0.7 | 04-28-2021
What’s New
- VNTheme color settings now passed into wallet page for a more integrated feel
Bug Fixes
v2.0.6 | 04-14-2021
What’s New
- Added in new revenue center route that displays all revenue centers with tabbed navigation to select between product types
- Added in ability to present to a specific food and beverage or merchandise menu item
Bug Fixes
v2.0.5 | 03-19-2021
What’s New
- New scanner route added for improved QR Code scanning and UPC/EAN scanning
- New QR code route added for individual display of QR Code rather than combo scanner/qr screen
- When going directly to Badge or Payments routes, back button will now dismiss webview rather than going back to wallet
- Security improvements
Bug Fixes
- When utilizing deeplinks, SDK will now detect ‘vn’ host properly. Instances where a VN deeplink string was contained inside of an integrator’s deeplink, false positives were detected.
- Fixed issue with Badge and Payments modal where if not manually dismissed by user, would always display on any route
v2.0.4 | 02-08-2020
What’s New
- Added back button support for when either the Badge or Payments Modals are showing. Previously the back button was not dismissing these modals, but going back to the last viewed page.
- Added in push/present support for the following Wallet based pages: Send virtual currency, Scan and Pay, Benefits and Rewards, My Info, Payments Modal, Badge Modal
- Added in
VNNavigationProtocol
withwebViewDismissed
delegate function to allow for cleanup when Venue Next web views are dismissed.Bug Fixes
- When Venue Next activity finishes, now properly destroying web views as to not allow them to linger in memory.
- Fixed deep linking issues with certain Venuenext Pages
- Refactored VN SDK layout XML names to prevent conflicts
v2.0.2 | 01-06-2020
What’s New
Bug Fixes
- Fixed issue where when utilizing Scan & Pay in web view, would ask for camera permission every time
v2.0.1 | 12-21-2020
What’s New
- Navigation enhancements to Web View
- Web View Navigation Bar theming
- Additional JWT and PEM options to enhance security
VNNavigationControllerInterface
for contained Activity clean up and dismissal
v2.0.0 | 11-04-2020
What’s New
First version of the VenueNext SDK leveraging the OrderNext Web 2.0 experience