NotificationServices 1.0.6

.NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package NotificationServices --version 1.0.6
                    


                    

                
NuGet\Install-Package NotificationServices -Version 1.0.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
For projects that support PackageReference, copy this XML node into the project file to reference the package. 

                    


                            Directory.Packages.props
                        

                    

                

                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NotificationServices --version 1.0.6
                    


                    

                
#r "nuget: NotificationServices, 1.0.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package NotificationServices@1.0.6
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NotificationServices&version=1.0.6
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NotificationServices&version=1.0.6
                    


                            Install as a Cake Tool

v1.0.3: Breaking Change: Renamed GetAWPushNotificationSender to GetAWSPushNotificationSender

The current version supports sending out sms, emails and push notifications via AWS services. It supports this via a Basic AWS authentication method. You can also send PushNotification via FCM by just setting the Firebase server key.
Configuration To start with setting the credentials use the Configuration class:
AWS

NotificationServices.Configuration.Instance.AWSAccessKey = "";
NotificationServices.Configuration.Instance.AWSSecretKey = "";
NotificationServices.Configuration.Instance.AWSFCMPNSARN = "";
NotificationServices.Configuration.Instance.AWSIOSPNSARN = "";
NotificationServices.Configuration.Instance.AWSRegionEndPoint = "";


Firebase Push notifications

NotificationServices.Configuration.Instance.FirebaseServerKey = "";

TWILIO

NotificationServices.Configuration.Instance.TwilioAccountSID = "";
NotificationServices.Configuration.Instance.TwilioAuthToken = "";
NotificationServices.Configuration.Instance.TwilioFromNumber = "";



Email
To send out emails get an instance of IEmailSender via EmailSenderFactory. You can then send the email by calling SendAWSEmailAsync. It expects 4 parameters.

  • Source: The source/sender of the email. This needs to be verified in the Simple Email Service
  • ToEmail: The recipient of the email
  • TemplateName: The name of the template to use. You can create templates from cli and can learn more from here. https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
  • TemplateData: The data to substitute in the Template. See the above link to see how to pass the data.
var EmailSender = EmailSenderFactory.GetAWSEmailSender();
EmailSender.SendAWSEmailAsync("noreply@services.com", "recipient@services.com", "ConfirmEmailTemplate", $"{{ "Link":"{EmailCallbackUrl}", "Name": "{FirstName}" }}");



SMS
To send out sms get an instance of ISMSSender via SMSSenderFactory. You can then send the email by calling SendSmsAsync. It expects 4 parameters.

  • number: The recipient number to which the sms needs to be sent.
  • message: Text Message to be sent.
  • SenderId: This is an optional parameter whose default value is "Notif". The sender id to be displayed when the sms is received.
  • SMSType: This is an optional parameter whose default value is "Transactional". The type of sms either it is "Promotional" or "Transactional".

AWS

var SMSSender = SMSSenderFactory.GetAWSSMSSender();
SMSSender.SendSmsAsync("

Twilio

var SMSSender = SMSSenderFactory.GetTwilioSMSSender();
SMSSender.SendSmsAsync("



Push Notifications
To send out push notifications get an instance of IPushNotificationSender via PushNotificationSenderFactory.
FCM You can then send the push notification by calling SendFirebasePushNotification for Firebase. It expects 4 parameters.

  • deviceTokens: An array of fcm device tokens to which the notifications need to be sent.
  • title: The title of the push notification
  • body: The body of the notification.
  • data: A custom object to send in the push notifcation
var PushNotificationSender = PushNotificationSenderFactory.GetFirebasePushNotificationSender();
PushNotificationSender.SendFirebasePushNotification([""], "Hello Title", "Hello Body", new {Id = ""});


AWS Before sending out a push notification via AWS a topic needs to be created for each user using CreateAWSEndpointAsync. It takes 3 parameters:

  • topic: You can pass your user id here. The function will create a topic with this name in AWS.
  • token: The device token which is retrieved from ios & Android installations. For iOS it will be a hexadecimal string.
  • platform: Either iOS or Android. If 'iOS' an endpoint will be created in AWSIOSPNSARN. For Android an endpoint will be created in AWSFCMPNSARN
var PushNotificationSender = PushNotificationSenderFactory.GetAWSPushNotificationSender();
PushNotificationSender.CreateAWSEndpointAsync("","", "");

CreateAWSEndpointAsync will create a Topic with the given 'topic', Create an endpoint in the given 'platform' with the given 'token'. Internally it will also create a subscription in the topic with the newly created endpoint. The reason is explained later on. CreateAWSEndpointAsync returns a PushNotificationResponseDto which return the ARN's for Topic, Subscription & Endpoint.

You will be able to then send a push notification to a particular topic using SendAWSPushNotificationAsync. It takes 2 parameters

  • TopicArn: An array of fcm device tokens to which the notifications need to be sent.
  • Payload: The payload is of type SNS. The payload will be converted to a json format: { "APNS": "{"aps":{"alert": "Check out these awesome deals!","url":"www.amazon.com"} }", "APNS_SANDBOX": "{"aps":{"alert": "Check out these awesome deals!","url":"www.amazon.com"} }", "FCM": "{"data":{"message":"Check out these awesome deals!","url":"www.amazon.com"}}", }
PushNotificationSender.SendAWSPushNotificationAsync("", );
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 1,324 5/21/2020
1.0.9 761 5/15/2020
1.0.8 634 4/23/2020
1.0.7 707 4/23/2020
1.0.6 1,791 3/12/2020
1.0.5 727 3/12/2020
1.0.4 1,827 12/7/2019
1.0.3 883 9/13/2019
1.0.2 680 9/12/2019
1.0.1 674 9/12/2019
1.0.0 744 9/8/2019