BookmarkLinksTryGetWebPlayerRedirectUri Method

Spotfire 15.0 API Reference
Tries to get a uri for a Spotfire Web Player Server redirect page of 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: 71.0.22122.5390 (71.0.22122.5390)
Syntax

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

Parameters

bookmark
Type: Spotfire.Dxp.Application.AnalyticItemsBookmark
The bookmark to retrieve the Spotfire Web Player Server redirect page uri for.
option
Type: Spotfire.Dxp.Framework.LibraryLibraryLinksOption
The option for generating the resulting uri.
uri
Type: SystemUri
The Spotfire Web Player Server redirect page uri for the specified bookmark.

Return Value

Type: Boolean
True if successfully created a uri for a Spotfire Web Player Server redirect page; 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


See Also

Reference