ricaun.Autodesk.Forge.Oss.DesignAutomation 1.0.8

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package ricaun.Autodesk.Forge.Oss.DesignAutomation --version 1.0.8
NuGet\Install-Package ricaun.Autodesk.Forge.Oss.DesignAutomation -Version 1.0.8
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="ricaun.Autodesk.Forge.Oss.DesignAutomation" Version="1.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ricaun.Autodesk.Forge.Oss.DesignAutomation --version 1.0.8
#r "nuget: ricaun.Autodesk.Forge.Oss.DesignAutomation, 1.0.8"
#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 ricaun.Autodesk.Forge.Oss.DesignAutomation as a Cake Addin
#addin nuget:?package=ricaun.Autodesk.Forge.Oss.DesignAutomation&version=1.0.8

// Install ricaun.Autodesk.Forge.Oss.DesignAutomation as a Cake Tool
#tool nuget:?package=ricaun.Autodesk.Forge.Oss.DesignAutomation&version=1.0.8

Autodesk.Forge.Oss.DesignAutomation

Visual Studio 2022 Nuke License MIT Build .NET 6.0 Release

PackageReference

<PackageReference Include="ricaun.Autodesk.Forge.Oss.DesignAutomation" Version="*" />

Requirements

Dependencies

Configuration

By default the Forge credentials could be defined with the following environment variables:

FORGE_CLIENT_ID=<your client id>
FORGE_CLIENT_SECRET=<your client secret>
Custom

You can define a custom header to be sent with each Design Automation requests to the Forge API. The custom header is only enabled if the engine is deprecated.

FORGE_CLIENT_CUSTOM_HEADER_VALUE=<your custom header>

The custom header follow pattern x-my-custom-header: engine value is {0}. (The value {0} is replaced with the engine+version.) The header gonna be x-my-custom-header and the value engine value is Autodesk.Revit+2023 when using the engine Autodesk.Revit+2023.

Samples

This repository contains each sample of the Autodesk Step-by-Step Tutorial.

API Reference

The package use the namespace Autodesk.Forge.Oss.DesignAutomation.

DesignAutomationService

DesignAutomationService class contain the methods to interact with the Oss and Design Automation API. Internaly uses the ParameterArgumentService to convert a class with Attributes to convert in the Activity and WorkItem to send the request to the Design Automation API.

MaxDesignAutomationService
IDesignAutomationService designAutomationService = new MaxDesignAutomationService("AppName")
{
	EngineVersions = new[] { "2021" },
};
AutoCADDesignAutomationService
IDesignAutomationService designAutomationService = new AutoCADDesignAutomationService("AppName")
{
	EngineVersions = new[] { "24" },
};
InventorDesignAutomationService
IDesignAutomationService designAutomationService = new InventorDesignAutomationService("AppName")
{
	EngineVersions = new[] { "2021" },
};
RevitDesignAutomationService
IDesignAutomationService designAutomationService = new RevitDesignAutomationService("AppName")
{
	EngineVersions = new[] { "2021" },
};

Initialize

Initialize AppBundle by creating and uploading the zip file to the Design Automation.

await designAutomationService.Initialize("Path/AppBundle.zip");

Run

Create the Activity and run the WorkItem and wait for the result, use the Parameters class to define the parameters of the Activity and WorkItem.

bool result = await designAutomationService.Run<Parameters>();
bool result = await designAutomationService.Run<Parameters>((parameters) => {});
Parameters parameters;
bool result = await designAutomationService.Run<Parameters>(parameters);

Delete

Delete all the resources created by the Initialize and Run. AppBundle and Activity gonna be deleted if exists.

await designAutomationService.Delete();

Parameters

The Parameters class is used to define the parameters of the Activity and WorkItem using the Attributes.

  • ParameterInputAttribute - Define the input parameter of the Activity and WorkItem.
  • ParameterOutputAttribute - Define the output parameter of the Activity and WorkItem.

ParameterInputAttribute

Base class ParameterActivityAttribute is used to update the Activity before send the request to the Design Automation API.

  • ParameterActivityClearBundleAttribute - Clear the AppBundle before update the Activity.
  • ParameterActivityInputArgumentAttribute - Define the input argument of the Activity.
  • ParameterActivityInputAttribute - Define the input parameter of the Activity.
  • ParameterActivityInputOpenAttribute - Define the input parameter of the Activity with Open file.
  • ParameterActivityLanguageAttribute - Define the language of the Activity.
  • ParameterActivityScriptAttribute - Define the script of the Activity.

ParameterWorkItemAttribute

Base class ParameterWorkItemAttribute is used to update the WorkItem before send the request to the Design Automation API.

  • ParameterWorkItemTimeSecAttribute - Define the timeout of the WorkItem.

License

This project is licensed under the MIT Licence.


Do you like this project? Please star this project on GitHub!

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
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.8 198 12/7/2023
1.0.7 110 10/4/2023
1.0.6 129 8/26/2023
1.0.5 158 8/9/2023
1.0.4 175 6/30/2023
1.0.3 144 6/17/2023
1.0.2 145 5/31/2023
1.0.1 132 5/31/2023
1.0.0 117 5/30/2023