Skip to content

semaphr/android

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 

Repository files navigation

Semaphr

Semaphr is an all-in-one kill switch for your mobile apps. With Semaphr, you can force users to update to the latest version of your mobile apps, encourage app updates, or alert them of any issues with the app.

What does it do?

  • Forcing updates: Keep your users up to date with the latest features, security, and bug fixes.
  • Encouraging updates: Engage and inform users about exciting improvements to your app.
  • Alert system: Proactively communicate if any app parts aren't working as expected.
  • App blocking: Take charge by temporarily blocking users, perfect for maintenance or critical issues.


How to use it?

  • To get started, visit our website and register an account.
  • Create a new app.
  • Go to Settings -> Integrations add the details for your app and follow the instructions.

Gradle integration

To integrate the SDK using Gradle, add the following dependency to your project:

implementation 'com.semaphr:Semaphr:1.+'

Usage in the app

To use the SDK, you simply have to add your API key.

The API key can be found on our website in the Settings -> Integrations section. Click Copy to Clipboard and paste it into the code, where you initialize the SDK.

A good place to add the initialization code is in the Application class as follows:

class MainApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        Semaphr.configure(this, API_KEY)
    }

}

Adding your first message

- Once the SDK is added, it's important to lunch the app, so that the current version of the app can be inferred by our systems.

After an initial startup, you can go to Messages and add a new message, once it's published, the message will be displayed every time the app is brought to the foreground by your users.



Examples

You can find examples of how to integrate the codebase here.



Disable the SDK

Should you wish to disable the SDK for any reason, you can simply call the following method:

    Semaphr.disable()


FAQs


How do I support multiple environments on the SDK?

You can support multiple environments by creating multiple apps and using separate API keys for each environment.


Are the messages displayed instantly?

The messages are only displayed if the user brings the app to the foreground, otherwise, they can continue to use it. This is by design, as otherwise, the SDK will have to query the status periodically. This functionality is only offered with our enterprise plans.


I need a new functionality...

If you have any suggestions, or you're looking for a feature that's not available out of the box, write us an email at info@semaphr.com.



Copyright Semaphr.

About

The Android SDK for semaphr.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages