LibraryLinks.TryGetWebPlayerRedirectUri Method

LibraryLinks TryGetWebPlayerRedirectUri Method

TIBCO Spotfire 6.0 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: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

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

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

Parameters

item: Type: Spotfire.Dxp.Framework.Library LibraryItem
The library item to retrieve the TIBCO Spotfire Web Player Server redirect page uri for.

option: Type: Spotfire.Dxp.Framework.Library LibraryLinksOption
The option for generating the resulting uri.

uri: Type: System Uri
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

Exception	Condition
System ArgumentNullException	If item or option is null.

Remarks

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