ppg_core

Description:

ppg core

ppg_core - PushPushGo Core SDK for Flutter #



Packages are published on pub.dev with same version as github releases tags
Supported platforms: #

iOS
Android

Requirements: #
Access to Apple Developer Account.
Access to HMS/FCM Developer Account.
Product Info #
PushPushGo Core* is a building block for push notifications:

sender for push notifications - we handle batch requests, aggregate feedback events and inform your webhook
images storage & traffic - we handle, crop and serve your push images
fast implementation - we cover ios, iOS, Web with push notifications support
you own your database and credentials - no vendor lock-in - we provide infrastructure, sdk & support
simple API - we provide one API for all providers

Contact: [email protected] or Discord
PushPushGo Core is not the same as PushPushGo product - if you are looking for PushPushGo - Push Notifications Management Platform
How it works #
IMAGE HERE
When you send request to our API to send message, we prepare images and then connect to different providers.
When message is delieverd to the device and interacts with user, we collect events and pass them to our API.
After a short time you will recieve package with events on your webhook:
{
"messages": [
{
"messageId": "8e3075f1-6b21-425a-bb4f-eeaf0eac93a2",
"foreignId": "my_id",
"result": {
"kind": "sent"
},
"ts": 1685009020243
},
{
"messageId": "8e3075f1-6b21-425a-bb4f-eeaf0eac93a2",
"foreignId": "my_id",
"result": {
"kind": "delivered"
},
"ts": 1685009020564
}
]
}
copied to clipboard
Using that data you can calculate statistics or do some of your business logic.
Environment setup #
Make sure that you have flutter installed, and flutter doctor command pass.
$ flutter doctor
copied to clipboard
If pass without any exceptions you are ready to go through next steps
1. Add SDK to your existing application #
1.1 Install flutter package #
$ flutter pub add ppg_core
copied to clipboard
1.2 Add code to your main.dart file #
1.2.1 Import library #
import 'package:ppg_core/ppg_core.dart';
copied to clipboard
1.2.1 Initialize client and run #
final _ppgCorePlugin = PpgCore();

@override
void initState() {
super.initState();
initializePpgCore();
}

// Platform messages are asynchronous, so we initialize in an async method.
Future<void> initializePpgCore() async {
// TBD Logic
_ppgCorePlugin.initialize(onToken: (tokenJSON) {
// Upload this token to your server backend - you need this to use our API to send push notifications to this user
// This is a JSON formatted string contains all necessery informations to our backend.
log(tokenJSON);
});

if (!mounted) return;

_ppgCorePlugin.registerForNotifications();
}
copied to clipboard
2. iOS Support #
2.1 Specify platform in your podfile in ios/ directory #
platform :ios, '14.0'
copied to clipboard
2.2 Open XCode with ios/ directory #
$ xed ios/
copied to clipboard
2.2.1 Enable Push Notification Capabilities in Project Target #

Select your root item in files tree called "your_project_name" with blue icon and select your_project_name in Target section.
Go to Signing & Capabilities tab and click on "+ Capability" under tabs.
Select Push Notifications and Background Modes
On Background Modes select items:


Remote notifications
Background fetch

2.2.2 Add NotificationServiceExtension #

Go to file -> New -> Target
Search for Notification Service Extension and choose product name may be for example NSE
Finish process and on prompt about Activate “NSE” scheme? click Cancel
Open file NotificationService.swift
Paste this code:

import UserNotifications
import PpgCoreSDK

class NotificationService: PpgCoreNotificationServiceExtension {

}
copied to clipboard

Add to previously used name NSE target to Podfile:

target 'NSE' do
use_frameworks!
use_modular_headers!
pod 'PpgCoreSDK', '~> 0.0.11'
end
copied to clipboard

In Info.plist add folowing to enable deep linking in flutter

<key>FlutterDeepLinkingEnabled</key>
<true/>
copied to clipboard
2.3 Try to run app and fetch Push Notifications token in debug console #
$ flutter run
copied to clipboard
2.4 (Optional) If you want to override endpoint , or create new notification channels please create PpgCore.plist file with content #
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>PpgCoreSDKEndpoint</key>
<string>https://api-core.pushpushgo.com/v1</string>
<key>PpgCoreChannels</key>
<array>
<dict>
<key>name</key>
<string>testing_channel</string>
<key>sound</key>
<string>Submarine.aiff</string>
<key>actions</key>
<array>
<string>Reply</string>
</array>
</dict>
<dict>
<key>name</key>
<string>testing_channel_nowy</string>
<key>sound</key>
<string>sub.caf</string>
<key>actions</key>
<array>
<string>Open</string>
<string>Show more</string>
</array>
</dict>
</array>
</dict>
</plist>
copied to clipboard
3. Android Support #
3.1 Add to your root build.gradle jitpack if you don't have already #
// build.gradle (root) or settings.gradle (dependencyResolutionManagement)
allprojects {
repositories {
// jitpack
maven { url 'https://jitpack.io' }
// only when use hms
maven { url 'https://developer.huawei.com/repo/' }
}
}
copied to clipboard
3.1.1 Add classpath dependencies in root build.gradle file: #
If you have already configured fcm - omit this step
3.1.1.1 For FCM:
classpath 'com.google.gms:google-services:4.3.15'
copied to clipboard
3.1.1.2 For HMS:
classpath 'com.huawei.agconnect:agcp:1.6.0.300'
copied to clipboard
3.2 Place your google-services.json file in android/app directory #
3.3 Add to android/app/src/main/res/values/ file names ppgcore.xml with content #
<?xml version="1.0" encoding="utf-8"?>
<resources>
<!-- Required fields -->
<string name="default_fcm_project_id">Get_value_from_google-services.json</string>
<string name="default_hms_app_id">Get_value_from_hms_developer_account</string>
<!-- Choose HMS or FCM - remove other one depends what platform you are use -->
<drawable name="default_notification_icon">@drawable/ic_launcher_foreground</drawable>
<!-- Optional fields -->
<string name="default_channel_id">ppg_core_default</string>
<string name="default_channel_name">PPG Core Default Channel</string>
<bool name="default_channel_badge_enabled">true</bool>
<bool name="default_channel_vibration_enabled">true</bool>
<string-array name="default_vibration_pattern">0, 1000, 500, 1500, 1000</string-array>
<bool name="default_channel_lights_enabled">true</bool>
<color name="default_lights_color">#ff00ff</color>
<string name="default_channel_sound">magic_tone</string>
</resources>
copied to clipboard
3.4 Add to your AndroidManifest.xml #
This file is placed in android/app/src/main/
3.4.1 Permissions (on root level) #
<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
<!-- If you want to support vibration -->
<uses-permission android:name="android.permission.VIBRATE"/>
copied to clipboard
3.4.2 Service (on application level) #
Depends what provider you want to use please choose one of available options
3.4.2.1 For FCM
<service
android:name=".FirebaseMessagingService"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
copied to clipboard
and create file called FirebaseMessagingService with content:
import com.pushpushgo.core_sdk.sdk.fcm.FcmMessagingService

class FirebaseMessagingService : FcmMessagingService() {}

copied to clipboard
3.4.2.2 For HMS
<service
android:name=".service.MyHmsMessagingService"
android:exported="false">
<intent-filter>
<action android:name="com.huawei.push.action.MESSAGING_EVENT" />
</intent-filter>
</service>
copied to clipboard
and create file called MyHmsMessagingService with content:

import com.pushpushgo.core_sdk.sdk.hms.HmsMessagingService

class MyHmsMessagingService : HmsMessagingService() {}
copied to clipboard
3.4.3 Activities (on main activity level) #
<meta-data android:name="flutter_deeplinking_enabled" android:value="true" />

<intent-filter android:autoVerify="true">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE"/>
<data android:host="com.example.packagename"
android:scheme="app" />
<data android:scheme="https" />
<data android:scheme="http" />
</intent-filter>

<intent-filter>
<action android:name="PUSH_CLICK" />
</intent-filter>
copied to clipboard
3.4 Modify build.gradle and local.properties: #
3.4.1 Add to android/app/local.properties: #
flutter.minSdkVersion=21
copied to clipboard
3.4.2 Add to android/app/build.gradle: #
def flutterMinSdkVersion = localProperties.getProperty('flutter.minSdkVersion')
if (flutterMinSdkVersion == null) {
flutterMinSdkVersion = 21
}
copied to clipboard
3.4.3 Modify default config #
Add minSdkVersion in defaultConfig for android:
defaultConfig {
minSdkVersion flutterMinSdkVersion
}
copied to clipboard
3.4.5 Add dependencies (app level) and apply plugin #
3.4.5.1 For FCM
// build.gradle (:app)
dependencies {
...
implementation "com.github.ppgco:ppg-core-android-sdk:0.0.33"
implementation 'com.google.firebase:firebase-messaging-ktx:23.1.2'
implementation platform('com.google.firebase:firebase-bom:31.2.3')
}
copied to clipboard
On top add apply plugin
apply plugin: 'com.google.gms.google-services'
copied to clipboard
3.4.5.2 For HMS
dependencies {
...
implementation 'com.github.ppgco:ppg-core-android-sdk:0.0.33'
implementation 'com.huawei.agconnect:agconnect-core:1.7.2.300'
implementation 'com.huawei.hms:push:6.7.0.300'
}
copied to clipboard
On top add apply plugin
Paste this below com.android.library
apply plugin: 'com.huawei.agconnect'
copied to clipboard
3.4 Try to run app and fetch Push Notifications token in debug console #
$ flutter run
copied to clipboard
Sending notifications #
1. iOS #
1.1. Prepare certificates #

Go to Apple Developer Portal - Identities and go to Identifiers section
Select from list your appBundleId like com.example.your_project_name
Look for PushNotifications and click "Configure" button
Select your Certificate Singing Request file
Download Certificates and open in KeyChain Access (double click in macos)
Find this certificate in list select then in context menu (right click) select export and export to .p12 format file with password.

2. Prepare configuration #

Wrap exported certficates with Base64 with command

$ cat Certificate.p12 | base64
copied to clipboard

Prepare JSON with provider configuration

{
"type": "apns_cert",
"payload": {
"p12": "encoded base64 Certficiate.p12",
"passphrase": "PASSWORD",
"production": false,
"appBundleId": "com.example.your_product_name",
}
copied to clipboard
2. Android #

Go to Firebase Developer Console
Select your project and go to Settings
On Service Accounts section click Generate Credentials
Prepare JSON with provider configuration

{
"type": "fcm_v1",
"payload": {
// Content of service account file
}
}
copied to clipboard
3. Go to example SenderSDK docs #
In examples please use prepared "providerConfig" and token returned from SDK to send notifications.
Support & production run #
All API Keys available in this documentation allows you to test service with very low rate-limits.
If you need production credentials or just help with integration please visit us in discord or just mail to [email protected]

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter