Anark Core SDK
Loading...
Searching...
No Matches
Anark.CoreSdkApi.ISdkPlugIn Interface Reference

The plug-in interface that must be implemented for plug-ins to be loaded by Anark Core. More...

Public Member Functions

string Execute (ISdkApi api, ISdkProgressTracker progressTracker)
 Executes the plug-in.

Properties

string DisplayName [get]
 The user-friendly display name for the plug-in. This may be shown in various user interfaces and log output messages.
Guid Id [get]
 The globally unique ID of the plug-in. Created by the plug-in author.

Detailed Description

The plug-in interface that must be implemented for plug-ins to be loaded by Anark Core.

Member Function Documentation

◆ Execute()

string Anark.CoreSdkApi.ISdkPlugIn.Execute ( ISdkApi api,
ISdkProgressTracker progressTracker )

Executes the plug-in.

Parameters
apiThe plug-in API
progressTrackerAn object that can be used for progress indication
Returns
Null if no errors were encountered, otherwise returns the error message text.

Property Documentation

◆ DisplayName

string Anark.CoreSdkApi.ISdkPlugIn.DisplayName
get

The user-friendly display name for the plug-in. This may be shown in various user interfaces and log output messages.

◆ Id

Guid Anark.CoreSdkApi.ISdkPlugIn.Id
get

The globally unique ID of the plug-in. Created by the plug-in author.