Interface LocalNotification

Hierarchy

Properties

nativeObject ios android alertBody alertAction sound launchImage fireDate repeatInterval

Methods

schedule present cancel

Properties

nativeObject

nativeObject: any

Readonly ios

ios: Partial<NotificationIOSProps>

Readonly android

android: Partial<NotificationAndroidProps>

alertBody

alertBody: string

Gets/sets the message displayed in the notification alert.

Property

= '']

Android

Ios

Static

Since

0.1

alertAction

alertAction: string

Gets/sets the title displayed in the notification alert.

Property

= '']

Android

Ios

Static

Since

0.1

sound

sound: string

Gets/sets the path of the file that will be played when a notification is displayed. For iOS, sounds that last longer than 30 seconds are not supported. If you specify a file with a sound that plays over 30 seconds, the default sound is played instead.

Property

= '']

Android

Ios

Static

Since

0.1

launchImage

launchImage: string

Gets/sets the path of the image that will be displayed as large icon for Android, as the launch image when the user taps for iOS.

Property

= '']

Android

Ios

Static

Since

0.1

fireDate

fireDate: number

Gets/sets the fire date of the LocalNotification. FireDate is the date and time when the system should deliver the notification in the default timezone. If the specified value is null or is a date in the past, the notification is delivered immediately.

Property

= Date.now()]

Android

Ios

Static

Since

0.1

repeatInterval

repeatInterval: number

Gets/sets the repeat interval of the LocalNotification. When you schedule local notification, it will repeats by repeatInterval as miliseconds.

Property

= 0]

Android

Ios

Static

Since

0.1

Methods

schedule

  • Schedules this notification by Notifications.LocalNotification#fireDate and Notifications.LocalNotification#repeatInterval.

    Method

    schedule

    Android

    Ios

    Static

    Since

    0.1

    Returns void

present

  • Presents notification to the user immediately.

    Method

    present

    Android

    Ios

    Static

    Since

    0.1

    Returns void

cancel

  • Cancels this notification even if this is scheduled or presented notification.

    Method

    cancel

    Android

    Ios

    Static

    Since

    0.1

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc