Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerogear/aerogear-ios-push
AeroGear UnifiedPush Client Registration SDK (Swift)
https://github.com/aerogear/aerogear-ios-push
aerogear aerogear-unifiedpush-server cocoapods swift
Last synced: about 1 month ago
JSON representation
AeroGear UnifiedPush Client Registration SDK (Swift)
- Host: GitHub
- URL: https://github.com/aerogear/aerogear-ios-push
- Owner: aerogear
- License: apache-2.0
- Created: 2013-06-11T16:01:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-02-13T17:45:53.000Z (over 4 years ago)
- Last Synced: 2024-07-21T17:10:40.885Z (about 2 months ago)
- Topics: aerogear, aerogear-unifiedpush-server, cocoapods, swift
- Language: Swift
- Homepage: http://aerogear.org/ios
- Size: 324 KB
- Stars: 29
- Watchers: 28
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT
Awesome Lists containing this project
README
# AeroGear iOS Push
[](https://opensource.org/s/Apache-2.0)
[](https://github.com/aerogear/aerogear-ios-push/releases)
[](https://cocoapods.org/pods/AeroGear-UPS-Client-Swift)
[](https://cocoapods.org/pods/AeroGear-UPS-Client-Swift)
A handy library that helps to register iOS applications with the AeroGear UnifiedPush Server.
| | Project Info |
| --------------- | -------------------------------------------- |
| License: | Apache License, Version 2.0 |
| Build: | CocoaPods |
| Languague: | Swift 4 |
| Documentation: | http://aerogear.org/ios/ |
| Issue tracker: | https://issues.jboss.org/browse/AGIOS |
| Mailing lists: | [aerogear-users](http://aerogear-users.1116366.n5.nabble.com/) ([subscribe](https://lists.jboss.org/mailman/listinfo/aerogear-users)) |
| | [aerogear-dev](http://aerogear-dev.1069024.n5.nabble.com/) ([subscribe](https://lists.jboss.org/mailman/listinfo/aerogear-dev)) |
## Table of Content
* [Features](#features)
* [Installation](#installation)
* [CocoaPods](#cocoapods)
* [Usage](#usage)
* [Push registration (Programmatically)](#push-registration-programmatically)
* [Push registration (plist)](#push-registration-plist)
* [Push analytics](#push-analytics)
* [Metrics when app is launched](#metrics-when-app-is-launched)
* [Metrics when the app is brought from background to foreground](#metrics-when-the-app-is-brought-from-background-to-foreground)
* [Documentation](#documentation)
* [Demo apps](#demo-apps)
* [Development](#development)
* [Questions?](#questions)
* [Found a bug?](#found-a-bug)
## Features
* Register (Programmatically and plist) on [AeroGear UnifiedPush Server](https://github.com/aerogear/aerogear-unifiedpush-server/)
* Send metrics to [AeroGear UnifiedPush Server](https://github.com/aerogear/aerogear-unifiedpush-server/)
## Installation
### CocoaPods
In your `Podfile` add:
```bash
pod 'AeroGearPush-Swift'
```
and then:
```bash
pod install
```
to install your dependencies
## Usage
### Push registration (Programmatically)
```swift
// setup registration
let registration = DeviceRegistration(serverURL: URL(string: "<#AeroGear UnifiedPush Server URL#>")!)
// attempt to register
registration.register(
clientInfo: { (clientDevice: ClientDeviceInformation!) in
// setup configuration
clientDevice.deviceToken = deviceToken
clientDevice.variantID = "<# Variant Id #>"
clientDevice.variantSecret = "<# Variant Secret #>"
// apply the token, to identify THIS device
let currentDevice = UIDevice()
// -- optional config --
// set some 'useful' hardware information params
clientDevice.operatingSystem = currentDevice.systemName
clientDevice.osVersion = currentDevice.systemVersion
clientDevice.deviceType = currentDevice.model
},
success: {
print("UnifiedPush Server registration succeeded")
},
failure: { (error: Error!) in
print("failed to register, error: \(error.localizedDescription)")
}
)
```
### Push registration (plist)
```swift
// setup registration
let registration = DeviceRegistration(config: "pushconfig")
// attempt to register
registration.register(
clientInfo: { (clientDevice: ClientDeviceInformation!) in
// setup configuration
clientDevice.deviceToken = deviceToken
// apply the token, to identify THIS device
let currentDevice = UIDevice()
// set some 'useful' hardware information params
clientDevice.operatingSystem = currentDevice.systemName
clientDevice.osVersion = currentDevice.systemVersion
clientDevice.deviceType = currentDevice.model
},
success: {
print("UnifiedPush Server registration succeeded")
},
failure: { (error: Error!) in
print("failed to register, error: \(error.localizedDescription)")
}
)
```
In your application, create a `pushconfig.plist` file, and add the following properties:
```xml
serverURL
<# URL of the running AeroGear UnifiedPush Server #>
variantID
<# Variant Id #>
variantSecret
<# Variant Secret #>
```
> NOTE: If your UPS server installation uses a `self-signed certificate`, you can find a quick solution on how to enable support on our [troubleshooting page](https://aerogear.org/docs/unifiedpush/aerogear-push-ios/troubleshooting/#_question_failure_to_connect_when_server_uses_a_self_signed_certificate), as well as links for further information on how to properly enable it on your iOS production applications.
## Documentation
For more details about that please consult [our documentation](http://aerogear.org/ios/).
## Demo apps
Take a look in our demo apps:
* [UnifiedPushHelloWorld](https://github.com/aerogear/aerogear-ios-cookbook/tree/master/UnifiedPushHelloWorld)
* [Howdy](https://github.com/aerogear/aerogear-ios-cookbook/tree/master/Howdy)
## Development
If you would like to help develop AeroGear you can join our [developer's mailing list](https://lists.jboss.org/mailman/listinfo/aerogear-dev), join #aerogear on Freenode, or shout at us on Twitter @aerogears.
Also takes some time and skim the [contributor guide](http://aerogear.org/docs/guides/Contributing/)
## Questions?
Join our [user mailing list](https://lists.jboss.org/mailman/listinfo/aerogear-users) for any questions or help! We really hope you enjoy app development with AeroGear!
## Found a bug?
If you found a bug please create a ticket for us on [Jira](https://issues.jboss.org/browse/AGIOS) with some steps to reproduce it.