Method WithDashboard

Namespace

Skyline.AppInstaller

Assembly

Skyline.DataMiner.Core.AppPackageCreator.dll

WithDashboard(string)

Adds the specified dashboard.

public IAppPackageBuilder WithDashboard(string dashboardFilePath)

Parameters

dashboardFilePath string

The file path of the dashboard to add.

Returns

IAppPackageBuilder

A reference to this instance after this operation has completed.

Remarks

This will add the dashboard to the C:\Skyline DataMiner\Dashboards directory.

Exceptions

ArgumentNullException

dashboardFilePath is null.

ArgumentException

dashboardFilePath is empty. -or- The specified file is not a .json file. -or- The specified dashboard file does not exist.

InvalidOperationException

A dashboard with the specified file name has already been added.

WithDashboard(string, string)

Adds the specified dashboard.

public IAppPackageBuilder WithDashboard(string dashboardFilePath, string targetDirectory)

Parameters

dashboardFilePath string

The file path of the dashboard to add.

targetDirectory string

The target directory where the dashboard should be installed.

Returns

IAppPackageBuilder

A reference to this instance after this operation has completed.

Remarks

The target directory must be 'C:\\Skyline DataMiner\\Dashboards' or a subfolder of that directory.

Exceptions

ArgumentNullException

dashboardFilePath or targetDirectory is null.

ArgumentException

dashboardFilePath is empty. -or- The specified file is not a .json file. -or- The specified dashboard file does not exist. -or- The specified target folder path is not a directory.

InvalidOperationException

A dashboard with the specified file name has already been added for the specified target directory.

WithDashboard(IAppPackageAppPackage)

Adds the specified dashboard package.

public IAppPackageBuilder WithDashboard(IAppPackageAppPackage dashboardPackage)

Parameters

dashboardPackage IAppPackageAppPackage

The dashboard package to add.

Returns

IAppPackageBuilder

A reference to this instance after this operation has completed.

Exceptions

ArgumentNullException

dashboardPackage is null.

ArgumentException

dashboardPackage.FilePath.FilePath is empty. -or- The specified file is not a .json file. -or- The specified dashboard file does not exist.

InvalidOperationException

A dashboard package with the specified file path has already been added for the specified target directory.