NSDashAgent - SuperOffice

Carrier object for managing various dashboard operations.

Constructors

NSDashAgent()

NSDashAgent

Initializes a new instance of the NSDashAgent class.

Methods

AddNewTileToDashboard(Integer, NSDashTileDefinition)

Adds a new tile to the specified dashboard.

NSDashTile AddNewTileToDashboard(Integer dashboardId, NSDashTileDefinition tileDefinition)

Returns: CRMScript.NetServer.NSDashTile

AddTileToDashboard(Integer, Integer)

Adds an existing tile to a specified dashboard.

NSDashTile AddTileToDashboard(Integer dashboardId, Integer tileId)

Returns: CRMScript.NetServer.NSDashTile

CopyTileSelection(Integer)

Copies the specified tile selection.

Integer CopyTileSelection(Integer selectionId)

Returns: CRMScript.Global.Integer

CreateDashTileSelectionFromEntity(String)

Creates a dash tile selection based on the specified entity.

Integer CreateDashTileSelectionFromEntity(String entity)

Returns: CRMScript.Global.Integer

CreateDefaultDash

Generates a default dashboard.

NSDash CreateDefaultDash()

Returns: CRMScript.NetServer.NSDash

CreateDefaultDashCollection

Generates a default collection of dashboards.

NSDashCollection CreateDefaultDashCollection()

Returns: CRMScript.NetServer.NSDashCollection

CreateDefaultDashTheme

Creates a default theme for dashboards.

NSDashTheme CreateDefaultDashTheme()

Returns: CRMScript.NetServer.NSDashTheme

CreateDefaultDashTile

Generates a default tile for dashboards.

NSDashTile CreateDefaultDashTile()

Returns: CRMScript.NetServer.NSDashTile

CreateDefaultDashTileDefinition

Creates a default definition for a dashboard tile.

NSDashTileDefinition CreateDefaultDashTileDefinition()

Returns: CRMScript.NetServer.NSDashTileDefinition

CreateDefaultPreviewDash

Generates a default preview dashboard.

NSPreviewDash CreateDefaultPreviewDash()

Returns: CRMScript.NetServer.NSPreviewDash

CreateDefaultPreviewDashTile

Creates a default tile for preview dashboards.

NSPreviewDashTile CreateDefaultPreviewDashTile()

Returns: CRMScript.NetServer.NSPreviewDashTile

CreateDefaultTileForEntity(String)

Creates a default tile for the specified entity.

NSDashTile CreateDefaultTileForEntity(String entity)

Returns: CRMScript.NetServer.NSDashTile

DeleteDash(Integer)

Deletes a specified dashboard.

Void DeleteDash(Integer dashId)

Returns: CRMScript.Global.Void

DeleteDashTheme(Integer)

Deletes the specified dashboard theme.

Void DeleteDashTheme(Integer themeId)

Returns: CRMScript.Global.Void

DeleteDashTile(Integer)

Deletes a specified dashboard tile.

Void DeleteDashTile(Integer tileId)

Returns: CRMScript.Global.Void

DeleteDashTileDefinition(Integer)

Deletes the specified tile definition.

Void DeleteDashTileDefinition(Integer tileDefinitionId)

Returns: CRMScript.Global.Void

DuplicateDashboard(Integer, String)

Creates a copy of the specified dashboard with a new name.

NSDash DuplicateDashboard(Integer dashId, String newName)

Returns: CRMScript.NetServer.NSDash

DuplicateTile(Integer, String)

Duplicates a tile with a new name.

NSDashTile DuplicateTile(Integer tileId, String newName)

Returns: CRMScript.NetServer.NSDashTile

GetDash(Integer)

Retrieves a specific dashboard by ID.

NSDash GetDash(Integer dashId)

Returns: CRMScript.NetServer.NSDash

GetDashCollection

Retrieves the current collection of dashboards.

NSDashCollection GetDashCollection()

Returns: CRMScript.NetServer.NSDashCollection

GetDashList(Integer[])

Retrieves a list of dashboards based on an array of IDs.

NSDash[] GetDashList(Integer[] dashIds)

Returns: CRMScript.NetServer.NSDash[]

GetDashTheme(Integer)

Retrieves a specific dashboard theme by ID.

NSDashTheme GetDashTheme(Integer themeId)

Returns: CRMScript.NetServer.NSDashTheme

GetDashTile(Integer)

Retrieves a specific tile from a dashboard by ID.

NSDashTile GetDashTile(Integer tileId)

Returns: CRMScript.NetServer.NSDashTile

GetDashTileDefinition(Integer)

Retrieves a tile definition by ID.

NSDashTileDefinition GetDashTileDefinition(Integer tileDefinitionId)

Returns: CRMScript.NetServer.NSDashTileDefinition

GetDashTileHtml(Integer, String)

Retrieves the HTML content for a specific dashboard tile.

NSDashTileHtml GetDashTileHtml(Integer tileId, String context)

Returns: CRMScript.NetServer.NSDashTileHtml

GetDashTileHtmlList(Integer)

Retrieves a list of HTML content for all tiles in a dashboard.

NSDashTileHtml[] GetDashTileHtmlList(Integer dashId)

Returns: CRMScript.NetServer.NSDashTileHtml[]

GetDashTiles(Integer)

Retrieves all tiles in the specified dashboard.

NSDashTile[] GetDashTiles(Integer dashId)

Returns: CRMScript.NetServer.NSDashTile[]

GetPreviewDash(Integer)

Retrieves a preview version of a specific dashboard.

NSPreviewDash GetPreviewDash(Integer dashId)

Returns: CRMScript.NetServer.NSPreviewDash

GetSecondaryTempTileSelection(Integer)

Retrieves the secondary temporary tile selection by ID.

Integer GetSecondaryTempTileSelection(Integer selectionId)

Returns: CRMScript.Global.Integer

GetTempTileSelection(Integer)

Retrieves the temporary tile selection by ID.

Integer GetTempTileSelection(Integer selectionId)

Returns: CRMScript.Global.Integer

SaveDash(NSDash)

Saves the specified dashboard with given data.

NSDash SaveDash(NSDash dashData)

Returns: CRMScript.NetServer.NSDash

SaveDashTheme(NSDashTheme)

Saves the specified dashboard theme.

NSDashTheme SaveDashTheme(NSDashTheme theme)

Returns: CRMScript.NetServer.NSDashTheme

SaveDashTile(NSDashTile)

Saves the specified dashboard tile.

NSDashTile SaveDashTile(NSDashTile tile)

Returns: CRMScript.NetServer.NSDashTile

SaveDashTileDefinition(NSDashTileDefinition)

Saves the specified dashboard tile definition.

NSDashTileDefinition SaveDashTileDefinition(NSDashTileDefinition tileDefinition)

Returns: CRMScript.NetServer.NSDashTileDefinition

SaveDashTileHtmlList(Integer, NSDashTileHtml[])

Saves a list of HTML content for dashboard tiles.

NSDashTileHtml[] SaveDashTileHtmlList(Integer dashId, NSDashTileHtml[] tileHtmlList)

Returns: CRMScript.NetServer.NSDashTileHtml[]

SaveDashTiles(Integer, NSDashTile[])

Saves multiple tiles for the specified dashboard.

Void SaveDashTiles(Integer dashId, NSDashTile[] tiles)

Returns: CRMScript.Global.Void

​Constructors

​NSDashAgent()

​Methods

​AddNewTileToDashboard(Integer, NSDashTileDefinition)

​AddTileToDashboard(Integer, Integer)

​CopyTileSelection(Integer)

​CreateDashTileSelectionFromEntity(String)

​CreateDefaultDash

​CreateDefaultDashCollection

​CreateDefaultDashTheme

​CreateDefaultDashTile

​CreateDefaultDashTileDefinition

​CreateDefaultPreviewDash

​CreateDefaultPreviewDashTile

​CreateDefaultTileForEntity(String)

​DeleteDash(Integer)

​DeleteDashTheme(Integer)

​DeleteDashTile(Integer)

​DeleteDashTileDefinition(Integer)

​DuplicateDashboard(Integer, String)

​DuplicateTile(Integer, String)

​GetDash(Integer)

​GetDashCollection

​GetDashList(Integer[])

​GetDashTheme(Integer)

​GetDashTile(Integer)

​GetDashTileDefinition(Integer)

​GetDashTileHtml(Integer, String)

​GetDashTileHtmlList(Integer)

​GetDashTiles(Integer)

​GetPreviewDash(Integer)

​GetSecondaryTempTileSelection(Integer)

​GetTempTileSelection(Integer)

​SaveDash(NSDash)

​SaveDashTheme(NSDashTheme)

​SaveDashTile(NSDashTile)

​SaveDashTileDefinition(NSDashTileDefinition)

​SaveDashTileHtmlList(Integer, NSDashTileHtml[])

​SaveDashTiles(Integer, NSDashTile[])

Constructors

NSDashAgent()

Methods

AddNewTileToDashboard(Integer, NSDashTileDefinition)

AddTileToDashboard(Integer, Integer)

CopyTileSelection(Integer)

CreateDashTileSelectionFromEntity(String)

CreateDefaultDash

CreateDefaultDashCollection

CreateDefaultDashTheme

CreateDefaultDashTile

CreateDefaultDashTileDefinition

CreateDefaultPreviewDash

CreateDefaultPreviewDashTile

CreateDefaultTileForEntity(String)

DeleteDash(Integer)

DeleteDashTheme(Integer)

DeleteDashTile(Integer)

DeleteDashTileDefinition(Integer)

DuplicateDashboard(Integer, String)

DuplicateTile(Integer, String)

GetDash(Integer)

GetDashCollection

GetDashList(Integer[])

GetDashTheme(Integer)

GetDashTile(Integer)

GetDashTileDefinition(Integer)

GetDashTileHtml(Integer, String)

GetDashTileHtmlList(Integer)

GetDashTiles(Integer)

GetPreviewDash(Integer)

GetSecondaryTempTileSelection(Integer)

GetTempTileSelection(Integer)

SaveDash(NSDash)

SaveDashTheme(NSDashTheme)

SaveDashTile(NSDashTile)

SaveDashTileDefinition(NSDashTileDefinition)

SaveDashTileHtmlList(Integer, NSDashTileHtml[])

SaveDashTiles(Integer, NSDashTile[])