Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы UIKit ссылка класса UILocalNotification

Опции
Развертывание Target:

На этой странице
Язык:

UILocalNotification

Наследование

Соответствует

Оператор импорта

Swift

import UIKit

Objective C

@import UIKit;

Доступность

Доступный в iOS 4.0 и позже.

A UILocalNotification объект указывает уведомление, которое приложение может запланировать для представления в определенной дате и времени. Операционная система ответственна за поставку локальных уведомлений в их запланированные времена; приложение не должно работать за этим для случая. Несмотря на то, что локальные уведомления подобны удаленным уведомлениям, в которых они используются для отображения предупреждений, играя звуки и значки приложения применения идентификационных знаков, они составлены и поставлены локально и не требуют соединения с удаленными серверами.

Локальные уведомления прежде всего предназначаются для приложений с основанными на таймере способами поведения и простым календарем или приложений списка ожидающих выполнения задач. Приложение, работающее в фоновом режиме, может также запланировать локальное уведомление для информирования пользователя входящего сообщения, чата или обновления. Приложение может иметь только ограниченное количество запланированных уведомлений; система сохраняет увольняющие как можно скорее 64 уведомления (с автоматически перепланируемыми уведомлениями, рассчитывая как единственное уведомление) и отбрасывает остальных.

При создании локального уведомления необходимо указать или определенную дату или географическую область как триггер для поставки уведомления. Основанные на дате уведомления поставлены в день и время, которое Вы указываете, и скидки могут быть предоставлены для изменений часового пояса по мере необходимости. Когда пользователь вводит или выходит из указанной области, основанные на области уведомления поставлены. В обоих случаях можно указать, являются ли уведомления разовыми событиями или могут перепланироваться и поставляться снова.

После создания a UILocalNotification объект, запланируйте его с помощью любого scheduleLocalNotification: или presentLocalNotificationNow: метод UIApplication класс. scheduleLocalNotification: метод использует дату огня для планирования поставки; presentLocalNotificationNow: метод сразу представляет уведомление, независимо от значения fireDate. Можно отменить одно или более локальных уведомлений с помощью cancelLocalNotification: или cancelAllLocalNotifications метод UIApplication объект.

Когда система поставляет локальное уведомление, несколько вещей могут произойти, в зависимости от состояния приложения и типа уведомления. Если приложение не является frontmost и видимый, система выводит на экран предупредительное сообщение, значки приложение, и играет звук — независимо от того, что указано в уведомлении. Если уведомление является предупреждением, и пользователь касается кнопки действий (или, если устройство заблокировано, перетаскивает открытый ползунок действия), приложение разбужено или запущено. (Если пользователь касается одного из пользовательских действий, Вы указываете использование additionalActions свойство, приложение разбужено или начато фон.) В application:didFinishLaunchingWithOptions: метод, делегат приложения может получить UILocalNotification объект из словаря опций запуска с помощью UIApplicationLaunchOptionsLocalNotificationKey ключ. Если уведомление включает пользовательские данные в, делегат может проверить свойства уведомления и userInfo словарь, это может получить доступ к тем данным и обработать его соответственно. С другой стороны, если локальное уведомление только значки значок приложения и пользователь в ответ запускает приложение, application:didFinishLaunchingWithOptions: метод вызывают, но нет UILocalNotification объект включен в словарь опций. Когда пользователь выбирает пользовательское действие, делегат приложения application:handleActionWithIdentifier:forLocalNotification:completionHandler: метод вызывают для обработки действия.

Когда система поставляет уведомление, делегат приложения, если приложение является передовым и видимым application:didReceiveLocalNotification: вызывается для обработки уведомления. Используйте информацию в предоставленном UILocalNotification объект решить, что действие взять. Когда приложение уже frontmost, система не выводит на экран предупреждений, значок значок приложения, или играет любые звуки.

Приложение ответственно за управление числом значка, выведенным на экран на его значке. Например, если приложение обмена текстовыми сообщениями обрабатывает все входящие сообщения после получения локального уведомления, это должно удалить значок значка путем установки applicationIconBadgeNumber свойство UIApplication возразите против 0.

Планирование локального уведомления
  • fireDate Свойство

    Дата и время, когда система должна поставить уведомление.

    Объявление

    Swift

    @NSCopying var fireDate: NSDate?

    Objective C

    @property(nonatomic, copy) NSDate *fireDate

    Обсуждение

    Дата огня интерпретируется согласно значению, указанному в timeZone свойство. Если указанное значение nil или дата в прошлом, уведомление сразу поставлено.

    Можно указать значение для этого свойства или region свойство, но не оба. При попытке запланировать локальное уведомление, содержащее обоих, дата области и огня повышает исключение.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    repeatInterval
    repeatCalendar

  • timeZone Свойство

    Часовой пояс даты огня уведомления.

    Объявление

    Swift

    @NSCopying var timeZone: NSTimeZone?

    Objective C

    @property(nonatomic, copy) NSTimeZone *timeZone

    Обсуждение

    Дата, указанная в fireDate интерпретируется согласно значению этого свойства. Если Вы указываете nil (значение по умолчанию), дата огня интерпретируется как абсолютное время GMT, подходящее для случаев, таких как таймеры обратного отсчета. Если Вы присваиваете допустимое NSTimeZone возразите против этого свойства, дата огня интерпретируется как тактовое стеной время, автоматически корректирующееся, когда существуют изменения в часовых поясах; примером, подходящим для этого случая, является будильник.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    repeatInterval
    repeatCalendar

  • repeatInterval Свойство

    Календарный интервал, в котором можно перепланировать уведомление.

    Объявление

    Swift

    var repeatInterval: NSCalendarUnit

    Objective C

    @property(nonatomic) NSCalendarUnit repeatInterval

    Обсуждение

    Если Вы присваиваете единицу времени по календарю такой как еженедельно (NSWeekCalendarUnit) или ежегодно (NSYearCalendarUnit), система перепланирует уведомление для поставки в указанном интервале. Значение по умолчанию 0, что означает, что система запускает уведомление один раз и затем отбрасывает его.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    fireDate
    часовой пояс
    repeatCalendar

  • repeatCalendar Свойство

    Календарь, который система должна отослать к тому, когда это перепланирует повторяющееся уведомление.

    Объявление

    Swift

    @NSCopying var repeatCalendar: NSCalendar?

    Objective C

    @property(nonatomic, copy) NSCalendar *repeatCalendar

    Обсуждение

    Значение по умолчанию nil, который указывает, что используется текущий пользовательский календарь. (Текущий пользовательский календарь возвращается currentCalendar метод класса NSCalendar.)

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    fireDate
    часовой пояс
    repeatInterval

  • region Свойство

    Географическая область, инициировавшая уведомление.

    Объявление

    Swift

    @NSCopying var region: CLRegion!

    Objective C

    @property(nonatomic, copy) CLRegion *region

    Обсуждение

    Когда пользователь пересекает границу области, присвоение значения к этому свойству заставляет локальное уведомление быть поставленным. Сам объект области определяет, инициировано ли уведомление, когда пользователь вводит или выходит из области. Значение по умолчанию этого свойства nil.

    Можно указать значение для этого свойства или fireDate свойство, но не оба. При попытке запланировать локальное уведомление, содержащее обоих, дата области и огня повышает исключение.

    Приложения ограничиваются в общем количестве областей, которые они могут контролировать в любой момент времени, и локальные уведомления, сконфигурированные со значением области, говорят против того общего количества. Кроме того, пользователь должен дать разрешение для Вашего приложения использовать связанную с расположением информацию для поставки основанных на области локальных уведомлений работе. Если пользователь будет отрицать, что запрос Вашего приложения использует службы определения местоположения, то локальные уведомления, сконфигурированные с областью, не будут поставлены.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • regionTriggersOnce Свойство

    Булево значение, указывающее, поставляет ли пересечение географической границы области только одно уведомление.

    Объявление

    Swift

    var regionTriggersOnce: Bool

    Objective C

    @property(nonatomic, assign) BOOL regionTriggersOnce

    Обсуждение

    Когда значение этого свойства YEStrue, пользователь уведомляется только после первого пересечения границы цели region. После первого пересечения локальное уведомление не запланировано. Когда значение этого свойства NOfalse, уведомления поставлены с каждым граничным пересечением. Значение по умолчанию этого свойства YEStrue.

    Сам объект области определяет, инициировано ли уведомление, когда пользователь вводит или выходит из области.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 8.0 и позже.

Создание предупреждения
  • alertBody Свойство

    Сообщение выведено на экран на предупреждении уведомления.

    Объявление

    Swift

    var alertBody: String?

    Objective C

    @property(nonatomic, copy) NSString *alertBody

    Обсуждение

    Присвойте строку или, предпочтительно, ключ локализованной строки (использование NSLocalizedString) как значение сообщения. Если значение этого свойства не -nil, предупреждение выведено на экран. Значение по умолчанию nil (никакое предупреждение). Символы ESC стиля Printf разделяются от строки до дисплея; для включения символа процента (%) в сообщение используйте символы на два процента (%%).

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    alertAction
    hasAction

  • alertAction Свойство

    Заголовок кнопки действий или ползунка.

    Объявление

    Swift

    var alertAction: String?

    Objective C

    @property(nonatomic, copy) NSString *alertAction

    Обсуждение

    Присвойте строку или, предпочтительно, ключ локализованной строки (использование NSLocalizedString) как значение. Предупредительное действие является заголовком правильной кнопки предупреждения или значения разблокировать ползунка, где замены значения «разблокировали» в “понижении для разблокирования”. Если Вы указываете nil, и alertBody не -nil, «Представление» (локализованный на предпочтительный язык) используется в качестве значения по умолчанию.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    hasAction

  • alertTitle Свойство

    Краткое описание причины предупреждения.

    Объявление

    Swift

    var alertTitle: String!

    Objective C

    @property(nonatomic, copy) NSString *alertTitle

    Обсуждение

    Используйте это свойство для предоставления краткого описания причины предупреждения. Можно указать строку с текстом, который Вы хотите вывести на экран, или можно указать, что строка для использования в качестве поиска вводит приложение Localizable.strings файл. Значение по умолчанию этого свойства nil.

    Строки заголовка должны быть короткими, обычно только несколько слов, описывающих причину уведомления. Часы Apple выводят на экран строку заголовка как часть короткого интерфейса уведомления взгляда, имеющего ограниченное пространство.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 8.2 и позже.

  • hasAction Свойство

    Булево значение, управляющее, показывает ли уведомление или скрывает предупредительное действие.

    Объявление

    Swift

    var hasAction: Bool

    Objective C

    @property(nonatomic) BOOL hasAction

    Обсуждение

    Присвоиться NOfalse к этому свойству для сокрытия предупредительной кнопки или ползунка. (Этот эффект требует alertBody быть не -nil.) Значение по умолчанию YEStrue.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    alertAction

  • alertLaunchImage Свойство

    Когда пользователь касается (или слайды) кнопки действий (или ползунок), идентифицирует изображение, используемое в качестве изображения запуска.

    Объявление

    Swift

    var alertLaunchImage: String?

    Objective C

    @property(nonatomic, copy) NSString *alertLaunchImage

    Обсуждение

    Строка является именем файла файла образа в комплекте приложений. Это изображение является запускающимся изображением, указанным для данного уведомления; когда пользователь касается кнопки действий (например, «Представление») или перемещает ползунок действия, изображение используется вместо изображения запуска значения по умолчанию. Если значение этого свойства nil (значение по умолчанию), система любой использование предыдущий снимок, использует изображение, идентифицированное UILaunchImageFile введите приложение Info.plist файл, или отступает к Default.png.

    Значение этого ключа имеет ту же самую семантику как UILaunchImageFile. Для больше об этом ключе, посмотрите информационную Ключевую Ссылку Списка свойств.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    alertAction
    hasAction

  • category Свойство

    Имя группы действий для отображения на предупреждении.

    Объявление

    Swift

    var category: String?

    Objective C

    @property(nonatomic, copy) NSString *category

    Обсуждение

    Значение этого свойства является названием категории, связанным с зарегистрированным UIUserNotificationSettings объект. Когда предупреждение для локального уведомления выведено на экран, система использует строку, которую Вы указываете, чтобы искать группу и получить ее действия. Это тогда добавляет кнопку к предупреждению для каждого действия, определенного группой. Когда пользователь касается одной из тех кнопок, приложение разбужено (или запущено), и данный шанс выполнить определяемое действие. Если указанное название категории не принадлежит зарегистрированной группе действий, предупреждение не выводит на экран дополнительных кнопок действий.

    Указание пользовательских действий является дополнительным. Значение этого свойства nil по умолчанию.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 8.0 и позже.

Конфигурирование других частей уведомления
  • applicationIconBadgeNumber Свойство

    Число для отображения как значок значка приложения.

    Объявление

    Swift

    var applicationIconBadgeNumber: Int

    Objective C

    @property(nonatomic) NSInteger applicationIconBadgeNumber

    Обсуждение

    Значение по умолчанию этого свойства 0, что означает, что никакой значок не выведен на экран.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    soundName
    userInfo

  • soundName Свойство

    Имя файла, содержащего звук для игры, когда предупреждение выведено на экран.

    Объявление

    Swift

    var soundName: String?

    Objective C

    @property(nonatomic, copy) NSString *soundName

    Обсуждение

    Для этого свойства укажите имя файла (включая расширение) звукового ресурса в основном пакете приложения или UILocalNotificationDefaultSoundName запрашивать системный звук по умолчанию. Когда система выводит на экран предупреждение для локального уведомления или значков значок приложения, она играет этот звук. Значение по умолчанию nil (никакой звук). Звуки, длящиеся дольше, чем 30 секунд, не поддерживаются. Если Вы указываете файл со звуком, играющим более чем 30 секунд, звук по умолчанию играется вместо этого.

    Для получения информации о допустимых звуковых ресурсах посмотрите Планирование, Регистрацию и Обработку Уведомлений в Локальном и Удаленном Руководстве по программированию Уведомления.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    applicationIconBadgeNumber
    userInfo

  • userInfo Свойство

    Словарь для передачи пользовательской информации к уведомленному приложению.

    Объявление

    Swift

    var userInfo: [NSObject : AnyObject]?

    Objective C

    @property(nonatomic, copy) NSDictionary *userInfo

    Обсуждение

    Можно добавить произвольные пары ключ/значение к этому словарю. Однако ключи и значения должны быть допустимыми типами списка свойств; если кто-либо не, исключение повышено.

    Оператор импорта

    Objective C

    @import UIKit;

    Swift

    import UIKit

    Доступность

    Доступный в iOS 4.0 и позже.

    См. также

    applicationIconBadgeNumber
    soundName

Константы
  • Звук уведомления

    Система по умолчанию звучит для локальных уведомлений.

    Объявление

    Swift

    let UILocalNotificationDefaultSoundName: String

    Objective C

    UIKIT_EXTERN NSString *const UILocalNotificationDefaultSoundName;

    Константы

    • UILocalNotificationDefaultSoundName

      Когда предупреждение уведомления выведено на экран, идентифицирует системный звук по умолчанию для игры. Вы присваиваете это значение soundName свойство.

      Доступный в iOS 4.0 и позже.