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

Class NotificationService

This service contains a list of notifications that contains information that the user might want to know.

Remark

The notifications will show up in the status bar of the application.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- NotificationService

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AddErrorNotification AddInformationNotification AddWarningNotification

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

AddErrorNotification

AddErrorNotification(
    title: string | String,
    summary: string | String,
    details: string | String,
): void
Add a notification that contains an error.
Parameters
- title: string | String
  The title of the notification.
- summary: string | String
  The summary of the notification, may be null.
- details: string | String
  The details of the notification, may be null.
Returns void
Since
2.0

AddInformationNotification

AddInformationNotification(
    title: string | String,
    summary: string | String,
    details: string | String,
): void
Add a notification that contains information.
Parameters
- title: string | String
  The title of the notification.
- summary: string | String
  The summary of the notification, may be null.
- details: string | String
  The details of the notification, may be null.
Returns void
Since
2.0

AddWarningNotification

AddWarningNotification(
    title: string | String,
    summary: string | String,
    details: string | String,
): void
Add a notification that contains a warning.
Parameters
- title: string | String
  The title of the notification.
- summary: string | String
  The summary of the notification, may be null.
- details: string | String
  The details of the notification, may be null.
Returns void
Since
2.0