The examples provided demonstrate how to use the 51Degrees device detection in both cloud-based and on-premise environments. They showcase different aspects of device detection, including retrieving device details based on User-Agent and User-Agent Client Hints HTTP header values, accessing meta-data, performing TAC and native model lookups, viewing match metrics, offline processing, and performance optimization. These examples serve as practical guides for developers to understand and implement device detection capabilities within their applications.
A resource key configured with the properties needed to run most of the examples can be obtained here. To use the resource key in the example it can be supplied as an environment variable called "SUPER_RESOURCE_KEY".
Some cloud examples require an enhanced resource key containing a license key. And some on-premise examples require you to provide a license key. You can find out about resource keys and license keys at our pricing page.
A common use case is to make a change to the Pipeline logic in device-detection-dotnet and then use these examples to observe the results of the change.
By default, the examples are configured to use the packages from nuget feed. In order to produce and use local packages instead:
- Clone and make your changes to device-detection-dotnet
- Create and install the packages to the local nuget feed
dotnet pack [Project] -o "[PackagesFolder]" /p:PackageVersion=0.0.0 -c [Configuration] /p:Platform=[Architecture]dotnet nuget push "[PackagesFolder]/*.nupkg" -s LocalFeed - Update the version of the device-detection-dotnet in the examples project:
dotnet add package "FiftyOne.DeviceDetection" --version 0.0.0 --source LocalFeed
The same principle can be applied to incorporate changes in pipeline-dotnet if needed.
The tables below describe the examples available in this repository.
| Example | Description |
|---|---|
| GettingStarted-Console | How to use the 51Degrees Cloud service to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values. |
| GettingStarted-Web | How to use the 51Degrees Cloud service to determine details about a device as part of a simple ASP.NET website. |
| GettingStarted-Web-ClientOnly | A simple ASP.NET website used for integration testing with cloud services. Defaults to using cloud.51degrees.com as the cloud end point. |
| Metadata | How to access the meta-data that relates to things like the properties populated device detection |
| TacLookup | How to get device details from a TAC (Type Allocation Code) using the 51Degrees cloud service. |
| NativeModelLookup | How to get device details from a native model name using the 51Degrees cloud service. |
| GetAllProperties | How to iterate through all properties available in the cloud response. |
| ClientHints | Legacy example. Retained for the associated automated tests. See GettingStarted-Web instead. |
| ClientHints Not Integrated | Legacy example. Our ASP.NET integration will automatically set the Accept-CH header that is used to request User-Agent Client Hints headers.This example demonstrates how to do this without using the integration component. |
| Framework-Web | How to use the 51Degrees Cloud service to determine details about a device as part of a simple ASP Framework website using System.Web. |
| Example | Description |
|---|---|
| GettingStarted-Console | How to use the 51Degrees on-premise device detection API to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values. |
| GettingStarted-Web | How to use the 51Degrees on-premise service to determine details about a device as part of a simple ASP.NET website. |
| Metadata-Console | How to access the meta-data that relates to things like the properties populated device detection |
| OfflineProcessing-Console | Example showing how to ingest a file containing data from web requests and perform detection against the entries. |
| Performance-Console | How to configure the various performance options and run a simple performance test. |
| UpdateDataFile—Console | How to configure the Pipeline to automatically update the device detection data file on startup. |
| MatchMetrics-Console | How to retrieve meta data concerning properties and values from the data file. |
| ClientHints | Legacy example. Retained for the associated automated tests. See GettingStarted-Web instead. |
| ClientHints Not Integrated | Legacy example. Our ASP.NET integration will automatically set the Accept-CH header that is used to request User-Agent Client Hints headers. This example demonstrates how to do this without using the integration component. |
| Framework-Web | How to use the 51Degrees on-premise service to determine details about a device as part of a simple ASP Framework website using System.Web. |
| AppleServerSideConfig - Console | How to use the 51Degrees on-premise, Apple detection service to resolve device details based on the User-Agent and required Apple detection evidence. This example sets up the configuration using a configuration file. |
| | AppleServerSide - Console | How to use the 51Degrees on-premise Apple detection service to resolve device details based on the User-Agent and required Apple detection evidence. This example sets the confihuration in code. |