Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IToast Abstract

A class to display message as Toast. Only 5 Toasts can be displayed at the same time, each toast will be displayed for 3 seconds and then disappear automatically.

api-version

1

user

Hierarchy

  • IToast

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly TYPE_ERROR

TYPE_ERROR: 2 = 2

Error message type.

api-version

1

user

Static Readonly TYPE_INFO

TYPE_INFO: 0 = 0

Information message type.

api-version

1

user

Static Readonly TYPE_SUCCESS

TYPE_SUCCESS: 3 = 3

Success message type.

api-version

1

user

Static Readonly TYPE_WARN

TYPE_WARN: 1 = 1

Warning message type.

api-version

1

user

Methods

Abstract show

  • show(type: number, title: null | string, message: string, preventDuplicated?: boolean): void

  • Show toast title and message.

    api-version

    1

    user

    Parameters

    • type: number

      A type of the toast {@link IToast.TYPE}.

    • title: null | string

      A title text to show. It cannot exceed one line.

    • message: string

      A message text to show. It cannot exceed two line.

    • Optional preventDuplicated: boolean

      Ignores displaying multiple snackbars with the same 'type', 'title' and 'message'.

    Returns void

Generated using TypeDoc