Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 3.03 KB

README.md

File metadata and controls

76 lines (52 loc) · 3.03 KB
Raw

Analytics-Kotlin Appcues

maven License: MIT

Add Appcues device mode support to your applications via this plugin for Analytics-Kotlin

Adding the dependency

To install the Segment-Appcues integration, simply add this line to your gradle file:

implementation 'com.appcues:segment-appcues:<latest_version>'

Or the following for Kotlin DSL

implementation("com.appcues:segment-appcues:<latest_version>")

An installation tutorial video is also available, for reference.

Using the Plugin in your App

Open the file where you setup and configure the Analytics-Kotlin library. Add this plugin to the list of imports.

import com.appcues.segment.AppcuesDestination

Just under your Analytics-Kotlin library setup, call analytics.add(plugin = ...) to add an instance of the plugin to the Analytics timeline.

    analytics = Analytics("<YOUR WRITE KEY>", applicationContext) {
        this.flushAt = 3
        this.trackApplicationLifecycleEvents = true
    }
    analytics.add(plugin = AppcuesDestination(applicationContext))

Your events will now begin to flow to Appcues in device mode.

Supporting Builder Preview and Screen Capture

During installation, follow the steps outlined in in the Appcues Android SDK documentation for Configuring the Appcues URL Scheme. This is necessary for the complete Appcues builder experience, supporting experience preview, screen capture and debugging.

Support

Please use Github issues, Pull Requests, or feel free to reach out to our support team.

License

MIT License

Copyright (c) 2022 Appcues

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.