NFive API Reference

NFive API Reference

    Show / Hide Table of Contents

    Class Plugin

    Represents a loaded NFive plugin configuration including nested dependencies.

    Inheritance
    Object
    Plugin
    Namespace: NFive.SDK.Plugins
    Assembly: NFive.SDK.Plugins.dll
    Syntax
    public class Plugin : Core.Plugins.Plugin

    Properties

    | Improve this Doc View Source

    DependencyNodes

    Gets or sets the dependency plugins.

    Declaration
    public List<Plugin> DependencyNodes { get; set; }
    Property Value
    Type Description
    List<Plugin>

    The dependency plugins.

    Methods

    | Improve this Doc View Source

    Load(String)

    Loads a Plugin from the specified definition file.

    Declaration
    public static Plugin Load(string path)
    Parameters
    Type Name Description
    String path

    The path to the plugin definition file.

    Returns
    Type Description
    Plugin

    The loaded Plugin.

    Exceptions
    Type Condition
    ArgumentNullException

    path - A valid file path must be specified.

    FileNotFoundException

    Unable to find the plugin definition file.

    | Improve this Doc View Source

    Save(String)

    Serialize this instance and saves the to the specified path.

    Declaration
    public void Save(string path)
    Parameters
    Type Name Description
    String path

    The path to save the file at.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2018-2019 NFive