Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 2.19 KB

README.md

File metadata and controls

64 lines (50 loc) · 2.19 KB
Raw

Pushraven

A simple library to easily send notifications over Firebase Cloud Messaging (FCM). The library was built with the purpose of making the process of sending messages as simple and modular as posible.

How to use Pushraven

NOTE: Major implementation changes from prerelease versions to v1.0.0. New version version implements Pushraven as singleton that is 'fed' a Notification object. See Sample.java or the example below.

Once you have imported the Pushraven_vX.X.jar file into your library and the com.pushraven.* package into your class, you can send a push message over FCM in 3 steps:

1. Give Pushraven your FCM Server Key.

Pushraven.setKey(my_key);

2. Build your 'Notification' using paramters from the FCM refference[1]

Notification raven = new Notification();
raven.title("MyTitle")
  .text("Hello World!")
  .color("#ff0000")
  .to(client_key);

Some attributes from the specification may not have been added to Pushraven yet, so you can use the following methods:

raven.addRequestAttribute("delay_while_idle", true); // for request attributes
raven.addNotificationAttribute("color", "#ff0000"); // for notification attirubtes

Request attributes are those in table 1 from the specification. Notification attributes are those in tables 2a (iOS) and 2b (Android)

NOTE: you may also use the static Notification from Pushraven:

Pushraven.notification.title("title")
  .to("clients")
  ...

3. Send the raven

Pushraven.push(raven);

// or 
Pushraven.setNotification(raven); // if not already set
Pushraven.push();



3.5 Clearing the raven

You can use the clear() methods to ready the raven for a new notification:

raven.clear(); // clears the notification, equatable with "raven = new Notification();"
raven.clearAttributes(); // clears FCM protocol paramters excluding targets
raven.clearTargets(); // only clears targets

NOTE: Clearing the raven is more efficient than creating a new object. As creating a new object will cause Java Garbage Collector to delete the old object.



[1] https://firebase.google.com/docs/cloud-messaging/http-server-ref