PayLoadion.Gcm 1.1.1

.NET Standard 1.0
dotnet add package PayLoadion.Gcm --version 1.1.1
NuGet\Install-Package PayLoadion.Gcm -Version 1.1.1
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.
<PackageReference Include="PayLoadion.Gcm" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PayLoadion.Gcm --version 1.1.1
#r "nuget: PayLoadion.Gcm, 1.1.1"
#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.
// Install PayLoadion.Gcm as a Cake Addin
#addin nuget:?package=PayLoadion.Gcm&version=1.1.1

// Install PayLoadion.Gcm as a Cake Tool
#tool nuget:?package=PayLoadion.Gcm&version=1.1.1

PayLoadion.Gcm

<img src="https://github.com/vinguan/payloadion/blob/master/ProjectsIcons/PayLoadion.Gcm/payloadion_google.png?raw=true" width="200">

Implementation of PayLoadion for Google Cloud Messaging(GCM), following Notification payload Support. PayLoadion.Gcm comes with a plus that is a builder for Downstream HTTP messages #Nuget

Install-Package PayLoadion.Gcm

Getting Started

Creating the PayloadBuilder

var gcmPayLoadBuilder = GcmPayLoadBuilderFactory.CreateGcmPayLoadBuilder();

##Building a simple Apns's Payload

###PayLoad built to object

var gcmPayLoad = GcmPayLoadBuilderFactory.CreateGcmPayLoadBuilder()
                                         .Notification()
                                         .Title("Hello Payloadion.GCM")
                                         .Icon("DefaultIcon")
                                         .AddCustomData("NewsId", 11)
                                         .BuildPayLoad();

###PayLoad built and serialized to string

var gcmPayLoadString = GcmPayLoadBuilderFactory.CreateGcmPayLoadBuilder()
                                               .Notification()
                                               .Title("Hello Payloadion.GCM")
                                               .Icon("DefaultIcon")
                                               .AddCustomData("NewsId", 11)
                                               .BuildPayLoadToString(true);

It should produce this Payload :

  {
  "notification": {
    "title": "Hello Payloadion.GCM",
    "icon": "DefaultIcon"
  },
  "data": {
    "NewsId": 11
  }
}

More cenarios

Only with custom data

var gcmPayLoadString = GcmPayLoadBuilderFactory.CreateGcmPayLoadBuilder()
                                               .AddCustomData("NewsId", 11)
                                               .BuildPayLoadToString(true);

It should produce this Payload :

{
  "notification": {},
  "data": {
    "NewsId": 11
  }
}

With Notification, Custom Data and others arguments

var gcmPayLoadString = GcmPayLoadBuilderFactory.CreateGcmPayLoadBuilder()
                                               .Notification()
                                               .Title("Hello Payloadion.GCM")
                                               .Icon("DefaultIcon")
                                               .Body("Hello Payloadion.GCM Body")
                                               .BodyLocalizableKey("BodyLocKey")
                                               .AddBodyLocalizableArgument("2")
                                               .TitleLocalizableKey("TitleLocKey")
                                               .AddTitleLocalizableArgument("1")
                                               .AddCustomData("NewsId", 11)
                                               .BuildPayLoadToString(true);

It should produce this Payload :

{
  "notification": {
    "title": "Hello Payloadion.GCM",
    "body": "Hello Payloadion.GCM Body",
    "icon": "DefaultIcon",
    "body_loc_key": "BodyLocKey",
    "body_loc_args": [
      "2"
    ],
    "title_loc_key": "TitleLocKey",
    "title_loc_args": [
      "1"
    ]
  },
  "data": {
    "NewsId": 11
  }
}

#Downstream HTTP messages

Getting Started

Creating the DownStream HttpMessage Builder

var gcmDownStreamHttpMessageBuilder = GcmDownStreamHttpMessageBuilderFactory.CreateGcmDownStreamHttpMessageBuilder();

Building a simple message

var gcmDownStreamHttpMessage = GcmDownStreamHttpMessageBuilderFactory.CreateGcmDownStreamHttpMessageBuilder()
                                                                     .ToDevice("123")
                                                                     .Priority(GcmPriorityEnum.Normal)
                                                                     .TimeToLiveUntil(DateTimeOffset.Now.AddMonths(1))
                                                                     .IsDryRun(true)
                                                                     .PayLoad()
                                                                     .Notification()
                                                                     .Title("Hello Payloadion.GCM")
                                                                     .Icon("DefaultIcon")
                                                                     .AddCustomData("NewsId", 11)
                                                                     .BuildGcmDownStreamHttpMessageToJson(true);

It should produce this message :

{
  "to": "123",
  "priority": "normal",
  "time_to_live": 2678400,
  "dry_run": true,
  "notification": {
    "title": "Hello Payloadion.GCM",
    "icon": "DefaultIcon"
  },
  "data": {
    "NewsId": 11
  }
}

##Sending to multiple targets the same message

var gcmDownStreamHttpMessage = GcmDownStreamHttpMessageBuilderFactory.CreateGcmDownStreamHttpMessageBuilder()
                                                                     .AddDeviceId("GcmDeviceUniqueId1")
                                                                     .AddDeviceId("GcmDeviceUniqueId2")
                                                                     .AddDeviceId("GcmDeviceUniqueId3")
                                                                     .Priority(GcmPriorityEnum.Normal)
                                                                     .TimeToLiveUntil(DateTimeOffset.Now.AddMonths(1))
                                                                     .IsDryRun(true)
                                                                     .PayLoad()
                                                                     .Notification()
                                                                     .Title("Hello Payloadion.GCM")
                                                                     .Icon("DefaultIcon")
                                                                     .AddCustomData("NewsId", 11)
                                                                     .BuildGcmDownStreamHttpMessageToJson(true);

It should produce this message :

{
  "registration_ids": [
    "GcmDeviceUniqueId1",
    "GcmDeviceUniqueId2",
    "GcmDeviceUniqueId3"
  ],
  "priority": "normal",
  "time_to_live": 2678400,
  "dry_run": true,
  "notification": {
    "title": "Hello Payloadion.GCM",
    "icon": "DefaultIcon"
  },
  "data": {
    "NewsId": 11
  }
}

Author

Vinicius Gualberto @Vinguan.

Contribute

Fork me and send the pull requests =).

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.0 netstandard1.1 netstandard1.2 netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Universal Windows Platform uap uap10.0
Windows Phone wp8 wp81 wpa81
Windows Store netcore netcore45 netcore451
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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.1 736 1/5/2019
1.1.0 1,012 6/30/2017
1.0.1 1,406 5/2/2016
1.0.0 1,239 4/27/2016

Fixed null checking in Dispose() methods