LibraryLinksTryGetWebPlayerRedirectUri Method

TIBCO Spotfire 11.4 API Reference
Tries to get a uri for a TIBCO Spotfire Web Player Server redirect page of the specified library item, which should be accessed through http or https.

Namespace:  Spotfire.Dxp.Framework.Library
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 51.0.16121.3915 (51.0.16121.3915)
Syntax

C#
public bool TryGetWebPlayerRedirectUri(
	LibraryItem item,
	LibraryLinksOption option,
	out Uri uri
)

Parameters

item
Type: Spotfire.Dxp.Framework.LibraryLibraryItem
The library item to retrieve the TIBCO 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 TIBCO Spotfire Web Player Server redirect page uri for the specified library item.

Return Value

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

ExceptionCondition
ArgumentNullExceptionIf item or option is null.
Remarks

Use Uri.AbsoluteUri on the resulting uri for a correct string representation if Path is used.
Version Information

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

Reference