TaskPlanning.Client 1.0.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package TaskPlanning.Client --version 1.0.0
                    


                    

                
NuGet\Install-Package TaskPlanning.Client -Version 1.0.0
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="TaskPlanning.Client" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="TaskPlanning.Client" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="TaskPlanning.Client" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add TaskPlanning.Client --version 1.0.0
                    


                    

                
#r "nuget: TaskPlanning.Client, 1.0.0"
#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. 
#:package TaskPlanning.Client@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=TaskPlanning.Client&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=TaskPlanning.Client&version=1.0.0
                    


                            Install as a Cake Tool

You can use this library to access taskplanningapi.com's scheduling API from .Net environments.

Basic usage

TaskPlanningClient

//Use your private access key to create instance of the TaskPlanningClient
var accessKey = "YourAccessKey";
var client = TaskPlanningClient.Create(accessKey);

//Create a planning request
var request = new PlanningRequest(); //More on this later

//Pass request to the Plan method and await the PlanningTask result.
PlanningTask planning = await client.Plan(request);

PlanningRequest

PlanningTask

The PlanningTask data structure will contain information about the execution of your planning request. When the request is fully completed the status becomes Success.

public class PlanningTask
{
    public virtual Guid Id { get; set; }
    public virtual TimeSpan? Duration { get; set; }
    public virtual Planning Planning { get; set; }
    public virtual int Progress { get; set; }
    public virtual Exception Exception { get; set; }
    public virtual PlanningTaskStatus Status { get; set; }
}

PlanningTaskStatus enum

The PlanningTaskStatus enum contains the various stages a planning request job can have. Some of them are for internal use because this library handles status polling for you. You should only encounter Success, Error and if you make use of cancellation tokens you can also expect Canceled.

public enum PlanningTaskStatus
{
    Running = 0,
    Success = 1,
    Canceled = 2,
    Queued = 3,
    Error = 99
}
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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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

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.0.6 773 5/25/2020
1.0.5 625 4/2/2020
1.0.4 590 3/30/2020
1.0.3 618 3/12/2020
1.0.2 611 3/12/2020
1.0.1 617 3/12/2020
1.0.0 642 3/9/2020