FiftyOne.Pipeline.Engines 4.4.121

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package FiftyOne.Pipeline.Engines --version 4.4.121                
NuGet\Install-Package FiftyOne.Pipeline.Engines -Version 4.4.121                
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="FiftyOne.Pipeline.Engines" Version="4.4.121" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FiftyOne.Pipeline.Engines --version 4.4.121                
#r "nuget: FiftyOne.Pipeline.Engines, 4.4.121"                
#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 FiftyOne.Pipeline.Engines as a Cake Addin
#addin nuget:?package=FiftyOne.Pipeline.Engines&version=4.4.121

// Install FiftyOne.Pipeline.Engines as a Cake Tool
#tool nuget:?package=FiftyOne.Pipeline.Engines&version=4.4.121                

51Degrees Pipeline API

51Degrees Pipeline API

Developer Documentation | NuGet | Package | NuGet | Package | | --- | --- | --- | --- | | NuGet | CloudRequestEngine | NuGet | Examples.Shared | | NuGet | Core | NuGet | JavaScriptBuilder | | NuGet | Engines | NuGet | JsonBuilder | | NuGet | Engines.FiftyOne | NuGet | Web | | NuGet | Engines.TestHelpers | NuGet | Web.Shared |

Introduction

This repository contains all the projects required to build the .NET implementation of the Pipeline API. Individual engines (For example, device detection) are in separate repositories.

The specification is also available on GitHub and is recommended reading if you wish to understand the concepts and design of this API.

Dependencies

Visual Studio 2022 or later is recommended. Although Visual Studio Code can be used for working with most of the projects.

The Pipeline projects are written in C# and target .NET Standard 2.0.3 The Web integration multi-targets the following: - .NET Core 3.1 - .NET Core 6.0 - .NET Framework 4.6.2

The tested versions page shows the .NET versions that we currently test against. The software may run fine against other versions, but additional caution should be applied.

Solutions and projects

  • FiftyOne.Pipeline - The core projects that comprise the Pipeline API.
    • FiftyOne.Pipeline.Core - The core Pipeline classes such as Pipeline, FlowData, FlowElement and Evidence.
    • FiftyOne.Pipeline.Engines - Functionality for AspectEngines, a specialized FlowElement with additional features.
    • FiftyOne.Pipeline.Engines.FiftyOne - Functionality that is specific to 51Degrees aspect engines.
  • FiftyOne.Pipeline.Web - Projects that are relevant to the Pipeline API ASP.NET integration.
    • FiftyOne.Pipeline.Web - ASP.NET Core integration.
    • FiftyOne.Pipeline.Web.Framework - ASP.NET Framework integration.
    • FiftyOne.Pipeline.Web.Minify - FlowElement which takes the JavaScript function from the JavaScriptBundler element and minifies it.
    • FiftyOne.Pipeline.Web.Shared - Shared code that is used by both Core and Framework ASP.NET integrations.
  • FiftyOne.Pipeline.Elements - Projects for various common Flow Elements that are used by multiple other solutions.
    • FiftyOne.Pipeline.JavaScriptBuilder - An element that packages values from all 'JavaScript' properties from all engines into a single JavaScript function.
    • FiftyOne.Pipeline.JsonBuilder - An element that serializes all properties from all engines into JSON format.
  • FiftyOne.CloudRequestEngine - Projects related to making general requests to the 51Degrees cloud.
    • FiftyOne.Pipeline.CloudRequestEngine - An engine that makes requests to the 51Degrees cloud service.

Installation

You can either clone this repository and reference the projects locally or you can reference the NuGet packages directly.

Install-Package FiftyOne.Pipeline.Core
Install-Package FiftyOne.Pipeline.Engines
Install-Package FiftyOne.Pipeline.Engines.FiftyOne
Install-Package FiftyOne.Pipeline.Web
Install-Package FiftyOne.Pipeline.Web.Minify
Install-Package FiftyOne.Pipeline.JsonBuilder
Install-Package FiftyOne.Pipeline.JavaScriptBuilder
Install-Package FiftyOne.Pipeline.CloudRequestEngine

Note that the packages have dependencies on each other so you'll never need to install all of them individually. For example, Installing FiftyOne.Pipeline.Engines.FiftyOne will automatically add FiftyOne.Pipeline.Engines and FiftyOne.Pipeline.Core.

Examples

Pipeline Examples

There are several examples available that demonstrate how to make use of the Pipeline API in isolation. These are described in the table below. If you want examples that demonstrate how to use 51Degrees products such as device detection, then these are available in the corresponding repository and on our website.

Example Description
CustomFlowElement\1. Simple Flow Element Shows how to create a custom flow element that returns star sign based on a supplied date of birth.
CustomFlowElement\2. On Premise Engine Shows how to modify SimpleFlowElement to make use of the 'engine' functionality and use a custom data file to map dates to star signs rather than relying on hard coded data.
CustomFlowElement\3. Client-side evidence Shows how to modify SimpleFlowElement to request the data of birth from the user using client-side JavaScript.
CustomFlowElement\4. Cloud Engine Shows how to modify SimpleFlowElement to perform the star sign lookup via a cloud service rather than locally.
ResultCaching Shows how the result caching feature works.
UsageSharing Shows how to share usage with 51Degrees. This helps us to keep our products up to date and accurate.

Tests

  • FiftyOne.Pipeline.CloudRequestEngine.Tests - Tests for the CloudRequestEngine and builder.
  • FiftyOne.Pipeline.Core.Tests - Tests for FlowElement and FlowData base classes.
  • FiftyOne.Pipeline.Engines.Tests - Tests for AspectEngines and AspectData base classes.
  • FiftyOne.Pipeline.Engines.FiftyOne.Tests - Tests for 51Degrees specific aspect engines.
  • FiftyOne.Pipeline.Examples.Tests - Tests for developer examples. This will automatically run all the examples and ensure they do not crash.
  • FiftyOne.Pipeline.Web.Tests - Tests for web integration functionality.

The tests can be run from within Visual Studio or (in most cases) by using the dotnet test command line tool.

Project documentation

For complete documentation on the Pipeline API and associated engines, see the 51Degrees documentation site.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on FiftyOne.Pipeline.Engines:

Package Downloads
FiftyOne.Pipeline.Engines.FiftyOne

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. This package contains base classes that provide functionality used by 51Degrees engines.

FiftyOne.Pipeline.CloudRequestEngine

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. This package contains a shared engine that is used to make requests to the 51Degrees cloud service on behalf of other data services such as device detection or location.

FiftyOne.Pipeline.JavaScriptBuilder

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. This package contains an element that produces JavaScript code that can be used to access Pipeline results in client-side code and provide additional evidence that is not available from the initial request to the web server.

FiftyOne.Pipeline.Web.Shared

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. The package contains shared functionality that is needed by both the ASP.NET Core and ASP.NET integrations.

FiftyOne.Pipeline.Engines.TestHelpers

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. The package contains helper classes to make writing unit tests easier when developing a custom engine using FiftyOne.Pipeline.Engines.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0-alpha.1 39 12/23/2024
4.4.121 1,870 12/17/2024
4.4.121-alpha.15 45 12/18/2024
4.4.121-alpha.6 37 12/18/2024
4.4.120 280 12/17/2024
4.4.119 1,073 12/12/2024
4.4.119-alpha.3 33 12/17/2024
4.4.118 527 12/9/2024
4.4.117 727 12/5/2024
4.4.116 1,637 12/2/2024
4.4.115 1,686 12/1/2024
4.4.114 924 11/26/2024
4.4.113 415 11/25/2024
4.4.112 325 11/25/2024
4.4.111 1,541 11/13/2024
4.4.110 997 11/11/2024
4.4.109 855 11/8/2024
4.4.108 780 11/5/2024
4.4.107 2,531 10/17/2024
4.4.106 379 10/16/2024
4.4.105 628 10/15/2024
4.4.104 1,790 10/9/2024
4.4.103 2,311 9/30/2024
4.4.102 2,458 9/9/2024
4.4.101 1,095 9/6/2024
4.4.100 1,257 9/4/2024
4.4.99 716 9/3/2024
4.4.98 812 8/30/2024
4.4.97 758 8/29/2024
4.4.96 2,058 8/14/2024
4.4.95 2,552 8/2/2024
4.4.94 4,132 7/10/2024
4.4.93 1,193 7/6/2024
4.4.92 1,586 6/26/2024
4.4.90 2,636 6/14/2024
4.4.89 385 6/14/2024
4.4.88 2,049 5/31/2024
4.4.87 2,442 5/29/2024
4.4.86 689 5/28/2024
4.4.85 4,604 5/16/2024
4.4.84 669 5/15/2024
4.4.83 2,723 5/7/2024
4.4.82 2,724 4/23/2024
4.4.81 1,523 4/19/2024
4.4.80 446 4/19/2024
4.4.79 420 4/17/2024
4.4.78 500 4/17/2024
4.4.77 414 4/17/2024
4.4.76 390 4/17/2024
4.4.75 735 4/16/2024
4.4.74 9,630 3/17/2024
4.4.73 805 3/16/2024
4.4.72 2,487 2/21/2024
4.4.71 1,576 2/15/2024
4.4.70 989 2/14/2024
4.4.69 430 2/14/2024
4.4.68 2,636 2/1/2024
4.4.67 1,330 1/31/2024
4.4.66 3,076 1/27/2024
4.4.65 1,008 1/26/2024
4.4.64 2,152 1/17/2024
4.4.63 1,702 1/13/2024
4.4.62 1,514 1/11/2024
4.4.61 1,095 1/10/2024
4.4.60 1,706 1/6/2024
4.4.59 3,276 12/7/2023
4.4.58 1,391 12/2/2023
4.4.57 1,783 11/29/2023
4.4.56 1,693 11/25/2023
4.4.55 1,290 11/23/2023
4.4.54 528 11/23/2023
4.4.53 2,335 11/17/2023
4.4.52 679 11/15/2023
4.4.51 743 11/9/2023
4.4.50 1,542 11/3/2023
4.4.49 1,100 11/2/2023
4.4.48 2,105 10/28/2023
4.4.47 1,007 10/27/2023
4.4.46 1,487 10/25/2023
4.4.45 1,012 10/20/2023
4.4.44 4,692 10/11/2023
4.4.43 576 10/10/2023
4.4.42 587 10/7/2023
4.4.41 4,203 9/23/2023
4.4.40 1,391 9/20/2023
4.4.39 2,208 9/16/2023
4.4.38 1,104 9/15/2023
4.4.37 1,626 9/13/2023
4.4.36 1,679 9/11/2023
4.4.35 1,325 9/9/2023
4.4.34 1,202 9/8/2023
4.4.33 1,964 9/2/2023
4.4.32 1,412 8/31/2023
4.4.31 597 8/30/2023
4.4.30 2,026 8/9/2023
4.4.29 3,998 8/6/2023
4.4.28 1,337 8/4/2023
4.4.27 10,833 7/13/2023
4.4.26 2,935 7/4/2023
4.4.25 2,003 7/2/2023
4.4.24 6,965 6/18/2023
4.4.23 2,601 6/12/2023
4.4.22 1,156 6/11/2023
4.4.21 2,068 6/9/2023
4.4.20 2,594 6/7/2023
4.4.19 5,699 6/4/2023
4.4.18 894 6/2/2023
4.4.17 865 6/2/2023
4.4.16 886 6/1/2023
4.4.15 24,728 3/24/2023
4.4.14 3,676 3/20/2023
4.4.13 8,112 3/10/2023
4.4.11 5,484 2/15/2023
4.4.10 6,642 2/1/2023
4.4.9 3,033 1/18/2023
4.4.8 5,274 12/7/2022
4.4.7 9,554 8/30/2022
4.4.6 6,949 7/27/2022
4.4.5 3,651 7/13/2022
4.4.4 235,333 6/29/2022
4.4.3 4,193 6/22/2022
4.4.2 6,698 5/25/2022
4.4.1 7,219 4/27/2022
4.4.0 8,170 4/7/2022
4.3.17 8,320 3/31/2022
4.3.16 3,469 3/16/2022
4.3.15 11,483 1/25/2022
4.3.14 16,838 12/22/2021
4.3.13 3,164 12/15/2021
4.3.11 3,072 12/1/2021
4.3.10 1,655 11/22/2021
4.3.9 2,748 11/17/2021
4.3.7 5,250 10/6/2021
4.3.3 1,437 9/15/2021
4.3.2 775 8/17/2021
4.3.1 247 8/3/2021
4.3.0 2,354 6/16/2021
4.2.3 3,792 5/8/2021
4.2.1 403 2/1/2021
4.2.0 5,142 1/6/2021
4.1.11 1,709 9/7/2020
4.1.10 3,347 8/10/2020
4.1.4 706 6/29/2020
4.1.3 2,805 5/29/2020
4.1.0-beta.46 312 3/5/2020
4.1.0-beta.44 254 3/4/2020
4.1.0-beta.39 239 2/18/2020
4.1.0-beta.38 271 2/18/2020
4.1.0-beta.36 268 2/18/2020
4.1.0-beta.34 256 2/17/2020
4.1.0-beta.33 264 2/13/2020
4.1.0-beta.25 271 1/17/2020
4.1.0-beta.22 288 1/7/2020
4.1.0-beta.21 344 1/7/2020