npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pushnotifications_aws_sns

v1.0.4

Published

Send Push notifications using AWS SNS.

Downloads

10

Readme

Send push notification using AWS SNS(Simple Notification Service)

This package is developed to send push notification to mobile devices android/ios using AWS SNS apis.

In this method we expect that your android/ios app is already set up to receive device token,=.

Follow below mentioned links for setting up application to receive device token.

-For iOS application set up please follow intructions Getting Started with Apple Push Notification Service.

-For android application set up please follow intructions Getting Started with Google Cloud Messaging for Android.

There are two types of notification that can be sent using this API.

  • Broadcast message - In this users device is subscribed to a topic. Notifications are sent to topics and all the users who are subscribed to that topic received notifications.

  • Device Specific message : In this notification are sent to particular devices using device token.

Pacakge API details and usage

Create Topic

This method is used to create a topic in AWS sns.

It requires AWS key information which we pass using below mentioned object. These are your app registration details with aws sns.

let awsHeaderInfo = {
    headers: {      
      "region": "",
      "accesskeyid": "",
      "secretaccesskey": ""
    }
  };

Than we intialize object to pass topic details.

 let topicDTO = {
    "topicName": "TestNewtopic"     
  };

In your project import this package.. Working on getting this to point directly to package. Instead of the dist path which currently it points to.

const pushTest = require("pushnotifications_aws_sns/dist/main");

 pushTest.createTopic(topicDTO, awsHeaderInfo).subscribe(
         result => {
             console.log("result", result);
             res.status(200).send(result);
         },
         error => {
             res.status(500).send(error);
         }); 

Register device.

This method is used to register you device to get the application ARN. Input to this method is your device token and application ARN.

It returns EndPoint ARN which is used to send notification to a particular device. Or subscribe that device to a topic.

Input :

let deviceInput = {
    "notificationToken": "",    
    "applicationARN": ""

};
pushTest.registerDevice(deviceInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result.EndpointArn);
        },
        error=>
        {
            res.status(500).send(error);
        }
    )

Subscribe to topic.

This method is used to subscribe device to a topic.

Input to this method is Device ARN , which we got in response when we registered as device as EndPointARN. and Topic ARN , which we got in response when we created a topic. Or we can get Topic ARN from SNS console.

 let subscribeInput = {
    "endPointArn": "",
    "topicArn": ""

  };
pushTest.subscribetopic(subscribeInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result);
        },
        error => {
            res.status(500).send(error);
        });

Send notification.

This method is used to send notification to either a device ARN or to a Topic ARN.

Input to this method is Device ARN to Topic ARN.

  let sendNotificationInput = {
    "subject": "test",
    "topicARN": "",
    "notificationMessage": "My test message 5"

  };

pushTest.sendNotification(sendNotificationInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result);
        },
        error => {
            res.status(500).send(error);
        });