Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 3.41 KB

README.md

File metadata and controls

46 lines (29 loc) · 3.41 KB
Raw

Atlas Messenger for Android

Atlas Messenger is a fully-featured messaging app following Material Design guidelines, built on top of the Layer SDK, using the Atlas UI toolkit.

##Setup

Run git submodule update --init to initialize and pull in the Atlas-Android submodule.

##Structure

  • App: Application class.
  • Activities:
    • BaseActivity: Base Activity class for handling menu titles and the menu back button and ensuring the LayerClient is connected when resuming Activities.
    • ConversationsListActivity: List of all Conversations for the authenticated user.
    • MessagesListActivity: List of Messages within a particular Conversation. Also handles message composition and addressing.
    • SettingsActivity: Global application settings.
    • ConversationDetailsActivity: Settings for a particular Conversation.
  • PushNotificationReceiver: Handles com.layer.sdk.PUSH Intents and displays notifications.
  • AuthenticationProvider: Interface used by the Messenger app to authenticate users. Default implementations are provided by gradle flavors; see Build Variants below.

##Identity Providers

Atlas Messenger uses the AuthenticationProvider interface to authenticate with various backends. Additional identity providers can integrate with Atlas Messenger by implementing AuthenticationProvider and using a custom login Activity, similar to the provided flavors below.

###Provided Flavors Two default implementations are provided via product flavors, where each flavor implements a custom AuthenticationProvider, a custom Atlas Participant, and provides login Activities for gathering their required credentials:

  1. atlasprovider: For use in the Layer Atlas demo. This authentication flow utilizes a QR-Code scanner to capture a Layer App ID from the Layer developer dashboard. The scanner can be bypassed by supplying your Atlas demo App ID in the App.LAYER_APP_ID constant.
  2. herokuprovider: For use with the deployable Rails Provider backend. Your Layer App ID must be set in the App.LAYER_APP_ID constant.

In Android Studio, switch flavors using Build Variants, typically in the side tab on the lower left of the Android Studio window.

##Contributing Atlas is an Open Source project maintained by Layer. Feedback and contributions are always welcome and the maintainers try to process patches as quickly as possible. Feel free to open up a Pull Request or Issue on Github.

##License

Atlas is licensed under the terms of the Apache License, version 2.0. Please see the LICENSE file for full details.

##Contact

Atlas was developed in San Francisco by the Layer team. If you have any technical questions or concerns about this project feel free to reach out to Layer Support.

###Credits