Подключение голосовых Push-уведомлений
Библиотека EDNAVoicePush расширяет возможности EDNAPushLite и позволяет обрабатывать VoIP-уведомления в приложениях iOS.
После интеграции модуль обеспечивает:
- отображение системного экрана входящего вызова;
- отображение настраиваемого интерфейса разговора с заголовком, логотипом и элементами управления;
- воспроизведение аудиофайла после принятия вызова;
- обработку действий пользователя и событий голосового уведомления.
Перед интеграцией голосового модуля завершите базовую интеграцию библиотеки EDNAPushLite.
Требования
Для корректной работы голосовых push-уведомлений необходимо учитывать следующие ограничения:
- сообщение должно содержать параметры
voicePushType = audioCallPushиvoiceMessageUrl; - размер аудиофайла не должен превышать 5 МБ;
- поддерживаются форматы
mp3,wav,flacиaac; - загруженный аудиофайл не сохраняется на устройстве;
- во время звонка э кран фиксируется, автоповорот недоступен;
- при начале воспроизведения приостанавливаются ранее запущенные аудио- и видеопотоки;
- при ошибке загрузки библиотека может повторно скачать файл в соответствии с настройками
fileDownloadingSettings; - если голосовое уведомление переопределяет параметры отображения, после завершения обработки их необходимо сбросить.
Шаг 1. Настройте Apple Developer
-
В разделе Identifiers выберите App ID приложения.
-
На вкладке Capabilities включите возможность Time Sensitive Notifications.
Identifiers — Apple Developer -
В разделе Certificates создайте сертификат VoIP Services Certificate.
Certificates — Apple Developer
Шаг 2. Настройте проект
-
В Xcode откройте настройки приложения.
-
На вкладке Signing & Capabilities:
- в разделе Background Modes включите Voice over IP;
- при использовании голосовых ответов добавьте разрешение Microphone и укажите текст запроса доступа.
Свойство EDNAPushLite.voipSupported должно быть установлено до вызова метода start().
Для регистрации устройства на Push-платформе VoIP-токен необ ходимо передавать в EDNAPushLite.
Шаг 3. Инициализируйте голосовой модуль
В файле AppDelegate.swift:
- импортируйте библиотеки
EDNAVoicePush,PushKitиAVFoundation; - создайте экземпляр
EDNAVoicePush; - включите поддержку VoIP в
EDNAPushLite; - зарегистрируйте модуль с помощью
addModule().
import EDNAPushLite
import EDNAVoicePush
import PushKit
import AVFoundation
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, EDNAPushLiteDelegate {
var pushApi: EDNAPushLite!
var voicePush: EDNAVoicePush!
var voipRegistry: PKPushRegistry!
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
// Для VoIP push-уведомлений
regVoip()
audioPermission()
let commonCallStyles = createCommonCallStyles()
let commonData = createCommonData()
let fileDownloadingSettings = FileDownloadingSettings()
let voicePushActionSettings = VoicePushActionSettings()
// Инициализация голосового модуля
voicePush = EDNAVoicePush(
commonData: commonData,
commonCallStyles: commonCallStyles
)
// Настройки скачивания аудиофайла и приема ответа пользователя.
// Можно не з адавать, если подходят значения по умолчанию.
voicePush.fileDownloadingSettings = fileDownloadingSettings
voicePush.voicePushActionSettings = voicePushActionSettings
let pushLite = EDNAPushLite(delegate: self)
pushLite.appGroup = "group.com.mycompany.myapp"
pushLite.logEnable = true
pushLite.voipSupported = true
pushLite.useFullContentForAutodraw = false
pushApi = pushLite
// Добавление модуля голосовых push-уведомлений в библиотеку Lite.
pushApi.addModule(voicePush)
voicePush.setOnVoicePushAction(block: { actionData in
// Код обработки события голосового push-уведомления
})
voicePush.setOnVoicePushError(block: { errorData in
// Код обработки ошибки голосового push-уведомления
})
pushApi.start()
return true
}
}
Шаг 4. Настройте отображение голосовых уведомлений
При необходимости настройте внешний вид экранов вызова и параметры голосового модуля.
Настройка параметров
func settingsVoicePushProperties() {
VoicePushProperties.shared.voicePush = voicePush
VoicePushProperties.shared.onUpdateCallback = { [weak self] in
if let commonData = VoicePushProperties.shared.voicePush?.commonData {
self?.voicePush.commonData = commonData
}
if let commonCallStyles = VoicePushProperties.shared.voicePush?.commonCallStyles {
self?.voicePush.commonCallStyles = commonCallStyles
}
}
}
Настройка стилей и данных
func createCommonCallStyles() -> CommonCallStyles {
let commonCallStyles = CommonCallStyles(activeCallStyles: ActiveCallStyles())
commonCallStyles.activeCallStyles.image = UIImage(named: "ScreenImageEdna")!
commonCallStyles.activeCallStyles.headerText.color = .white
commonCallStyles.activeCallStyles.mainText.color = .white
return commonCallStyles
}
func createCommonData() -> CommonData {
let callImage = UIImage(named: "callIcon")!
let activeCallData = EDNACallData(
headerText: "входящий разговор",
mainText: "Название приложения",
image: callImage
)
return CommonData(activeCallData: activeCallData, callRingtone: nil)
}
Шаг 5. Настройте регистрацию VoIP
Запросите разрешение на использование микрофона и зарегистрируйте приложение для получения VoIP-уведомлений.
func audioPermission() {
AVAudioSession.sharedInstance().requestRecordPermission { granted in
// Код обработки результата запроса разрешения
}
}
func regVoip() {
voipRegistry = PKPushRegistry(queue: DispatchQueue.main)
voipRegistry.delegate = self
voipRegistry.desiredPushTypes = [PKPushType.voIP]
}
Шаг 6. Реализуйте делегат PushKit
Добавьте реализацию PKPushRegistryDelegate.
При получении VoIP-уведомления:
- передайте данные в
EDNAVoicePushдля обработки; - пере дайте уведомление в
EDNAPushLiteдля подтверждения доставки.
extension AppDelegate: PKPushRegistryDelegate {
func pushRegistry(
_ registry: PKPushRegistry,
didUpdate pushCredentials: PKPushCredentials,
for type: PKPushType
) {
pushApi.appDelegate.didRegisterForVoIPNotifications(
withVoIPToken: pushCredentials.token
)
}
func pushRegistry(
_ registry: PKPushRegistry,
didInvalidatePushTokenFor type: PKPushType
) {
print("didInvalidatePushTokenFor")
}
public func pushRegistry(
_ registry: PKPushRegistry,
didReceiveIncomingPushWith payload: PKPushPayload,
for type: PKPushType,
completion: @escaping () -> Void
) {
defer {
completion()
}
if type == .voIP {
voicePush.didVoIPPush(
userInfo: payload.dictionaryPayload,
completion: nil
)
pushApi.appDelegate.didReceiveRemoteNotification(
payload.dictionaryPayload
)
}
}
}