BookmarkLinksTryGetWebPlayerUri Method

TIBCO Spotfire 11.4 API Reference
Tries to get a uri for a TIBCO Spotfire Web Player analysis with the specified bookmark, which should be accessed through http or https.

Namespace:  Spotfire.Dxp.Application.AnalyticItems
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 51.0.16121.3915 (51.0.16121.3915)
Syntax

C#
public bool TryGetWebPlayerUri(
	Bookmark bookmark,
	LibraryLinksOption option,
	out Uri uri
)

Parameters

bookmark
Type: Spotfire.Dxp.Application.AnalyticItemsBookmark
The bookmark to retrieve the TIBCO Spotfire Web Player Player analysis uri for.
option
Type: Spotfire.Dxp.Framework.LibraryLibraryLinksOption
The option for generating the resulting uri.
uri
Type: SystemUri
The TIBCO Spotfire Web Player analysis uri with the specified bookmark.

Return Value

Type: Boolean
True if successfully created a uri for a TIBCO Spotfire Web Player analysis; otherwise false.
Exceptions

ExceptionCondition
ArgumentNullExceptionIf bookmark or option is null.
Remarks

Use Uri.AbsoluteUri on the resulting uri for a correct string representation if url encoded path are used.
Version Information

Supported in: 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference