Class AdapterServices

Services related to adapters

Inheritance

Object

AdapterServices

Namespace: Unity.Industrial.Forma.Editor.Adapters

Syntax

public class AdapterServices : object

Methods

CanImport(String, List<String>)

Determines whether this instance can import the specified path.

Declaration

public static bool CanImport(string path, List<string> extensions)

Parameters

Type	Name	Description
String	path
List<String>	extensions

Returns

Type	Description
Boolean

CanImport(String, String)

Determines whether this instance can import the specified path.

Declaration

public static bool CanImport(string path, string extension)

Parameters

Type	Name	Description
String	path	The path.
String	extension

Returns

Type	Description
Boolean	true if this instance can import the specified path; otherwise, false.

CreateAdapter(String, String)

Create a new adapter asset

Declaration

public static FormaAdapter CreateAdapter(string targetFolder, string name)

Parameters

Type	Name	Description
String	targetFolder
String	name

Returns

Type	Description
FormaAdapter

CreateAdapterAsset(String, String)

Create a new adapter asset

Declaration

public static FormaAdapter CreateAdapterAsset(string targetFolder, string name)

Parameters

Type	Name	Description
String	targetFolder
String	name

Returns

Type	Description
FormaAdapter

CreateAdapterPackage(String, String)

Create a new adapter package

Declaration

public static void CreateAdapterPackage(string name = null, string displayName = "Custom")

Parameters

Type	Name	Description
String	name
String	displayName

CreateCustomEngine(FormaAdapter, String, String, String)

Create a custom engine

Declaration

public static void CreateCustomEngine(FormaAdapter adapter, string engineName, string typename, string targetFolder)

Parameters

Type	Name	Description
FormaAdapter	adapter
String	engineName
String	typename
String	targetFolder

CreateCustomEngineWithCheck(FormaAdapter, String, String)

Create a custom engine and check for validity

Declaration

public static void CreateCustomEngineWithCheck(FormaAdapter adapter, string engineName, string typename)

Parameters

Type	Name	Description
FormaAdapter	adapter
String	engineName
String	typename

CreateNewAction(FormaAdapter, String)

Create a new custom adapter action from a template

Declaration

public static void CreateNewAction(FormaAdapter adapter, string dataAdapterName = null)

Parameters

Type	Name	Description
FormaAdapter	adapter
String	dataAdapterName

FindFormaAdapters()

Find all Forma adapters in project

Declaration

public static IEnumerable<FormaAdapter> FindFormaAdapters()

Returns

Type	Description
IEnumerable<FormaAdapter>

FindValidFormaAdapters()

Find all active Forma adapters in project and return then in order

Declaration

public static IEnumerable<FormaAdapter> FindValidFormaAdapters()

Returns

Type	Description
IEnumerable<FormaAdapter>