https://github.com/softeq/pushnotificationservice
https://github.com/softeq/pushnotificationservice
azure-notification-hubs dotnet netkit pushnotification
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/softeq/pushnotificationservice
- Owner: Softeq
- License: mit
- Created: 2018-10-30T10:31:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-16T09:03:32.000Z (over 5 years ago)
- Last Synced: 2025-04-13T08:19:49.082Z (about 1 year ago)
- Topics: azure-notification-hubs, dotnet, netkit, pushnotification
- Language: C#
- Size: 50.8 KB
- Stars: 2
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Softeq.NetKit.Services.PushNotifications
Softeq.NetKit.Services.PushNotifications component simplifies the process of bringing support for Push notificaitons to your project. It's build around Azure Notification Hub and supports the following push notification platforms:
1. Android
2. iOS
# Getting Started
## Install
1. Check-out master branch from repository;
2. Add a reference to Softeq.NetKit.Services.PushNotifications into target project.
## Configure Azure Notification Hub
Add Notification Hub settings to your ```appsettings.json``` file:
```json
"Notifications": {
"Push": {
"NotificationHub": {
"ConnectionString": "CONN_STR",
"HubName": "HUB_NAME"
}
}
}
```
## Configure DI Container
Softeq.NetKit.Services.PushNotifications comes with Autofac Module to register its dependencies.
If Autofac is used on your project, add ```PushNotificationsModule``` to the container:
```csharp
builder.RegisterModule(new Softeq.NetKit.Services.PushNotifications.PushNotificationsModule());
```
If different IoC container is used or manual registration is required, the following registrations need to be performed:
1. Set up and register NotificationHub configuration ```AzureNotificationHubConfiguration``` in your DI container
```csharp
builder.Register(context =>
{
var config = context.Resolve();
return new AzureNotificationHubConfiguration(
config["Notifications:Push:NotificationHub:ConnectionString"],
config["Notifications:Push:NotificationHub:HubName"]);
}).SingleInstance();
```
2. Register ```IPushNotificationSubscriber``` implementation
```csharp
builder.RegisterType().As();
```
3. Register ```IPushNotificationSender``` implementation
```csharp
builder.RegisterType().As();
```
## Develop
Softeq.NetKit.Services.PushNotifications comes with ```PushNotificationMessage``` that represents a simple push message with the following structure;
```csharp
public class PushNotificationMessage
{
[JsonIgnore]
public int NotificationType { get; set; }
[JsonIgnore]
public string Title { get; set; } = string.Empty;
[JsonIgnore]
public string Body { get; set; } = string.Empty;
[JsonIgnore]
public int Badge { get; set; } = 0;
[JsonIgnore]
public string Sound { get; set; } = "default";
public virtual string GetData()
{
return JsonConvert.SerializeObject(this);
}
}
```
If an additional properties are required to be sent with push, create custom push message class and inherit from ```PushNotificationMessage```
```csharp
public class ArticleLikedPush : PushNotificationMessage
{
public ArticleLikedPush()
{
Title = "Article liked.";
Body = "Someone liked your article. Check it out!";
NotificationType = (int) PushNotificationType.ArticleLiked;
}
[JsonProperty("articleId")]
public Guid ArticleId { get; set; }
[JsonProperty("newsHeader")]
public string NewsHeader { get; set; }
}
```
### Localization
Project supports client-side message localization by providing platform-specific localization keys:
1. For iOS - ```loc-key``` \ ```loc-args``` and ```title-loc-key``` \ ```title-loc-args```
2. For Android - ```body_loc_key``` \ ```body_loc_args``` and ```title_loc_key``` \ ```title_loc_args```
To enable client-size localization for a particular message, ```BodyLocalizationKey``` and ```TitleLocalizationKey``` properties need to be initialized with valid resource names, available in client:
```csharp
public class ArticleLikedPush : PushNotificationMessage
{
private static string _bodyLocalizationKey = "article_Liked_body";
private static string _titleLocalizationKey = "article_Liked_title";
public ArticleLikedPush()
{
BodyLocalizationKey = _bodyLocalizationKey;
TitleLocalizationKey = _titleLocalizationKey;
NotificationType = (int) PushNotificationType.ArticleLiked;
}
[JsonProperty("articleId")]
public Guid ArticleId { get; set; }
[JsonProperty("newsHeader")]
public string NewsHeader { get; set; }
[JsonProperty("userIdWhoLikedArticle")]
public string UserIdWhoLikedArticle { get; set; }
[JsonIgnore]
[LocalizationParameter(LocalizationTarget.Title, 1)]
[LocalizationParameter(LocalizationTarget.Body, 1)]
public string UserNameWhoLikedArticle { get; set; }
}
```
## Use
Inject ```IPushNotificationSubscriber``` into your service to subscribe or unsubscribe user device from push notifications.
Inject ```IPushNotificationSender``` into your service to send push notifications to registered devices.
## About
This project is maintained by Softeq Development Corp.
We specialize in .NET core applications.
## Contributing
We welcome any contributions.
## License
The Query Utils project is available for free use, as described by the [LICENSE](/LICENSE) (MIT).