TaskExecutionContextCreateWebPlayerLibraryLink Method

Spotfire Automation Services 15.0 API Reference
Creates a link to a Spotfire Web Player file for a given library file. This requires the link to the Web Client server to be set in Spotfire Administration manager.

Namespace:  Spotfire.Dxp.Automation.Extension
Assembly:  Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll) Version: 71.0.21826.3255 (71.0.21826.3255)
Syntax
C#
Copy
public abstract string CreateWebPlayerLibraryLink(
	AnalysisApplication application,
	string path,
	string name
)

Parameters

application
Type: AnalysisApplication
The started AnalysisApplication
path
Type: SystemString
The absolute path to the library folder (or section) where the file is. expected: "section/[folder/../folder>/]".
name
Type: SystemString
The name of the library file to open (no extension).

Return Value

Type: String
The Url.
Exceptions
ExceptionCondition
ArgumentExceptionIf web client url not set in preferences.
Version Information


See Also

Reference

TaskExecutionContext Class
Spotfire.Dxp.Automation.Extension Namespace