Setup

Intallation

  1. Add the required Capacitor plugin

    npm install cleverpush-capacitor-sdk
npx cap sync

Setup Android

  1. Add Firebase to your Android project. official docs

  2. Get your FCM Sender ID & FCM Server API Key.

  3. Login/Register on CleverPush

  4. Your CleverPush Channel ID, available in Channels > App Push > Implementation > Channel ID in the CleverPush Developer console.

  5. Go to your capacitor project and enter the following commands into the terminal.

      npx cap add android
  npx run build
  npx cap sync

  6. Go to your capacitor project's Android folder and Add the dependency to your app-level app/build.gradle file. You can find the newest sdk version number here Android SDK.

      dependencies {
      // ...
      implementation 'com.cleverpush:cleverpush:1.27.6'
  }

Setup iOS

  1. Go to your capacitor project and enter the following commands into the terminal.

      npx cap add iOS
  npx run build
  npx cap sync

  2. Go to your capacitor project's iOS folder and add CleverPush to your Podfile:

    pod 'CleverPush'

  1. Open iOS Project, Select Pods, Select Capacitor Pod, Go to Genenral tab, Add CleverPush.xcframework into the Framework and libraries

  2. Enable the required capabilities

    1. Go to your root project and switch to the tab "Capabilities"

    2. Enable "Push Notifications"

    3. Enable "Background Modes" and check "Remote notifications"

  3. Add Notification Service Extension

    This is required for correctly tracking notification deliveries and for displaying big images or videos in notifications.

    1. Select File > New > Target in Xcode
    2. Choose Notification Service Extension and press Next
    3. Enter CleverPushNotificationServiceExtension as Product Name, choose Objective-C as language and press Finish
    4. Press Activate on the next prompt
    5. Add the following at the bottom of your Podfile
    target 'CleverPushNotificationServiceExtension' do

  pod 'CleverPush'

end
    1. Run pod install
    2. Open NotificationService.m and replace the whole content with the following:
    #import <CleverPush/CleverPush.h>

#import "NotificationService.h"

@interface NotificationService ()

@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;

@end

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.receivedRequest = request;
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];

    [CleverPush didReceiveNotificationExtensionRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];

    self.contentHandler(self.bestAttemptContent);
}

- (void)serviceExtensionTimeWillExpire {
    [CleverPush serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];

    self.contentHandler(self.bestAttemptContent);
}

@end

  4. Create your iOS push certificate

    1. Open Keychain Access on your Mac. (Application > Utilities > Keychain Access).
    2. Select Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority...
    3. Select the "Save to disk" option and enter any information in the required fields
    4. Go to the Apple developer portal, select your app and press "Edit"
    5. Enable "Push notifications" and press "Done"
    6. Go to the Create new certificate page, select "Apple Push Notification service SSL" and press "Continue"
    7. Select your Application Bundle ID and press "Continue"
    8. Press "Choose File...", select the previously generated "certSigningRequest" file and then press "Generate"
    9. Press "Download" and save your certificate
    10. Click on the downloaded .cer file, Keychain Access should open
    11. Select Login > My Certificates then right click on your key and click "Export (Apple Production iOS Push Services: com.your.bundle)..."
    12. Give the file a unique name and press save, be sure to leave the password field blank!
    13. Upload your certificate in the CleverPush channel settings
← ChangelogMethods →