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

Class License

Abstract base class for all classes that define licenses.

A license is defined by its Spotfire.Dxp.Framework.License.License.Id which must be globally unique, a Spotfire.Dxp.Framework.License.License.Name, and a Spotfire.Dxp.Framework.License.License.Description.

Remark

This class cannot be extended through inheritance.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- License

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Description Id LicensedFunctions Name Compare

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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: any): 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: T2, type: TypeRef<T1>): 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: any, objB: any): 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

Description

get Description(): string
Gets the localized description of this license.

Returns string
Since
2.0

Id

get Id(): string
Gets the globally unique id of this license.

Returns string
Since
2.0

LicensedFunctions

get LicensedFunctions(): System.Collections.Generic.IEnumerable<
LicensedFunction,
>
Return a list of all license functions in this class.

Returns System.Collections.Generic.IEnumerable<LicensedFunction>
Since
2.0

Name

get Name(): string
Gets the localized name of this license.

Returns string
Since
2.0

Compare

Compare(lf1: LicensedFunction, lf2: LicensedFunction): number
Compares two license functions.
Parameters
- lf1: LicensedFunction
  The license function to be compared to lf2.
- lf2: LicensedFunction
  The license function to be compared to lf1.
Returns number
-1 if lf1 is smaller than lf2, 0 if lf1=lf2, 1 if lf1 is larger than lf2.

Deprecated
This method is no longer called by Spotfire.

Since
2.0