ez-push/ios

- [EZPush SDK](#ezpush-sdk)

Requirements

[Swift 5] [iOS 13.0+]

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate EZPush into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'

use_frameworks!

target '<Your Target Name>' do
    platform :ios, '13.0'
    pod 'EZPush'
end

Then, run the following command:

$ pod install

Swift Package Manager

You can use the Swift Package Manager to install EZPush into your Xcode project. Follow these steps:

Open your project in Xcode.
Select "File" -> "Swift Packages" -> "Add Package Dependencies..."
Enter the URL of this repository: https://github.com/ez-push/ios
Select the version you'd like to use and click "Add Package".

Setup App Delegate

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
    application.registerForRemoteNotifications()
    EZPush.current.registerPushNotificationDelegate() // EZPush must handle incoming notifications
    return true
}

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    // TODO: store device token for EZ-Push initialization
}

To get started with EZPush, import the module into your Swift code:

import EZPush

Request for Permission

EZPush.current.requestForPushNotificationPermission([.alert, .badge, .sound]) { _, _ in }

Configure EZPush

let config = EZPushConfiguration(licenseKey: "YOUR_LICENSE_KEY", showDebugInfo: true, groupName: "YOUR_GROUP_NAME")
EZPush.current.configure(config, startPeriodicSync: Bool)
EZPush.current.initialize(pushNotificationToken: "PUSH_NOTIFICATION_TOKEN") { _, _ in }

Contributing

Updating the EZPushCore Version:

- change the Version of the Package Dependencies in iOS Example.xcodeproj and EZPush.xcodeproj - change the Version in the CoreVersion file

Package Metadata

Repository: ez-push/ios

Default branch: main

README: README.md