About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class ConnectivityService

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

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ConnectivityService

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

IsOnline ServerPublicUri

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

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.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

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.

Inherited from Object.Equals

Default capability

IsOnline

get IsOnline(): boolean
Gets a value indicating whether or not the application is online and is connected to a Spotfire server.

Returns boolean
Since
2.0

ServerPublicUri

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
Since
2.0