byteskode-android-push

byteskode push - Android FCM library

Installation

Add https://jitpack.io to your build.gradle with:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

add byteskode-android-push dependency into your project

dependencies {
    compile 'com.github.byteskode:byteskode-android-push:v0.3.0'
}

Usage

Initialize byteskode-android-push

public class SampleApp extends Application{

    @Override
    public void onCreate() {
        super.onCreate();

        //initialize push
        Push.initialize(<context>, <apiBaseUrl>, <apiAuthorizationToken>);
    }

}

In activity start listen for the foreground push message

public class MainActivity extends PushCompactActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

    @Override
    protected void onResume() {
        super.onResume();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
    }

    @Override
    public void onMessage(RemoteMessage remoteMessage) {
        ...
    }

     @Override
     public void onRegistrationTokenRefreshed(Device device) {
        ....
     }

     @Override
     public void onRegistrationTokenError(String error) {
        ...
     }
     
     @Override
      public void onDeviceSynced(Device device) {
        ...
      }
}

Android API

Force Device Sync with Extra Details

To force sync application specific extra details you may call push.sync(<extraKey>, <extraValue>) or push.sync(mapOfExtras) which will force syncing the device details to your backend api.

All extras will be send under extras field of the device details sent to the server.

Example

{ 
  extras: { 
      phone: '255714999999' 
   },
  instanceId: <firebaseInstanceId>,
  registrationToken: <firebasePushRegistrationToken>,
  topics: [], //list of topic device subscribe to
  uuid: <uniquePseudoId> 
}

API Server Implementation

API Server endpoint must implemnt device REST aware resource and support both POST and PUT request.

• See Sample

Authorization header is set with the value Bearer <apiAuthorizationToken> on every request sent.

The structure of the information synced to the API end-point is as below:

{
    instanceId: String, //FCM instance id
    registrationToken: String, //FCM devic registration token
    topics: [String], //FCM device topic
    uuid: String, // Generated device pseudocode
    info:{ //device information
       tags: String,
       model: String,
       hardware: String,
       display: String,
       board: String,
       type: String,
       product: String,
       fingerprint: String,
       manufacturer: String,
       device: String,
       brand: String,
       sdk: String,
       serial: String 
    },
    extras:{ //application specific extra details about the installation
        
    }
}

Test

./gradlew test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

TODO

• do lazy initialization on Push.initialize() and move heavy initialization on getInstance()
• drop async task and use intent service with localbroadcasts
• update Device to add phone, email & user details
• expose ability to get device from push instance
• add ability to update device from push instance
• add ability to set extra using key-value
• add ability to set more info using key-value
• rename device to installation
• should allow send abitrary command on sync
• sync using device uuid that push registration token
• add api implementation on top of nodejs and mongodb

License

(The MIT License)

Copyright (c) 2016 lykmapipo, byteskode Group && Contributors

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.