Class DashAgent

Proxy class for the Dash Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance
object
DashAgent
Implements
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.Implementation.dll
Syntax
public class DashAgent : IDashAgent, IAgent

Constructors

DashAgent(IDashImplementation, IDashCollectionImplementation, IDashThemeImplementation, IDashTileImplementation, IDashTileDefinitionImplementation, IDashTileHtmlImplementation, IPreviewDashImplementation, IPreviewDashTileImplementation, ISoRequestItemsAccessor)

Proxy class for the Dash Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public DashAgent(IDashImplementation dashImplementation, IDashCollectionImplementation dashCollectionImplementation, IDashThemeImplementation dashThemeImplementation, IDashTileImplementation dashTileImplementation, IDashTileDefinitionImplementation dashTileDefinitionImplementation, IDashTileHtmlImplementation dashTileHtmlImplementation, IPreviewDashImplementation previewDashImplementation, IPreviewDashTileImplementation previewDashTileImplementation, ISoRequestItemsAccessor accessor)
Parameters
Type Name Description
IDashImplementation dashImplementation
IDashCollectionImplementation dashCollectionImplementation
IDashThemeImplementation dashThemeImplementation
IDashTileImplementation dashTileImplementation
IDashTileDefinitionImplementation dashTileDefinitionImplementation
IDashTileHtmlImplementation dashTileHtmlImplementation
IPreviewDashImplementation previewDashImplementation
IPreviewDashTileImplementation previewDashTileImplementation
ISoRequestItemsAccessor accessor

DashAgent(IDashImplementation, IDashCollectionImplementation, IDashThemeImplementation, IDashTileImplementation, IDashTileDefinitionImplementation, IDashTileHtmlImplementation, IPreviewDashImplementation, IPreviewDashTileImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the Dash Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public DashAgent(IDashImplementation dashImplementation, IDashCollectionImplementation dashCollectionImplementation, IDashThemeImplementation dashThemeImplementation, IDashTileImplementation dashTileImplementation, IDashTileDefinitionImplementation dashTileDefinitionImplementation, IDashTileHtmlImplementation dashTileHtmlImplementation, IPreviewDashImplementation previewDashImplementation, IPreviewDashTileImplementation previewDashTileImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)
Parameters
Type Name Description
IDashImplementation dashImplementation
IDashCollectionImplementation dashCollectionImplementation
IDashThemeImplementation dashThemeImplementation
IDashTileImplementation dashTileImplementation
IDashTileDefinitionImplementation dashTileDefinitionImplementation
IDashTileHtmlImplementation dashTileHtmlImplementation
IPreviewDashImplementation previewDashImplementation
IPreviewDashTileImplementation previewDashTileImplementation
ISoRequestItemsAccessor accessor
IDebugUser debugUser
IServiceCallsRepository serviceCallsRepository
IScriptingConfiguration scriptingConfiguration
IOnlineConfiguration onlineConfiguration

Methods

AddNewTileToDashboardAsync(int, DashTileDefinition, CancellationToken)

Add a new tile to a dashboard with next rank

Declaration
public Task<DashTile> AddNewTileToDashboardAsync(int dashboardId, DashTileDefinition dashTileDefinition, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard to add the tile to
DashTileDefinition dashTileDefinition

The tile definition data to add to the dashboard
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

The newly added tile

AddTileToDashboardAsync(int, int, CancellationToken)

Add a tile to a dashboard with next rank

Declaration
public Task<DashTile> AddTileToDashboardAsync(int dashboardId, int dashTileDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard to add the tile to
int dashTileDefinitionId

The id of the dashboard tile definition
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

The newly added tile

CopyTileSelectionAsync(int, CancellationToken)

Copy Tile Selection for the dashboard

Declaration
public Task<int> CopyTileSelectionAsync(int selectionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int selectionId

The id of the selection to copy from
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<int>

Selection Id

CreateDashTileSelectionFromEntityAsync(string, CancellationToken)

Returns the id to a dashboard tile selection

Declaration
public Task<int> CreateDashTileSelectionFromEntityAsync(string entityName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string entityName

The name of the entity to create a default selection for
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<int>

Selection Id

CreateDefaultDashAsync(CancellationToken)

Loading default values into a new Dash.

Declaration
public Task<Dash> CreateDefaultDashAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Dash>

New Dash with default values

CreateDefaultDashCollectionAsync(CancellationToken)

Loading default values into a new DashCollection.

Declaration
public Task<DashCollection> CreateDefaultDashCollectionAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashCollection>

New DashCollection with default values

CreateDefaultDashThemeAsync(CancellationToken)

Loading default values into a new DashTheme.

Declaration
public Task<DashTheme> CreateDefaultDashThemeAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTheme>

New DashTheme with default values

CreateDefaultDashTileAsync(CancellationToken)

Loading default values into a new DashTile.

Declaration
public Task<DashTile> CreateDefaultDashTileAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

New DashTile with default values

CreateDefaultDashTileDefinitionAsync(CancellationToken)

Loading default values into a new DashTileDefinition.

Declaration
public Task<DashTileDefinition> CreateDefaultDashTileDefinitionAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileDefinition>

New DashTileDefinition with default values

CreateDefaultPreviewDashAsync(CancellationToken)

Loading default values into a new PreviewDash.

Declaration
public Task<PreviewDash> CreateDefaultPreviewDashAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<PreviewDash>

New PreviewDash with default values

CreateDefaultPreviewDashTileAsync(CancellationToken)

Loading default values into a new PreviewDashTile.

Declaration
public Task<PreviewDashTile> CreateDefaultPreviewDashTileAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<PreviewDashTile>

New PreviewDashTile with default values

CreateDefaultTileDefinitionForEntityAsync(string, CancellationToken)

Set Measure to CountAll and MeasureField to primary key field

Declaration
public Task<DashTileDefinition> CreateDefaultTileDefinitionForEntityAsync(string entityName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string entityName

Name of entity to use for primary key
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileDefinition>

Default

CreateDefaultTileForEntityAsync(string, CancellationToken)

Set Measure to CountAll and MeasureField to primary key field

Declaration
public Task<DashTile> CreateDefaultTileForEntityAsync(string entityName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string entityName

Name of entity to use for primary key
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

Default

DeleteDashAsync(int, CancellationToken)

Deletes the Dash

Declaration
public Task DeleteDashAsync(int dashId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashId

The identity of the Dash
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

This method has no return value

DeleteDashThemeAsync(int, CancellationToken)

Deletes the DashTheme

Declaration
public Task DeleteDashThemeAsync(int dashThemeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashThemeId

The identity of the DashTheme
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

This method has no return value

DeleteDashTileAsync(int, CancellationToken)

Deletes the DashTile

Declaration
public Task DeleteDashTileAsync(int dashTileId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashTileId

The identity of the DashTile
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

This method has no return value

DeleteDashTileDefinitionAsync(int, CancellationToken)

Deletes the DashTileDefinition

Declaration
public Task DeleteDashTileDefinitionAsync(int dashTileDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashTileDefinitionId

The identity of the DashTileDefinition
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

This method has no return value

DuplicateDashboardAsync(int, string, CancellationToken)

Duplicate for the dashboard and all the sub elements

Declaration
public Task<Dash> DuplicateDashboardAsync(int dashboardId, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard to add the tile to
string name

The name of the new dashboard
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Dash>

New dashboard

DuplicateTileAsync(int, string, CancellationToken)

Duplicate for the tile and all the sub elements

Declaration
public Task<DashTile> DuplicateTileAsync(int dashTileId, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashTileId

The id of the tile to copy
string name

The name of the new tile
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

New tile

GetDashAsync(int, CancellationToken)

Gets a Dash object.

Declaration
public Task<Dash> GetDashAsync(int dashId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashId

The identifier of the Dash object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Dash>

A single Dash

GetDashCollectionAsync(CancellationToken)

Gets a collection of dashboards for the current associate

Declaration
public Task<DashCollection> GetDashCollectionAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashCollection>

Dashboard collection

GetDashListAsync(int[], CancellationToken)

Gets the ordered list of dashboards

Declaration
public Task<Dash[]> GetDashListAsync(int[] dashboards, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] dashboards

List of dashboardIds
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Dash[]>

List of dashboards

GetDashQuickFiltersAsync(int, CancellationToken)

Gets the quick filters for this dashboard

Declaration
public Task<QuickFilterInfo[]> GetDashQuickFiltersAsync(int dashboardId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard to get the quick filters for
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<QuickFilterInfo[]>

List of quick filters for the given dashboard

GetDashThemeAsync(int, CancellationToken)

Gets a DashTheme object.

Declaration
public Task<DashTheme> GetDashThemeAsync(int dashThemeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashThemeId

The identifier of the DashTheme object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTheme>

A single DashTheme

GetDashTileAsync(int, CancellationToken)

Gets a DashTile object.

Declaration
public Task<DashTile> GetDashTileAsync(int dashTileId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashTileId

The identifier of the DashTile object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

A single DashTile

GetDashTileDefinitionAsync(int, CancellationToken)

Gets a DashTileDefinition object.

Declaration
public Task<DashTileDefinition> GetDashTileDefinitionAsync(int dashTileDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashTileDefinitionId

The identifier of the DashTileDefinition object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileDefinition>

A single DashTileDefinition

GetDashTileHtmlAsync(int, string, CancellationToken)

Get HTML for a dashboard tile definition with TileType = HTML

Declaration
public Task<DashTileHtml> GetDashTileHtmlAsync(int dashboardTileDefinitionId, string languageCode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardTileDefinitionId

The id of the dashboard tile definition
string languageCode

Preferred language code.
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileHtml>

HTML data

GetDashTileHtmlListAsync(int, CancellationToken)

Get HTML for a dashboard tile definition with TileType = HTML. Retrieve a list with all registered languages.

Declaration
public Task<DashTileHtml[]> GetDashTileHtmlListAsync(int dashboardTileDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardTileDefinitionId

The id of the dashboard tile definition
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileHtml[]>

GetDashTilesAsync(int, CancellationToken)

Gets the ordered list of tiles for a dashboard

Declaration
public Task<DashTile[]> GetDashTilesAsync(int dashboardId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile[]>

Ordered list of dashboard tiles

GetPossibleDashQuickFiltersAsync(int, CancellationToken)

Gets the possible (not stored/selected) quick filters for this dashboard

Declaration
public Task<QuickFilterInfo[]> GetPossibleDashQuickFiltersAsync(int dashboardId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard to get the possible quick filters for
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<QuickFilterInfo[]>

List of possible quick filters for the given dashboard

GetPreviewDashAsync(int, CancellationToken)

Get a dashboard from its id

Declaration
public Task<PreviewDash> GetPreviewDashAsync(int dashboardId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

Dashboard ID
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<PreviewDash>

Dashboard suitable for preview

GetSecondaryTempTileSelectionAsync(int, CancellationToken)

Copy selection to secondary temporary personal tile selection

Declaration
public Task<int> GetSecondaryTempTileSelectionAsync(int selectionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int selectionId

The id of the selection to copy from
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<int>

Selection Id

GetTempTileSelectionAsync(int, CancellationToken)

Copy selection to temporary personal tile selection

Declaration
public Task<int> GetTempTileSelectionAsync(int selectionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int selectionId

The id of the selection to copy from
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<int>

Selection Id

SaveDashAsync(Dash, CancellationToken)

Updates the existing Dash or creates a new Dash if the id parameter is 0.

Declaration
public Task<Dash> SaveDashAsync(Dash dash, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Dash dash

The Dash that is saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<Dash>

New or updated Dash

SaveDashQuickFiltersAsync(int, QuickFilterInfo[], CancellationToken)

Saves the quick filters for this dashboard

Declaration
public Task<QuickFilterInfo[]> SaveDashQuickFiltersAsync(int dashboardId, QuickFilterInfo[] quickFilters, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard these quick filters are associated with
QuickFilterInfo[] quickFilters

Complete list of quick filters for the given dashboard, overwriting the existing list
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<QuickFilterInfo[]>

List of saved quick filters for the given dashboard

SaveDashThemeAsync(DashTheme, CancellationToken)

Updates the existing DashTheme or creates a new DashTheme if the id parameter is 0.

Declaration
public Task<DashTheme> SaveDashThemeAsync(DashTheme dashTheme, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DashTheme dashTheme

The DashTheme that is saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTheme>

New or updated DashTheme

SaveDashTileAsync(DashTile, CancellationToken)

Updates the existing DashTile or creates a new DashTile if the id parameter is 0.

Declaration
public Task<DashTile> SaveDashTileAsync(DashTile dashTile, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DashTile dashTile

The DashTile that is saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTile>

New or updated DashTile

SaveDashTileDefinitionAsync(DashTileDefinition, CancellationToken)

Updates the existing DashTileDefinition or creates a new DashTileDefinition if the id parameter is 0.

Declaration
public Task<DashTileDefinition> SaveDashTileDefinitionAsync(DashTileDefinition dashTileDefinition, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DashTileDefinition dashTileDefinition

The DashTileDefinition that is saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileDefinition>

New or updated DashTileDefinition

SaveDashTileHtmlListAsync(int, DashTileHtml[], CancellationToken)

Set the HTML data for a tile with TileType = HTML.

Declaration
public Task<DashTileHtml[]> SaveDashTileHtmlListAsync(int dashboardTileDefinitionId, DashTileHtml[] languages, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardTileDefinitionId

The id of the dashboard tile definition
DashTileHtml[] languages

List of HTML content per language
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<DashTileHtml[]>

SaveDashTilesAsync(int, DashTile[], CancellationToken)

Saves the ordered list of tiles for a dashboard

Declaration
public Task SaveDashTilesAsync(int dashboardId, DashTile[] dashTiles, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int dashboardId

The id of the dashboard
DashTile[] dashTiles

The tiles in order
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

Implements