extension-amazon-sns

OpenFL/NME extension for Amazon SNS (push notifications service). This extension allows you to easily integrate AmazonSNS your OpenFL or NME game / application.

Main Features

Amazon SNS offers push notification services through multiple platforms. This means you need to create accounts and get ID for each platform you want to use this extension. For example: To get notifications on Android devices using Google services, you need a google cloud message enabled app and the corresponding APIs configured.

This extension supports the following service carries:

• GCM (google cloud message) - Done!
• Apple Push Notifications - Comming soon.
• Baidu Push Notifications (for china) - Comming soon.
• Amazon Kindle Notifications - Comming soon.

Simple use Example

Using this extension is quite simple: You just call init once and you'll start receiving notifications :)

To initialize the extension and begin to receive notifications.

import extension.amazonsns.AmazonSNS;
import openfl.display.Sprite;

class Main extends Sprite {

	public function new () {
		super ();

		trace("Setting callback functions");
		AmazonSNS.onNotificationsReceived = onNotificationsReceived;
		AmazonSNS.onRegistrationSuccess = onRegistrationSuccess;
		AmazonSNS.onRegistrationError = onRegistrationError; // (optional)
		AmazonSNS.onLoadComplete = onLoadComplete;

		trace("About to init AmazonSNS for Google Cloud Messages");
		AmazonSNS.initGCM('YOUR-GOOGLE-SENDER-ID');
	}

	public function onNotificationsReceived(json:String){
		trace("New Notifications> " + json);
	}

	// If registration is successful, you should use registrationID to send notifications
	// to this device. Most probably you'll need to send the ID to your server APP
	// (which of course is not included on this extension and you need to do it all by yourself)
	public function onRegistrationSuccess(registrationID:String){
		trace("Registration success: "+registrationID);
		// you can also call AmazonSNS.getRegistrationId(); to get registrationID at any time.
		// you can also call AmazonSNS.getRegistrationError(); to get registrationErrors at any time.
	}

	public function onRegistrationError(error:String){
		trace("Registration error: "+error+" will retry in 5 seconds.");
		haxe.Timer.delay(AmazonSNS.registerRetry,5000);
	}
	
}

Customize notifications text and icon

By default, the extension uses:

1. Your app name as title.
2. Your app icon as icon.
3. Some generic text in english as description.

You can customize notification texts (title and descriptions) by calling setNotificationTitle and setNotificationMessage. Both functions will get the singular and plural texts as parameters (for when you have one or more notifications). Automatically, the extension will replace "%%" by the number of notifications you have waiting.

Example:

	AmazinSNS.initGCM("YOUR-SENDER-ID");
	// After calling init, you can call setNotificationTitle and setNotificationMessage;
	AmazonSNS.setNotificationTitle("New message for you...","WOW! %% new messages waiting");
	AmazonSNS.setNotificationMessage("Click here to see it!","Click here to see %% messages...");

To customize icons (ON ANDROID), you need to add them to the app resources so that they end up on the following folders: res/drawable-XXXX/notification_icon.png and res/drawable-XXXX/multi_notification_icon.png. If those resources are not available for some resolution or missing at all, the extension will use the icon under res/drawable-XXXX/icon.png (wich is the openfl default location).

How to Install

To install this library, you can simply get the library from haxelib like this:

haxelib install extension-amazon-sns

Once this is done, you just need to add this to your project.xml

<haxelib name="extension-amazon-sns" />

Disclaimer

Amazon is a registered trademark of Amazon Technologies, Inc. http://es.unibrander.com/estados-unidos/12554US/amazon.html

License

The MIT License (MIT) - LICENSE.md

Copyright © 2016 SempaiGames (http://www.sempaigames.com)

Author: Federico Bricker