Action
    Preparing search index...

    Provides information about the Spotfire Server, such as its URL, whether or not it is currently available, etc.

    An instance of this class is always available as an application level service and can be accessed using one of the GetService methods available in the caller context.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get IsOnline(): boolean

      Gets a value indicating whether or not the application is online and is connected to a Spotfire server.

      Returns boolean

      2.0

    • get ServerPublicUri(): Uri

      Gets the public Uri of the Spotfire Server currently connected to. This will be the Uri configured as "Public Address" in the Spotfire server configuration. This Uri should always be used when displaying links to the server, to library files or to the Web Player.

      Returns Uri

      The Uri might not be the same as the Uri used in the client because in a clustered environment a client can connect directly to the server instead of using the load balancer address.

      Always check if the client is online, using Spotfire.Dxp.Framework.ApplicationModel.ConnectivityService.IsOnline, before using this function.

      2.0