{"id":21675967,"url":"https://github.com/helpscout/beacon-android-sdk-sample","last_synced_at":"2025-04-12T04:54:42.614Z","repository":{"id":33892770,"uuid":"104202718","full_name":"helpscout/beacon-android-sdk-sample","owner":"helpscout","description":"Collection of samples for the Beacon Android SDK","archived":false,"fork":false,"pushed_at":"2025-02-14T11:19:25.000Z","size":1091,"stargazers_count":10,"open_issues_count":3,"forks_count":7,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-04-12T04:54:34.765Z","etag":null,"topics":["android","beacon","sample-app"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helpscout.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-20T10:45:50.000Z","updated_at":"2025-02-14T11:19:27.000Z","dependencies_parsed_at":"2024-07-26T13:28:42.022Z","dependency_job_id":"21133d09-08ab-4255-8df2-ac29401ece2a","html_url":"https://github.com/helpscout/beacon-android-sdk-sample","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fbeacon-android-sdk-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fbeacon-android-sdk-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fbeacon-android-sdk-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fbeacon-android-sdk-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helpscout","download_url":"https://codeload.github.com/helpscout/beacon-android-sdk-sample/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248519472,"owners_count":21117757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","beacon","sample-app"],"created_at":"2024-11-25T14:11:41.986Z","updated_at":"2025-04-12T04:54:42.588Z","avatar_url":"https://github.com/helpscout.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Beacon Android SDK Samples\n\nThis repository contains two sample apps that showcase how to integrate the Beacon Android SDK.\n\n* [Sample Kotlin](./sample-kotlin) - A simple and concise demo that shows how to install, initialise, and two different ways to open your Help Scout Beacon.\n* [Sample Customisation](./sample-customisation) - Java based sample illustrates some of the key features you can use to customise the Beacon SDK to add additional data about the user and how to override certain Beacon settings.\n\n## Beacon SDK version [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.helpscout/beacon/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/com.helpscout/beacon)\n\n[Release notes and changelog](https://github.com/helpscout/beacon-android-sdk-sample/blob/master/CHANGELOG.md)\n\nYou can subscribe to receive release updates by following these steps:\n1. At the top right-hand corner, click on \"Watch\"\n2. Choose \"Custom\"\n3. Check the \"Releases\" option\n\n[\u003cimg src=\"./docs/subscribe-to-releases.png\" width=\"320\"\u003e](./docs/subscribe-to-releases.png)\n\n## Requirements\n\n* `minSdkVersion`: **21**\n* `compileSdkVersion`:**35**\n* Java 11 language feature support (compile with Java 17 as of version 5.0.0)\n* [Android X](https://developer.android.com/jetpack/androidx/) as of version SDK 2.0.0\n* A Beacon Id created on [Help Scout](https://secure.helpscout.net/settings/beacons/)\n\n### Supported platform and language versions\n\n* Android 11.0 to 15.0 (as noted above the \"minSdkVersion: 21 (Android 5.0)\" for greater compatibility however we only offer support for issues on Android 11+)\n* Kotlin 1.8.20\n* Java 11\n* Koin 3.4.2\n\n## Installation\nThe Beacon Android SDK is distributed as AAR and available from Maven Central, so add the following lines to your app's `build.gradle` file.\n\n**Groovy**\n```groovy\nrepositories {\n    mavenCentral()\n    …\n}\n\ndependencies {\n  implementation 'com.helpscout:beacon:\u003cbeaconVersion\u003e'\n}\n```\n\n**Kotlin DSL**\n```groovy\nrepositories {\n    mavenCentral()\n    …\n}\n\ndependencies {\n    implementation(\"com.helpscout:beacon:\u003cbeaconVersion\u003e\")\n}\n```\n\nOnce you sync the Gradle project, you'll be ready to initialize Beacon.\n\n\n# Initialize Beacon\n\nAfter following the steps above, your app is ready to integrate with the Beacon SDK. Before you can continue any further, you'll need to get a hold of the ID of the Beacon that you'd like to use.\n\nYou can find your Beacon ID by [logging into Help Scout](https://secure.helpscout.net/settings/beacons) and navigating to the Beacon you'd like to use. Inside the `Installation` section, you'll see an Android tab that highlights the Beacon ID and a code snippet.\n\nOnce you've located the Beacon ID, you are ready to initialize the library. If you only display one Beacon, the `Application.onCreate()` method of your [Application class](https://developer.android.com/reference/android/app/Application.html)\nclass is a great place to initialize the SDK. If you won't know the Beacon ID at Application start or run multiple Beacons, you'll need to make sure of adding the following call to the `Beacon.Builder()` before you launch `BeaconActivity`.  \n\n```java\nBeacon beacon = new Beacon.Builder()\n  .withBeaconId(\"YOUR_BEACON_ID_HERE\")       \n  .build();\n```\n\nBeacon ID field is mandatory. Failing to provide it throws an `SDKInitException`\nwhen interacting with the `Beacon` object.\n\n## Opening Beacon\n\nOnce you've initialized Beacon, you're ready to interact with it. Whenever you want\nto invoke Beacon, use the code below to display the Beacon user interface.\n\n```java\nBeaconActivity.open(context);\n```\n\n## Developer options\n\nIt's possible to launch the Beacon SDK in developer mode. By doing so, you'll be able to read\nthe HTTP requests and other actions that happen with the SDK realm.\n\nTo activate this mode, you have to tell the Beacon Builder like so:\n\n```java\nBeacon beacon = Beacon.Builder()\n  .withBeaconId(\"YOUR_BEACON_ID_HERE\")       \n  .withLogsEnabled(true)       \n  .build();\n```\n\nTo verify, take a peek in your Logcat.\n\n\n## Documentation\n\n* [Beacon Mobile SDK documentation](https://developer.helpscout.com/beacon-2/mobile/)\n* [Android SDK API](https://developer.helpscout.com/beacon-2/android/)\n* [Android SDK API reference](https://developer.helpscout.com/beacon-2/android-api/beacon/index.html)\n\n\n## Support\n\nFor issues or questions, contact Help Scout support at [help@helpscout.com](mailto:help@helpscout.com?subject=%5BAndroid%20Beacon%20SDK%5D%20Issue%20report\u0026body=Technical%20details%0A%0A-%20Beacon%20version%3A%0A-%20Android%20OS%20version%3A%0A-%20Device%20make%2Fmodel%3A%0A-%20Impacted%20user%20count%3A%0A%0AActual%20outcome%0A%0A%20%20%20%20Beacon%20did%20or%20did%20not...%0A%0AExpected%20outcome%0A%0A%20%20%20%20Beacon%20should...%0A%0ASteps%20to%20reproduce%0A%0A%20%20%20%201.%20%E2%80%A6%0A%20%20%20%202.%20%E2%80%A6%0A%20%20%20%203.%20%E2%80%A6%0A%0AScreenshots%2FScreen%20Recording%0A%0A%20%20%20%20Please%20add%20any%20images%20or%20videos%20to%20support%20your%20report.%0A%0AAdditional%20Information%0A%0A%20%20%20%20Please%20attach%20any%20crash%20logs)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fbeacon-android-sdk-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelpscout%2Fbeacon-android-sdk-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fbeacon-android-sdk-sample/lists"}