Class NotificationGroup

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

Export

Hierarchy

Constructors

constructor

Properties

$iApi id message messageList notificationStore type

Accessors

$element $vApp

Methods

show

Constructors

constructor

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>

$vApp

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

    Memberof

    APIScope

Methods

show

  • Shows a message under the group

    Parameters

    • message: string

      The message to show

    Returns void

    Memberof

    NotificationGroup

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc