Class DashboardConfigurationService

Namespace

Dynamicweb.Dashboard

Assembly

Dynamicweb.Core.dll

public class DashboardConfigurationService

Inheritance

object

DashboardConfigurationService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ClearConfigurationAsDefault(DashboardConfiguration)

public void ClearConfigurationAsDefault(DashboardConfiguration dashboardConfiguration)

Parameters

dashboardConfiguration DashboardConfiguration

CreateCopyOfDefaultConfiguration(string, int, string)

public DashboardConfiguration CreateCopyOfDefaultConfiguration(string dashboardType, int userId, string path)

Parameters

dashboardType string

userId int

path string

Returns

DashboardConfiguration

CreateCopyOfDefaultConfiguration(string, string)

public DashboardConfiguration CreateCopyOfDefaultConfiguration(string dashboardType, string path)

Parameters

dashboardType string

path string

Returns

DashboardConfiguration

DeleteAll(IEnumerable<DashboardArea>)

public void DeleteAll(IEnumerable<DashboardArea> areas)

Parameters

areas IEnumerable<DashboardArea>

DeleteDashboards(IEnumerable<string>)

public void DeleteDashboards(IEnumerable<string> paths)

Parameters

paths IEnumerable<string>

Get(string)

public DashboardConfiguration Get(string path)

Parameters

path string

Returns

DashboardConfiguration

Get(string, int, string)

public DashboardConfiguration Get(string dashboardType, int userId, string path)

Parameters

dashboardType string

userId int

path string

Returns

DashboardConfiguration

GetAllDashboardsConfigurations()

public IEnumerable<DashboardConfiguration> GetAllDashboardsConfigurations()

Returns

IEnumerable<DashboardConfiguration>

GetArea(string)

public DashboardArea? GetArea(string areaName)

Parameters

areaName string

Returns

DashboardArea

GetArea(string, bool)

public DashboardArea? GetArea(string areaName, bool includeCustomAreas)

Parameters

areaName string

includeCustomAreas bool

Returns

DashboardArea

GetAreas(bool)

public IEnumerable<DashboardArea> GetAreas(bool includeCustomAreas)

Parameters

includeCustomAreas bool

Returns

IEnumerable<DashboardArea>

GetDashboardsConfigurations(DashboardArea, int)

public IEnumerable<DashboardConfiguration> GetDashboardsConfigurations(DashboardArea area, int userId)

Parameters

area DashboardArea

userId int

Returns

IEnumerable<DashboardConfiguration>

GetDashboardsUserIds()

public IEnumerable<int> GetDashboardsUserIds()

Returns

IEnumerable<int>

GetDefaultConfiguration(IDashboard?, string, string?)

public DashboardConfiguration GetDefaultConfiguration(IDashboard? dashboard, string dashboardType, string? path)

Parameters

dashboard IDashboard

dashboardType string

path string

Returns

DashboardConfiguration

GetDefaultConfiguration(string, int)

public DashboardConfiguration GetDefaultConfiguration(string dashboardType, int userId)

Parameters

dashboardType string

userId int

Returns

DashboardConfiguration

IsDashboardCustomized(string, string, int)

public bool IsDashboardCustomized(string areaName, string path, int userId)

Parameters

areaName string

path string

userId int

Returns

bool

Save(DashboardConfiguration)

public DashboardConfiguration? Save(DashboardConfiguration dashboardConfiguration)

Parameters

dashboardConfiguration DashboardConfiguration

Returns

DashboardConfiguration

SaveAreaName(DashboardArea, string)

public void SaveAreaName(DashboardArea area, string areaName)

Parameters

area DashboardArea

areaName string

SetConfigurationAsDefault(DashboardConfiguration)

public void SetConfigurationAsDefault(DashboardConfiguration dashboardConfiguration)

Parameters

dashboardConfiguration DashboardConfiguration