Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lykmapipo/android-push
Android FCM library
https://github.com/lykmapipo/android-push
android fcm firebase gcm lykmapipo notification push
Last synced: 3 months ago
JSON representation
Android FCM library
- Host: GitHub
- URL: https://github.com/lykmapipo/android-push
- Owner: lykmapipo
- Created: 2018-04-14T11:00:59.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:20:04.000Z (about 2 years ago)
- Last Synced: 2024-04-08T15:41:59.059Z (10 months ago)
- Topics: android, fcm, firebase, gcm, lykmapipo, notification, push
- Language: Java
- Size: 264 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
android-push
=======================
[](https://jitpack.io/#lykmapipo/android-push)
Android FCM library
## Installation
Add [https://jitpack.io](https://jitpack.io) to your build.gradle with:
```gradle
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
add `android-push` dependency into your project
```gradle
dependencies {
implementation 'com.github.lykmapipo:android-push:v0.14.0'
}
```
## Usage
Initialize `android-push`
```java
public class SampleApp extends Application {
@Override
public void onCreate() {
super.onCreate();
Push.of(apiBaseUrl, new Provider() {
@NonNull
@Override
public Context getApplicationContext() {
return SampleApp.this.getApplicationContext();
}
}, new AuthProvider() {
@Override
public String getToken() {
return apiKey;
}
});
}
}
```
In activity start listen for the foreground push message
```java
public class MainActivity extends PushCompactActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
@Override
public void onMessage(RemoteMessage remoteMessage) {
...
}
@Override
public void onRegistrationTokenRefreshed(Device device) {
....
}
@Override
public void onRegistrationTokenError(String error) {
...
}
@Override
public void onDeviceSynced(Device device) {
...
}
@Override
public void onDeviceSyncError(String error) {
...
}
}
```
## Android API
### Force Device Sync with Extra Details
To force sync application specific extra details you may call `push.sync(, )` 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
```js
{
extras: {
phone: '255714999999'
},
instanceId: ,
registrationToken: ,
topics: [], //list of topic device subscribe to
uuid:
}
```
## API Server Implementation
API Server endpoint must implemnt `device REST aware resource` and support both `POST` and `PUT` request.
- [See Sample](https://github.com/lykmapipo/android-push/blob/master/api/index.js)
Authorization header is set with the value `Bearer ` on every request sent.
The structure of the information synced to the API end-point is as below:
```js
{
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
```sh
./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.
## License
(The MIT License)
Copyright (c) lykmapipo && 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.