Class BookmarkLinks

Declares methods for retrieving links of different types for a bookmark. If the resulting link should contain the path to the analysis use Uri.AbsoluteUri on the resulting uri for a correct string representation for http or https related links in order to comply with different browsers and systems and Uri.ToString() for Spotfire uri. See RFC 3986 and related discussions.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

TryGetRedirectUri TryGetUri TryGetWebPlayerRedirectUri TryGetWebPlayerUri

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

TryGetRedirectUri

  • TryGetRedirectUri(bookmark, option, uri): boolean

  • Tries to get a uri for a Spotfire Server redirect page of the specified bookmark, which should be accessed through http or https.

    Parameters

    Returns boolean

    True if successfully created a uri for a Spotfire Server redirect page; otherwise false.

    Since

    2.0

TryGetUri

  • TryGetUri(bookmark, option, uri): boolean

  • Tries to get a uri for a Spotfire analysis of the specified bookmark, which should be access through the TIBCOSpotfire protocol.

    Parameters

    Returns boolean

    True if successfully created a uri for a Spotfire analysis; otherwise false.

    Since

    2.0

TryGetWebPlayerRedirectUri

  • TryGetWebPlayerRedirectUri(bookmark, option, uri): boolean

  • 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.

    Parameters

    Returns boolean

    True if successfully created a uri for a Spotfire Web Player Server redirect page; otherwise false.

    Since

    2.0

TryGetWebPlayerUri

  • TryGetWebPlayerUri(bookmark, option, uri): boolean

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

    Parameters

    Returns boolean

    True if successfully created a uri for a Spotfire Web Player analysis; otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability