azure-notificationhubs-xamarin
所属分类：android开发
开发工具：C#
文件大小：0KB
下载次数：0
上传日期：2023-02-07 13:01:06
上 传 者：
sh-1993
说明： Xamarin表单的Azure通知中心示例
(Azure Notification Hubs Sample for Xamarin Forms)
文件列表:
CODE_OF_CONDUCT.md (444, 2022-01-13)
LICENSE (1141, 2022-01-13)
NuGet.config (176, 2022-01-13)
SECURITY.md (2765, 2022-01-13)
azure-pipelines.yml (8624, 2022-01-13)
samples/ (0, 2022-01-13)
samples/NotificationHubSample.Android/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Assets/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Assets/AboutAssets.txt (625, 2022-01-13)
samples/NotificationHubSample.Android/MainActivity.cs (1238, 2022-01-13)
samples/NotificationHubSample.Android/NotificationHubSample.Android.csproj (5416, 2022-01-13)
samples/NotificationHubSample.Android/Properties/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Properties/AndroidManifest.xml (474, 2022-01-13)
samples/NotificationHubSample.Android/Properties/AssemblyInfo.cs (1144, 2022-01-13)
samples/NotificationHubSample.Android/Resources/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Resources/AboutResources.txt (1772, 2022-01-13)
samples/NotificationHubSample.Android/Resources/Resource.designer.cs (5805, 2022-01-13)
samples/NotificationHubSample.Android/Resources/layout/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Resources/layout/Tabbar.xml (485, 2022-01-13)
samples/NotificationHubSample.Android/Resources/layout/Toolbar.xml (392, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-anydpi-v26/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-anydpi-v26/icon.xml (261, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-anydpi-v26/icon_round.xml (261, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-hdpi/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-hdpi/icon.png (4754, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-hdpi/launcher_foreground.png (11695, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-mdpi/ (0, 2022-01-13)
samples/NotificationHubSample.Android/Resources/mipmap-mdpi/icon.png (2807, 2022-01-13)
... ...
[](https://dev.azure.com/devdiv/DevDiv/_build/latest?definitionId=13458&repoName=Azure%2Fazure-notificationhubs-xamarin&branchName=main)
# Azure Notification Hubs for Xamarin
This repository contains the Azure Notification Hubs sample library and sample application for Xamarin Forms, Xamarin for Apple (Xamarin.iOS, Xamarin.TVOS, Xamarin.Mac) and Xamarin.Android. This sample project creates a unified wrapper over the [AzureMessaging Xamarin Components](https://github.com/xamarin/XamarinComponents/tree/master/XPlat/AzureMessaging) for both iOS and Android with a Forms app as well as native applications.
This repository is set into sections:
- [Xamarin Forms](#getting-started-with-xamarinforms)
- [Xamarin Apple](#getting-started-with-xamarin-for-apple)
- [Xamarin.Android](#getting-started-with-xamarinandroid)
This repository also contains samples which can be found in the [samples](samples/README.md) along with a description of each.
## Getting Started with Xamarin.Forms
This project contains `Microsoft.Azure.NotificationHubs.Client`, which when added to your project, provides a consistent experience across Xamarin Android and Xamarin for Apple. You can use this project by cloning the source locally or using NuGet via GitHub.
```bash
dotnet add PROJECT package Microsoft.Azure.NotificationHubs.Client --version 1.0.0
```
Once you have referenced either the source code or NuGet, you can add the project to your main Xamarin Forms project as well as the Android and Apple specific projects.
Initializing the Azure Notification Hubs sample can be done by importing the namespace from the sample.
```csharp
using Microsoft.Azure.NotificationHubs.Client;
```
And then in the start of your application, for example in your MainPage.xaml, you can initialize the `NotificationHub` class with the hub name and access policy connection string, referencing them for example from a constants file or some other configuration settings.
```csharp
// Start the API
NotificationHub.Start(Constants.ConnectionString, Constants.HubName);
```
You can then listen for push notifications in your application by adding an event handler to the `NotificationMessageReceived` event.
```csharp
// Add an event handler
NotificationHub.NotificationMessageReceived += OnNotificationMessageReceived;
// The handler
private void OnNotificationMessageReceived(object sender, NotificationMessageReceivedEventArgs e)
{
// Do something with the message
Console.WriteLine($"Title: {e.Title}");
Console.WriteLine($"Body: {e.Body}");
}
```
The API automatically handles using the Installation API for you once you have called the `NotificationHub.Start` method. You may want indiciations that either the installation was successfully saved or failed to save, and to cover those scenarios, we have the `InstallationSaved` and `InstallationSaveFailed` events that you can add handlers to. The `InstallationSaved` event will give you back the `Installation` that was saved, and the `InstallationSaveFailed` will give you back an `Exception` from the process.
```csharp
// Add handlers for installation managements
NotificationHub.InstallationSaved += OnInstallatedSaved;
NotificationHub.InstallationSaveFailed += OnInstallationSaveFailed;
private void OnInstallatedSaved(object sender, InstallationSavedEventArgs e)
{
Console.WriteLine($"Installation ID: {e.Installation.InstallationId} saved successfully");
}
private void OnInstallationSaveFailed(object sender, InstallationSaveFailedEventArgs e)
{
Console.WriteLine($"Failed to save installation: {e.Exception.Message}");
}
```
In the case of failure, you can try the process of saving the installation again by calling the `NotificationHub.SaveInstallation()` method, but this should be only called in case the installation process has failed.
### Tag Management for Xamarin.Forms
One of the ways to target a device or set of devices is through the use of [tags](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-tags-segment-push-message#tags), where you can target a specific tag, or a tag expression. The SDK handles this through top level methods that allow you to add, clear, remove and get all tags for the current installation. In this example, we can add some recommended tags such as the app language preference, and device country code.
```csharp
var language = System.Globalization.CultureInfo.CurrentUICulture.TwoLetterISOLanguageName;
var country = System.Globalization.RegionInfo.CurrentRegion.TwoLetterISORegionName;
var languageTag = $"language_{langauge}";
var countryTag = $"country_{country}";
NotificationHub.AddTags(new [] { languageTag, countryTag });
```
### Template Management for Xamarin.Forms
With [Azure Notification Hub Templates](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-templates-cross-platform-push-messages), you can enable a client application to specify the exact format of the notifications it wants to receive. This is useful when you want to create a more personalized notification, with string replacement to fill the values. The Installation API [allows multiple templates](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-push-notification-registration-management#templates) for each installation which gives you greater power to target your users with rich messages.
For example, we can create a template with a body, some headers, and some tags.
```csharp
var language = System.Globalization.CultureInfo.CurrentUICulture.TwoLetterISOLanguageName;
var country = System.Globalization.RegionInfo.CurrentRegion.TwoLetterISORegionName;
var languageTag = $"language_{language}";
var countryTag = $"country_{country}";
var body = "{\"aps\": {\"alert\": \"$(message)\"}}";
var template = new InstallationTemplate();
template.Body = body;
template.Tags = new List
{ languageTag, countryCodeTag };
NotificationHub.SetTemplate("template1", template);
```
### Push to User Management for Xamarin.Forms
The SDK supports the ability to associate a user with an installation. This allows you to be able to target all devices associated with a particular User ID. The user's identity set through the SDK can be whatever the developer wants it to be: the user's name, email address, phone number, or some other unique identifier. This is supported through the `NotificationHub` and the `UserId` property.
```csharp
var userId = "iosUser123"
NotificationHub.UserId = userId;
// Get the user ID
Console.WriteLine($"User ID: {NotificationHub.UserId}");
```
### Enriching Installations for Xamarin.Forms
The SDK will update the installation on the device any time you change its properties such as adding a tag or adding an installation template. Before the installation is sent to the backend, you can intercept this installation to modify anything before it goes to the backend, for example, if you wish to add or modify tags. This is implemented in the `IInstallationEnrichmentAdapter` interface with a single method of `EnrichInstallation`.
```csharp
NotificationHub.SetInstallationEnrichmentAdapter(new InstallationEnrichmentAdapter());
public class InstallationEnrichmentAdapter : IInstallationEnrichmentAdapter
{
public override void EnrichInstallation(Installation installation)
{
installation.Tags.Add("platform_XamarinForms");
}
}
```
### Saving Installations to a Custom Backend
The Azure Notification Hubs SDK will save the installation to our backend by default. If, however, you wish to skip our backend and store it on your backend, we support that through the `IInstallationManagementAdapter` interface. This has a method to save the installation `SaveInstallation`, passing in the installation, and then a completion for success, or for errors. Instead of starting the API with the `Start` method with the hub name and connection string, we start with our installation adapter.
```csharp
// Set the installation management delegate
Notification.Start(new InstallationManagementAdapter());
public class InstallationManagementDelegate : IInstallationManagementAdapter
{
void SaveInstallation(Installation installation, Action onSuccess, Action onError);
{
// Save the installation to your own backend
// Finish with a completion with error if one occurred, else null
onSuccess(installation);
}
}
```
### Extending the Xamarin Forms Example
This sample is meant to be a starting point for wrapping the Azure Notification Hubs Xamarin Components. Extending the capabilities for each platform, Apple and Android, can be done in files that end with `.ios.cs` or `.android.cs` depending on the platform. Extending shared pieces of code can be added by adding files ending with the `.shared.cs` extension. If you need platform specific code for your Xamarin Forms iOS or Android projects, you can reference the `NotificationHub` class which will reference the appropriate platform.
## Getting Started with Xamarin for Apple
The Azure Notification Hubs for Xamarin for Apple (Xamarin.iOS, Xamarin.TVOS, Xamarin.Mac) is supported as part of the [Xamarin Components](https://github.com/xamarin/XamarinComponents) repository in the [AzureMessaging](https://github.com/xamarin/XamarinComponents/tree/master/XPlat/AzureMessaging) folder. This provides the `Xamarin.Azure.NotificationHubs.iOS` NuGet package which can be added to your Xamarin Apple project.
Initializing the Azure Notification Hubs for Xamarin Apple can be done by importing the `WindowsAzure.Messaging.NotificationHubs` namespace from the package. **Note there are other classes under the `WindowsAzure.Messaging` that are still available and supported such as `SBNotificationHub` but are discouraged.**
```csharp
using WindowsAzure.Messaging.NotificationHubs;
```
And then in the start of your application, for example in your AppDelegate.cs, you can initialize the `MSNotificationHub` class with the hub name and access policy connection string, referencing them for example from a constants file or some other configuration settings.
```csharp
// Start the API
MSNotificationHub.Start(Constants.ConnectionString, Constants.HubName);
```
You can then listen for push notifications in your application by extending the `MSNotificationHubDelegate` class and implementing the abstract `DidReceivePushNotification` method.
```csharp
// Set the delegate for receiving messages
MSNotificationHub.SetDelegate(new NotificationDelegate());
// The notification delegate implementation
public class NotificationDelegate : MSNotificationHubDelegate
{
public override void DidReceivePushNotification(MSNotificationHub notificationHub, MSNotificationHubMessage message)
{
if (UIApplication.SharedApplication.ApplicationState == UIApplicationState.Background)
{
Console.WriteLine($"Message received in the background with title {message.Title} and body {message.Body}");
}
else
{
Console.WriteLine($"Message received in the foreground with title {message.Title} and body {message.Body}");
}
}
}
```
### Tag Management for Xamarin for Apple
One of the ways to target a device or set of devices is through the use of [tags](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-tags-segment-push-message#tags), where you can target a specific tag, or a tag expression. The SDK handles this through top level methods that allow you to add, clear, remove and get all tags for the current installation. In this example, we can add some recommended tags such as the app language preference, and device country code.
```csharp
var language = NSBundle.MainBundle.PreferredLocalizations[0];
var countryCode = NSLocale.CurrentLocale.CountryCode;
var languageTag = $"language_{language}";
var countryCodeTag = $"country_{countryCode}";
MSNotificationHub.AddTag(languageTag);
MSNotificationHub.AddTag(countryCodeTag);
```
### Template Management for Xamarin for Apple
With [Azure Notification Hub Templates](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-templates-cross-platform-push-messages), you can enable a client application to specify the exact format of the notifications it wants to receive. This is useful when you want to create a more personalized notification, with string replacement to fill the values. The Installation API [allows multiple templates](https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-push-notification-registration-management#templates) for each installation which gives you greater power to target your users with rich messages.
For example, we can create a template with a body, some headers, and some tags.
```csharp
var language = NSBundle.MainBundle.PreferredLocalizations[0];
var countryCode = NSLocale.CurrentLocale.CountryCode;
var languageTag = $"language_{language}";
var countryCodeTag = $"country_{countryCode}";
var body = "{\"aps\": {\"alert\": \"$(message)\"}}";
var template = new MSInstallationTemplate();
template.Body = body;
template.AddTag(languageTag);
template.AddTag(countryCodeTag);
MSNotificationHub.SetTemplate(template, key: "template1");
```
### Push to User Management Xamarin for Apple
The SDK supports the ability to associate a user with an installation. This allows you to be able to target all devices associated with a particular User ID. The user's identity set through the SDK can be whatever the developer wants it to be: the user's name, email address, phone number, or some other unique identifier. This is supported through the `MSNotificationHub` and the `GetUserId` and `SetUserId` methods.
```csharp
var userId = "iosUser123"
MSNotificationHub.SetUserId(userId);
// Get the user ID
Console.WriteLine($"User ID: {NotificationHub.GetUserId()}");
```
### Intercepting Installation Management for Xamarin for Apple
The SDK will handle saving the installation for you, however, we provide hooks where you can intercept both the successful installation or any failure through the `MSInstallationLifecycleDelegate` abstract class. This has two methods, `DidSaveInstallation` for successful saves, and `DidFailToSaveInstallation` for any failures. We can implement this to have our own logging for example.
```csharp
// Set a listener for lifecycle management
MSNotificationHub.SetLifecycleDelegate(new InstallationLifecycleDelegate());
public class InstallationLifecycleDelegate : MSInstallationLifecycleDelegate
{
public override void DidFailToSaveInstallation(MSNotificationHub notificationHub, MSInstallation installation, NSError error)
{
Console.WriteLine($"Save installation failed with exception: {error.LocalizedDescription}");
}
public override void DidSaveInstallation(MSNotificationHub notificationHub, MSInstallation installation)
{
Console.WriteLine($"Installation successfully saved with Installation ID: {installation.InstallationId}");
}
}
```
### Enriching Installations for Xamarin for Apple
The SDK will update the installation on the device any time you change its properties such as adding a tag or adding an installation template. Before the installation is sent to the backend, you can intercept this installation to modify anything before it goes to the backend, for example, if you wish to add or modify tags. This is implemented in the `MSInstallationEnrichmentDelegate` abstract base class with a single method of `WillEnrichInstallation`.
```csharp
// Set a dele3gate for enriching installations
MSNotificationHub.SetEnrichmentDelegate(new InstallationEnrichmentDelegate());
public class InstallationEnrichmentDelegate : MSInstallationEnrichmentDelegate
{
public override void WillEnrichInstallation(MSNotificationHub notificationHub, MSInstallation installation)
{
installation.AddTag("platform_XamariniOS");
}
}
```
### Saving Installations to a Custom Backend for Xamarin for Apple
The Azure Notification Hubs SDK will save the installation to our backend by default. If, however, you wish to skip our backend and store it on your backend, we support that through the `MSInstallationManagementDelegate` protocol. This has a method to save the installation `WillUpsertInstallation`, passing in the installation, and then a completion handler is called with either an error if unsuccessful, or nil if successful. Instead of starting the API with the `Start` method, we use the `StartWithInstallationManagement` which sets the installation manager.
```csharp
// Set the installation management delegate
MSNotificationHub.StartWithInstallationManagement(new InstallationManagementDelegate());
public class InstallationManagementDelegate : MSInstallationManagementDelegate
{
public override void WillUpsertInstallation(MSNotificationHub notificationHub, MSInstallation installation, NullableCompletionHandler completionHandler)
{
// Save the installation to your own backend
// Finish with a completion with error if one occurred, else null
completionHandler(null);
}
}
```
### Disabling Automatic Swizzling for Xamarin for Apple
By default, the SDK will swizzle methods to automatically intercept calls to `UIApplicationDelegate`/`NSApplicationDelegate` for calls to registering and intercepting push notifications, as well as `UNUserNotificationCenterDelegate` methods.
#### Disabling UIApplicationDelegate/NSApplicationDelegate
1. Open the project's Info.plist
2. Add the `NHAppDelegateForwarderEnabled` key and set the value to 0. This disables the UIApplicationDelegate/NSApplicationDelegate auto-forwarding to MSNotificaitonHub.
3. Implement the `MSApplicationDelegate`/`NSApplicationDelegate` methods for push notifications.
Implement the `RegisteredForRemoteNotifications` callback and the `FailedToRegisterForRemoteNotifications` callback in your AppDelegate to register for Push notifications.
```csharp
public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
{
MSNotificationHub.DidRegisterForRemoteNotifications(deviceToken);
}
public override void FailedToRegisterForRemoteNotifications(UIApplication application, NSError error)
{
MSNotificationHub.DidFailToRegisterForRemoteNotifications(error);
}
```
4. Implement the callback to receive push notifications
Override the `DidReceiveRemoteNotification` method to forward push notifications to MSNotificationHub.
```csharp
public override void DidReceiveRemoteNotification(UIApplication application, NSDictionary userInfo, System.Action completionHandler)
{
// Forward to MSNotificationHub
MSNotificationHub.DidReceiveRemoteNotification(userInfo);
// Complete handling the notification
completionHandler(UIBackgroundFetchResult.NoData);
}
```
#### Disabling UNUserNotificationCenterDelegate
1. Open the project's Info.plist
2. Add the `NHUserNotificationCenterDelegateForwarderEnabled` key and set the value to 0. This disables the UNUserNotificationCenterDelegate auto-forwarding to MSNotificaitonHub.
3. Implement UNUserNotificationCenterDelegate callbacks and pass the notification's payload to `MSNotificationHub`.
```csharp
public override void WillPresentNotification (UNUserNotificationCenter center, UNNotification notification, Action
近期下载者：
相关文件：
收藏者：