Unity - Scripting API: LocalNotification
Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

LocalNotification

Namespace: UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

LocalNotification is a wrapper around the UILocalNotification class found in the Apple UIKit framework and is only available on iPhone/iPad/iPod Touch.

It represents notifications that an application can schedule for presentation to its user at specific dates and times. The operating system is responsible for delivering the notification at the specified time. Local notifications are similar to remote notifications but are scheduled and delivered locally and do not require connection with remote servers.

Local notifications are scheduled and handled using NotificationServices class.

Static Variables

defaultSoundName The default system sound. (Read Only)

Variables

alertAction The title of the action button or slider.
alertBody The message displayed in the notification alert.
alertLaunchImage Identifies the image used as the launch image when the user taps the action button.
applicationIconBadgeNumber The number to display as the application's icon badge.
fireDate The date and time when the system should deliver the notification.
hasAction A boolean value that controls whether the alert action is visible or not.
repeatCalendar The calendar type (Gregorian, Chinese, etc) to use for rescheduling the notification.
repeatInterval The calendar interval at which to reschedule the notification.
soundName The name of the sound file to play when an alert is displayed.
timeZone The time zone of the notification's fire date.
userInfo A dictionary for passing custom information to the notified application.

Constructors

LocalNotification Creates a new local notification.
Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload