Class NotificationAPI

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

APIScope

Hierarchy (view full)

APIScope
- NotificationAPI

Index

Constructors

Properties

$iApi notificationStore

Accessors

Methods

addGroup getGroup show

Constructors

constructor

new NotificationAPI(iApi): NotificationAPI
Creates an instance of Notification API
Parameters
- iApi: InstanceAPI
  The instance API for the RAMP that this should be associated with.
Returns NotificationAPI
Overrides APIScope.constructor
- Defined in src/api/notifications.ts:20

Properties

`Readonly`$iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

notificationStore

notificationStore: Store<"notification", _UnwrapAll<Pick<NotificationStore, "notificationStack" | "groups">>, Pick<NotificationStore, "notificationNumber">, Pick<NotificationStore,
    | "showNotification"
    | "removeNotification"
    | "registerGroup"
    | "addToGroup"
    | "clearAll"
    | "removeGroup">>

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$element
- Defined in src/api/common.ts:32

$vApp

get $vApp(): ComponentPublicInstance
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance
Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:28

Methods

addGroup

addGroup(id, type, message): NotificationGroup
Adds a notification group, which can be used to hold multiple messages.
Parameters
- id: string
  The id for the group
- type: NotificationType
  The type of notification the group will hold, 'error' 'warning' or 'info'
- message: string
  The "main" message for the notification, describing the grouped messages
Returns NotificationGroup
Memberof
NotificationAPI
- Defined in src/api/notifications.ts:55

getGroup

getGroup(id): NotificationGroup
Returns the group with the id provided, returns undefined if there is no such group
Parameters
- id: string
  The id of the group wanted
Returns NotificationGroup
Memberof
NotificationAPI
- Defined in src/api/notifications.ts:72

show

show(type, message): void
Shows a notification with the type and message provided
Parameters
- type: NotificationType
  The type of notification to display
- message: string
  The message to display in the notification
Returns void
Memberof
NotificationAPI
- Defined in src/api/notifications.ts:43