Transmitly.ChannelProvider.Firebase 0.3.0

Transmitly.ChannelProvider.Firebase

A Transmitly channel provider for sending push notifications with Firebase Cloud Messaging (FCM).

Installation

Install the package from NuGet:

dotnet add package Transmitly.ChannelProvider.Firebase

Quick Start

using Transmitly;
using Transmitly.Channel.Push;
using Transmitly.ChannelProvider.Firebase.Configuration;

var client = new CommunicationsClientBuilder()
	.AddFirebaseSupport(options =>
	{
		options.Credential = FirebaseCredential.FromFile("firebase-service-account.json");
		options.ProjectId = "your-firebase-project-id"; // optional when available via credential/environment
		options.AppName = "default"; // optional (default: "default")
	})
	.AddPipeline("welcome-push", pipeline =>
	{
		pipeline.AddPushNotification(push =>
		{
			push.Title.AddStringTemplate("Welcome!");
			push.Body.AddStringTemplate("Thanks for signing up.");
			push.ImageUrl.AddStringTemplate("https://transmit.ly/assets/welcome.png");
		});
	})
	.BuildClient();

var recipient = new PlatformIdentityAddress(
	"FCM_DEVICE_TOKEN",
	type: PlatformIdentityAddress.Types.DeviceToken());

var result = await client.DispatchAsync(
	"welcome-push",
	[recipient],
	TransactionModel.Create(new
	{
		userId = "12345",
		campaign = "welcome"
	}));

Firebase Admin Configuration Parameters

AddFirebaseSupport(options => ..., providerId) configures the Firebase Admin dispatcher.

FirebaseOptions parameters

Credential is required unless the runtime environment can resolve credentials via Application Default Credentials.

Recipients: Device Tokens and Topics

The push channel supports:

• Device token recipients (device-token)
• Topic recipients (push-topic)

Topic example:

var topicRecipient = new PlatformIdentityAddress(
	"order-updates",
	type: PlatformIdentityAddress.Types.Topic());

await client.DispatchAsync(
	"welcome-push",
	[topicRecipient],
	TransactionModel.Create(new { orderId = "A-1001" }));

Multiple Firebase Provider Instances

AddFirebaseSupport accepts an optional providerId, which is useful for multi-tenant or multi-project setups.

using Transmitly.ChannelProvider.Firebase.Configuration;

var client = new CommunicationsClientBuilder()
	.AddFirebaseSupport(options =>
	{
		options.Credential = FirebaseCredential.FromFile("tenant-a.json");
		options.AppName = "firebase-tenant-a";
	}, providerId: "tenant-a")
	.AddFirebaseSupport(options =>
	{
		options.Credential = FirebaseCredential.FromFile("tenant-b.json");
		options.AppName = "firebase-tenant-b";
	}, providerId: "tenant-b")
	.AddPipeline("otp", pipeline =>
	{
		pipeline.AddPushNotification(push =>
		{
			push.Title.AddStringTemplate("Your OTP");
			push.Body.AddStringTemplate("Code: {{code}}");
			push.AddChannelProviderFilter(Id.ChannelProvider.Firebase("tenant-a"));
		});
	})
	.BuildClient();

Notes

• Push title/body/image come from your AddPushNotification templates.
• The transactional content model is mapped into FCM Data values as strings where possible.
• For general pipeline/channel concepts, see the main Transmitly project.

Copyright (c) Code Impressions, LLC. This open-source project is sponsored and maintained by Code Impressions and is licensed under the Apache License, Version 2.0.