Class NotificationGroup

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

Export

APIScope

Hierarchy (view full)

APIScope
- NotificationGroup

Index

Constructors

Properties

$iApi id message messageList notificationStore type

Accessors

Methods

Constructors

constructor

new NotificationGroup($iApi, id, type, message): NotificationGroup
Creates an instance of Notification Group
Parameters
- $iApi: InstanceAPI
- id: string
  The id for the group
- type: NotificationType
  The type of notification the group will show
- message: string
  The main message for the group
Returns NotificationGroup
Overrides APIScope.constructor
- Defined in src/api/notifications.ts:95

Properties

`Readonly`$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

`Readonly`id

id: string

`Readonly`message

message: string

messageList

messageList: string[] = []

notificationStore

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

`Readonly`type

type: NotificationType

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

show

show(message): void
Shows a message under the group
Parameters
- message: string
  The message to show
Returns void
Memberof
NotificationGroup
- Defined in src/api/notifications.ts:109