NFive API Reference

NFive API Reference

    Show / Hide Table of Contents

    Class DefinitionGraph

    Represents a loaded tree of plugins and their resolved dependencies.

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

    Properties

    | Improve this Doc View Source

    Plugins

    Gets or sets the tree of plugins.

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

    The tree of plugins.

    Methods

    | Improve this Doc View Source

    Load(String)

    Deserialized the specified lock file into a DefinitionGraph.

    Declaration
    public static DefinitionGraph Load(string path = "nfive.lock")
    Parameters
    Type Name Description
    String path

    The path to the lock file.

    Returns
    Type Description
    DefinitionGraph

    The deserialized DefinitionGraph.

    Exceptions
    Type Condition
    ArgumentNullException

    A valid file path must be specified.

    FileNotFoundException

    Unable to find the plugin lock file.

    | Improve this Doc View Source

    Save(String)

    Serialize this instance and saves the file to the specified path.

    Declaration
    public void Save(string path = "nfive.lock")
    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