VenueNext Android SDK Integration

The VenueNext SDK provides a simple way to add VenueNext mobile ordering features into 3rd party iOS and Android apps. The SDK is a single package that contains multiple libraries that can be integrated into an Android project.

Features currently available:

Purchase food & beverage for delivery, pickup, or order ahead
Select food & beverage modifiers with or without multiple quantity
Purchase fan experiences
Promote season ticket holder exclusive experiences
Deep link directly to a revenue center or order history
Mobile wallet (balance history, & ways to earn coming soon)
Configure default product type filter to food & beverage, experiences, or merchandise
Analytic tracking framework

Whats New?

v0.2.3 | 10-7-2019

Docs | Project | Demo

Navigation Improvements
UI Improvements and Bug Fixes

Major Changes of Note in v0.2.3

Added compiler dependency for Room (see Room section of app’s build.gradle dependencies section in Initialization and Examples)
Implementation of navigation has changed (see Initialization and Examples)

Obtaining the SDK

Configure JFrog Repository

Add plugin and repository to the app’s build.gradle file:

apply plugin: 'maven-publish'
  repositories {
    maven {
      url "https://venuenext.jfrog.io/venuenext/venuenextsdk-android"
        credentials {
          username = XXXXXXXXXXXXXXXXX
          password = XXXXXXXXXXXXXXXXX
        }
    }
}

Required Configuration

Add library dependencies:

apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
apply plugin: 'kotlinx-serialization'
apply plugin: 'androidx.navigation.safeargs'
apply plugin: 'com.google.gms.google-services'
apply plugin: 'io.fabric'

Enable databinding in the app’s build.gradle file:

android {
  dataBinding {
    enabled = true
  }
}

Add dependencies to the project’s build.gradle:

buildscript {
    ext {
        gradle_version = '3.4.2'
        kotlin_version = '1.3.41'
        kotlin_coroutines_version = '1.2.2'
        serialization_version = '0.11.1'
    }
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:$gradle_version"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
        classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.7.3"
        classpath "android.arch.navigation:navigation-safe-args-gradle-plugin:1.0.0"
        classpath 'com.google.gms:google-services:4.3.0'
        classpath 'io.fabric.tools:gradle:1.31.0'
    }
}

allprojects {
  repositories {
    google()
    jcenter()

    maven { url "https://kotlin.bintray.com/kotlinx" }
    }
}

Add dependencies to your app’s build.gradle:

//venuenext
implementation 'com.venuenext:vncore:0.2.3'
implementation 'com.venuenext:vncoreui:0.2.3'
implementation 'com.venuenext:vnanalytics:0.2.3'
implementation 'com.venuenext:vnlocalytics:0.2.3'
implementation 'com.venuenext:vnlegacy:0.2.3'
implementation 'com.venuenext:vnorder:0.2.3'
implementation 'com.venuenext:vnorderui:0.2.3'
implementation 'com.venuenext:vnpayment:0.2.3'
implementation 'com.venuenext:vnticket:0.2.3'

//kotlin
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
implementation "org.jetbrains.kotlinx:kotlinx-serialization-runtime:$serialization_version"
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlin_coroutines_version"
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlin_coroutines_version"
//ui
implementation 'com.google.android.material:material:1.0.0'
implementation 'androidx.appcompat:appcompat:1.0.2'
implementation 'androidx.core:core-ktx:1.0.2'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
implementation 'androidx.legacy:legacy-support-v4:1.0.0'
implementation 'com.android.support:cardview-v7:28.0.0'
implementation 'com.android.support:cardview-v7:28.0.0'
implementation 'com.android.support:appcompat-v7:28.0.0'
//lifecycle
implementation "androidx.lifecycle:lifecycle-extensions:2.0.0"
//navigation
implementation "android.arch.navigation:navigation-ui-ktx:1.0.0"
implementation "android.arch.navigation:navigation-fragment:1.0.0"
implementation "android.arch.navigation:navigation-fragment-ktx:1.0.0"
//room
implementation "androidx.room:room-runtime:2.1.0"
kapt "androidx.room:room-compiler:2.1.0"
//firebase
implementation 'com.google.firebase:firebase-core:17.0.1'
implementation 'com.google.firebase:firebase-analytics:17.0.1'
implementation 'com.google.firebase:firebase-messaging:19.0.1'
implementation 'com.google.android.gms:play-services-tagmanager:17.0.0'
//crashlytics
implementation 'com.crashlytics.sdk.android:crashlytics:2.10.1'
//braintree
implementation 'com.braintreepayments.api:braintree:3.0.0'
implementation 'com.braintreepayments.api:drop-in:4.1.0'
//facebook
implementation 'com.facebook.shimmer:shimmer:0.4.0'
//qr codes
implementation 'com.journeyapps:zxing-android-embedded:3.6.0'
implementation 'com.google.zxing:core:3.3.3'
//image loading
implementation "com.github.bumptech.glide:glide:4.9.0"
//localytics
implementation 'com.android.support:support-compat:28.0.0'
implementation 'com.google.android.gms:play-services-ads:18.1.1'
implementation "com.google.android.gms:play-services-gcm:17.0.0"
implementation "com.google.android.gms:play-services-location:17.0.0"
implementation 'com.localytics.android:library:5.5+'

implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'
implementation 'com.android.support:multidex:1.0.3'

Initialization and Examples

To initialize the SDK pass in your SDK key and secret. This could potentially go in the onViewCreated handler of a Fragment class. Also, this is where we configure Crash Reporting, Analytics, & Payment Processing for plugging in a specific framework.

GlobalScope.async {
    VenueNext.configureAnalytics(FirebaseAnalytics(this@MainActivity))
    VenueNext.configureAnalytics(LocalyticsAnalytics(this@MainActivity, application!!))

    VenueNextOrders.configurePaymentProcessing(BraintreePaymentProcessableFragment(), true)

    VenueNext.initialize("SDK_KEY", "SECRET_KEY", self.context!!).await()

    withContext(Dispatchers.Main) {
      findNavController().navigate(R.id.action_start_to_stands)
    }
}

Please treat your SDK secret with care. Do not check into source repositories or pass around in the clear

Variations

If you intend to use VenueNext Wallet functionality, please see additional initialization documentation in the Wallet Configuration section

Add fragment to your MainActivity layout:

<fragment
  android:id="@+id/fragment_main"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  app:navGraph="@navigation/app_navigation"
  android:name="androidx.navigation.fragment.NavHostFragment"
  app:defaultNavHost="true"/>

Add “app_navigation.xml” to your /app/src/main/res/navigation folder

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
            xmlns:app="http://schemas.android.com/apk/res-auto"
            xmlns:tools="http://schemas.android.com/tools"
            android:id="@+id/app_navigation"
            app:startDestination="@id/core_navigation">

    <include app:graph="@navigation/core_navigation"/>

</navigation>

Navigating Into VenueNext Fragments

Launching into VenueNext Flows

Revenue Center Flow: This is a starting point for ordering food/beverages and experiences and is the suggested flow to launch into when showing basic VenueNext content
```
Navigation.findNavController(view).navigate(com.venuenext.vncoreui.R.id.action_start_to_stands)
```
Wallet Flow: This is a starting point for showing wallet virtual currency balance, QR code, and virtual currency transfer
```
Navigation.findNavController(view).navigate(com.venuenext.vncoreui.R.id.walletFragment)
```

My Orders Flow: This is a starting point for showing a user’s previously placed orders

Navigation.findNavController(view).navigate(com.venuenext.vncoreui.R.id.myOrdersFragment)

UI configuration for theme colors

Set the theme in your styles.xml:

<style name="AppTheme" parent="Theme.MaterialComponents.Light.NoActionBar">
  <!-- Customize your theme here. -->
  <item name="colorPrimary">@color/colorPrimary</item>
  <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
  <item name="colorAccent">@color/colorAccent</item>
  <item name="colorButtonNormal">@color/colorAccent</item>
  <item name="colorControlHighlight">@color/colorAccent</item>
</style>

Set resource colors in your colors.xml:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="colorPrimary">#fff</color>
    <color name="colorPrimaryDark">#000</color>
    <color name="colorAccent">#0075BD</color>
</resources>

Push notification configuration for FCM

override fun onMessageReceived(remoteMessage: RemoteMessage?) {
  super.onMessageReceived(remoteMessage)

  VenueNext.handleRemoteMessage(this, remoteMessage)
}

FirebaseInstanceId.getInstance().instanceId
  .addOnCompleteListener(OnCompleteListener { task ->
    if (!task.isSuccessful) {
      return@OnCompleteListener
    }

    // Get new Instance ID token
    val token = task.result?.token

    // Register device
    VenueNext.registerDevice(this@MainFragment.context!!, token!!)
}

Deeplinking to Menus, Orders, and My Orders

VNNavigationController.showMenu(forStandUUID: String?,
  forMenuUUID: String?, withStyle: VNNavigationController.DisplayType, usingContext: Context,
  usingBaseFragment: Fragment? = null)

Show Orders

VNNavigationController.showOrder(forOrderUUID: String, withStyle: VNNavigationController.DisplayType,
  usingContext: Context, usingBaseFragment: Fragment? = null)

Show My VenueNext Orders

VNNavigationController.showMyOrders(withStyle: VNNavigationController.DisplayType, usingContext: Context,
  usingBaseFragment: Fragment? = null)

Based on Product Type

// Use bundle to provide product type filter for stands
val bundle = bundleOf("productType" to ProductType.FOOD.value)
Navigation.findNavController(view).navigate(R.id.action_start_to_stands, bundle)

Wallet Configuration

Wallet Dependencies

If you intend to use the wallet feature of the VenueNext SDK, be sure to include the following dependencies:

implementation 'com.venuenext:vnwallet:0.2.3'
implementation 'com.venuenext:vnwalletui:0.2.3'

Wallet Setup

To use wallet, you must do the following:

Implement the WalletInterface
- virtualCurrencyName will be the name that is displayed in wallet and checkout areas of the SDK.
- showWallet() will show the VenueNext wallet UI.
Implement the TicketingInterface, and specifically the startLoginFlow() function.
Implement the callbacks in VNTicket that inform the VenueNext SDK of login success or failure that result from the TicketingInterface’s startLoginFlow() function:
- onLoginSuccess(ticketingLoginData: TicketingLoginData) passes the user’s email address and ticketing provider ID to the SDK
- onLoginFailure() - notifies the SDK that the login flow did not complete successfully
Pass the instance of each of these interfaces to the VenueNext object after the SDK initialize call:
- VenueNext.walletInterface = myWalletInterface
- VenueNext.ticketingInterface = myTicketingInterface
Add the following call to the SDK setup seen in the Initialization and Examples section:
```
VenueNext.registerDeepLinkable(VnWalletUi)
```

Add VenueNext Deep Link handling to your project’s current deep link implementation:

private fun handleIntent(intent: Intent?) {
      if (intent?.action == Intent.ACTION_VIEW) {
          intent.data?.let {
              if (VenueNext.canHandleDeepLink(it)) {
                  VenueNext.handleDeepLink(it)
              }
          }
      }
  }

If you want push notifications enabled in the VenueSDK please contact us so we can coordinate certificates

API Docs

v0.2.3

Change History

v0.2.2 | 9-27-2019

Docs | Project | Demo

Virtual Currency Transfer
UI Improvements and Bug Fixes

Major Changes of Note in v0.2.2

The VenueNext navGraph name has changed from app_navigation to core_navigation (see Initialization and Examples)
The primary navigation action name has changed from action_main_to_stands to action_start_to_stands (see Initialization and Examples)
An additional VenueNext library dependency needs to be implemented in your app’s build.gradle - com.venuenext.vnlocalytics (see Initialization and Examples)

v0.2.1 | 9-23-2019

Docs | Project | Demo

Pay at POS with wallet QR code
Use virtual currency as payment method
Split payments for mobile orders using virtual currency
See virtual currency balance
Season Ticket Holder Exclusivity (Experiences)
Season Ticket Holder Discounts (F&B)
UI Improvements and Bug Fixes

v0.2.0 | 9-3-2019

Docs | Project | Demo

Experience Ordering SDK and UI flow
UI Improvements and Bug Fixes

v0.1.7 | 8-9-2019

Docs | Project | Demo

Firebase Crashlytics integration
Deprecated New Relic integration
Fixed Localytics Push Notification issue
UI Improvements and Bug Fixes

v0.1.6 | 7-19-2019

Docs | Project | Demo

Experience API and UI Integration
Migration to v2 API
Filter Stands Data on Navigation based on Product Type
UI Improvements and Bug Fixes

v0.1.5 | 6-25-2019

Docs | Project | Demo

Added support for deep linking to a Menu.
Added support for deep linking to an Order.
Added support for deep linking to My Orders.
UI Improvements and Bug Fixes.

v0.1.4 | 6-14-2019

Docs | Project | Demo

Added the ability to Order Ahead.
Added Alcoholic warning and max limit.
Added offline handling.
Added coupon code support.
Added the ability to select modifiers with secondary pricing threshold.
Added UI handling for Locations not accepting orders.
UI Improvements and Bug Fixes.

v0.1.3 | 5-16-2019

Docs | Project | Demo

Receipt feature
Re-Order feature
UI Improvements and Bug Fixes

v0.1.2 | 5-10-2019

Docs | Project | Demo

Firebase Analytics + Tag Manager Integration
Include Modifier Quantities
Payment Interface for SDK
Braintree Integration
Support for Legacy App Upgrade
UI Improvements and Bug Fixes
Updated Kotlin plugin to 1.3.31

v0.1.1 | 4-15-2019

Docs | Project | Demo

Route Deep Links via Order Notifications
Include Modifiers in Cart
Include Modifiers in Confirmation/Receipt
Place Orders with Modifiers
Updated Kotlin plugin to 1.3.30

v0.1.0 | 3-22-2019

Docs | Project | Demo

Initial release

VenueNext Android SDK Integration

Whats New?

v0.2.3 | 10-7-2019

Major Changes of Note in v0.2.3

Obtaining the SDK

Configure JFrog Repository

Add plugin and repository to the app’s build.gradle file:

Required Configuration

Add library dependencies:

Enable databinding in the app’s build.gradle file:

Add dependencies to the project’s build.gradle:

Add dependencies to your app’s build.gradle:

Initialization and Examples

Variations

Navigating Into VenueNext Fragments

Launching into VenueNext Flows

UI configuration for theme colors

Push notification configuration for FCM

Deeplinking to Menus, Orders, and My Orders

Show Menu

Show Orders

Show My VenueNext Orders

Filter Stands Data on Navigation

Based on Product Type

Wallet Configuration

Wallet Dependencies

Wallet Setup

If you want push notifications enabled in the VenueSDK please contact us so we can coordinate certificates

API Docs

Change History

v0.2.2 | 9-27-2019

Major Changes of Note in v0.2.2

v0.2.1 | 9-23-2019

v0.2.0 | 9-3-2019

v0.1.7 | 8-9-2019

v0.1.6 | 7-19-2019

v0.1.5 | 6-25-2019

v0.1.4 | 6-14-2019

v0.1.3 | 5-16-2019

v0.1.2 | 5-10-2019

v0.1.1 | 4-15-2019

v0.1.0 | 3-22-2019